Class AppConnectionsServiceClient
- java.lang.Object
-
- com.google.cloud.beyondcorp.appconnections.v1.AppConnectionsServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class AppConnectionsServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AppConnectionsServiceClient.ListAppConnectionsFixedSizeCollection
static class
AppConnectionsServiceClient.ListAppConnectionsPage
static class
AppConnectionsServiceClient.ListAppConnectionsPagedResponse
static class
AppConnectionsServiceClient.ListLocationsFixedSizeCollection
static class
AppConnectionsServiceClient.ListLocationsPage
static class
AppConnectionsServiceClient.ListLocationsPagedResponse
static class
AppConnectionsServiceClient.ResolveAppConnectionsFixedSizeCollection
static class
AppConnectionsServiceClient.ResolveAppConnectionsPage
static class
AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
AppConnectionsServiceClient(AppConnectionsServiceSettings settings)
Constructs an instance of AppConnectionsServiceClient, using the given settings.protected
AppConnectionsServiceClient(AppConnectionsServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static AppConnectionsServiceClient
create()
Constructs an instance of AppConnectionsServiceClient with default settings.static AppConnectionsServiceClient
create(AppConnectionsServiceSettings settings)
Constructs an instance of AppConnectionsServiceClient, using the given settings.static AppConnectionsServiceClient
create(AppConnectionsServiceStub stub)
Constructs an instance of AppConnectionsServiceClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata>
createAppConnectionAsync(CreateAppConnectionRequest request)
Creates a new AppConnection in a given project and location.com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata>
createAppConnectionAsync(LocationName parent, AppConnection appConnection, String appConnectionId)
Creates a new AppConnection in a given project and location.com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata>
createAppConnectionAsync(String parent, AppConnection appConnection, String appConnectionId)
Creates a new AppConnection in a given project and location.com.google.api.gax.rpc.UnaryCallable<CreateAppConnectionRequest,com.google.longrunning.Operation>
createAppConnectionCallable()
Creates a new AppConnection in a given project and location.com.google.api.gax.rpc.OperationCallable<CreateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata>
createAppConnectionOperationCallable()
Creates a new AppConnection in a given project and location.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,AppConnectionOperationMetadata>
deleteAppConnectionAsync(AppConnectionName name)
Deletes a single AppConnection.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,AppConnectionOperationMetadata>
deleteAppConnectionAsync(DeleteAppConnectionRequest request)
Deletes a single AppConnection.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,AppConnectionOperationMetadata>
deleteAppConnectionAsync(String name)
Deletes a single AppConnection.com.google.api.gax.rpc.UnaryCallable<DeleteAppConnectionRequest,com.google.longrunning.Operation>
deleteAppConnectionCallable()
Deletes a single AppConnection.com.google.api.gax.rpc.OperationCallable<DeleteAppConnectionRequest,com.google.protobuf.Empty,AppConnectionOperationMetadata>
deleteAppConnectionOperationCallable()
Deletes a single AppConnection.AppConnection
getAppConnection(AppConnectionName name)
Gets details of a single AppConnection.AppConnection
getAppConnection(GetAppConnectionRequest request)
Gets details of a single AppConnection.AppConnection
getAppConnection(String name)
Gets details of a single AppConnection.com.google.api.gax.rpc.UnaryCallable<GetAppConnectionRequest,AppConnection>
getAppConnectionCallable()
Gets details of a single AppConnection.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.com.google.cloud.location.Location
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationCallable()
Gets information about a location.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.AppConnectionsServiceSettings
getSettings()
AppConnectionsServiceStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
AppConnectionsServiceClient.ListAppConnectionsPagedResponse
listAppConnections(ListAppConnectionsRequest request)
Lists AppConnections in a given project and location.AppConnectionsServiceClient.ListAppConnectionsPagedResponse
listAppConnections(LocationName parent)
Lists AppConnections in a given project and location.AppConnectionsServiceClient.ListAppConnectionsPagedResponse
listAppConnections(String parent)
Lists AppConnections in a given project and location.com.google.api.gax.rpc.UnaryCallable<ListAppConnectionsRequest,ListAppConnectionsResponse>
listAppConnectionsCallable()
Lists AppConnections in a given project and location.com.google.api.gax.rpc.UnaryCallable<ListAppConnectionsRequest,AppConnectionsServiceClient.ListAppConnectionsPagedResponse>
listAppConnectionsPagedCallable()
Lists AppConnections in a given project and location.AppConnectionsServiceClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,AppConnectionsServiceClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse
resolveAppConnections(LocationName parent)
Resolves AppConnections details for a given AppConnector.AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse
resolveAppConnections(ResolveAppConnectionsRequest request)
Resolves AppConnections details for a given AppConnector.AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse
resolveAppConnections(String parent)
Resolves AppConnections details for a given AppConnector.com.google.api.gax.rpc.UnaryCallable<ResolveAppConnectionsRequest,ResolveAppConnectionsResponse>
resolveAppConnectionsCallable()
Resolves AppConnections details for a given AppConnector.com.google.api.gax.rpc.UnaryCallable<ResolveAppConnectionsRequest,AppConnectionsServiceClient.ResolveAppConnectionsPagedResponse>
resolveAppConnectionsPagedCallable()
Resolves AppConnections details for a given AppConnector.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata>
updateAppConnectionAsync(AppConnection appConnection, com.google.protobuf.FieldMask updateMask)
Updates the parameters of a single AppConnection.com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata>
updateAppConnectionAsync(UpdateAppConnectionRequest request)
Updates the parameters of a single AppConnection.com.google.api.gax.rpc.UnaryCallable<UpdateAppConnectionRequest,com.google.longrunning.Operation>
updateAppConnectionCallable()
Updates the parameters of a single AppConnection.com.google.api.gax.rpc.OperationCallable<UpdateAppConnectionRequest,AppConnection,AppConnectionOperationMetadata>
updateAppConnectionOperationCallable()
Updates the parameters of a single AppConnection.
-
-
-
Constructor Detail
-
AppConnectionsServiceClient
protected AppConnectionsServiceClient(AppConnectionsServiceSettings settings) throws IOException
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.- Throws:
IOException
-
AppConnectionsServiceClient
protected AppConnectionsServiceClient(AppConnectionsServiceStub stub)
-
-
Method Detail
-
create
public static final AppConnectionsServiceClient create() throws IOException
Constructs an instance of AppConnectionsServiceClient with default settings.- Throws:
IOException
-
create
public static final AppConnectionsServiceClient create(AppConnectionsServiceSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final AppConnectionsServiceSettings getSettings()
-
getStub
public AppConnectionsServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listAppConnections
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); } }
- Parameters:
parent
- Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAppConnections
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); } }
- Parameters:
parent
- Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAppConnections
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listAppConnectionsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listAppConnectionsCallable
public final com.google.api.gax.rpc.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; } } }
-
getAppConnection
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); }
- Parameters:
name
- Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAppConnection
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); }
- Parameters:
name
- Required. BeyondCorp AppConnection name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAppConnection
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getAppConnectionCallable
public final com.google.api.gax.rpc.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(); }
-
createAppConnectionAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`appConnection
- Required. A BeyondCorp AppConnection resource.appConnectionId
- Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/[a-z][0-9]-/`. * Must end with a number or a letter.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAppConnectionAsync
public final com.google.api.gax.longrunning.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:
parent
- Required. The resource project name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`appConnection
- Required. A BeyondCorp AppConnection resource.appConnectionId
- Optional. User-settable AppConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/[a-z][0-9]-/`. * Must end with a number or a letter.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAppConnectionAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createAppConnectionOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createAppConnectionCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateAppConnectionRequest,com.google.longrunning.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(); }
-
updateAppConnectionAsync
public final com.google.api.gax.longrunning.OperationFuture<AppConnection,AppConnectionOperationMetadata> updateAppConnectionAsync(AppConnection appConnection, com.google.protobuf.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:
appConnection
- Required. AppConnection message with updated fields. Only supported fields specified in update_mask are updated.updateMask
- 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`
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAppConnectionAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateAppConnectionOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateAppConnectionCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateAppConnectionRequest,com.google.longrunning.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(); }
-
deleteAppConnectionAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAppConnectionAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAppConnectionAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAppConnectionOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteAppConnectionRequest,com.google.protobuf.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(); }
-
deleteAppConnectionCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteAppConnectionRequest,com.google.longrunning.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(); }
-
resolveAppConnections
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); } }
- Parameters:
parent
- Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
resolveAppConnections
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); } }
- Parameters:
parent
- Required. The resource name of the AppConnection location using the form: `projects/{project_id}/locations/{location_id}`- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
resolveAppConnections
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
resolveAppConnectionsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
resolveAppConnectionsCallable
public final com.google.api.gax.rpc.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; } } }
-
listLocations
public final AppConnectionsServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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; } } }
-
getLocation
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-