com.google.cloud.bigqueryconnection.v1.ConnectionServiceClient Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigqueryconnection.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.resourcenames.ResourceName;
import com.google.cloud.bigquery.connection.v1.Connection;
import com.google.cloud.bigquery.connection.v1.ConnectionName;
import com.google.cloud.bigquery.connection.v1.CreateConnectionRequest;
import com.google.cloud.bigquery.connection.v1.DeleteConnectionRequest;
import com.google.cloud.bigquery.connection.v1.GetConnectionRequest;
import com.google.cloud.bigquery.connection.v1.ListConnectionsRequest;
import com.google.cloud.bigquery.connection.v1.ListConnectionsResponse;
import com.google.cloud.bigquery.connection.v1.LocationName;
import com.google.cloud.bigquery.connection.v1.UpdateConnectionRequest;
import com.google.cloud.bigqueryconnection.v1.stub.ConnectionServiceStub;
import com.google.cloud.bigqueryconnection.v1.stub.ConnectionServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.GetPolicyOptions;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Manages external data source connections and credentials.
*
* 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:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Connection connection = Connection.newBuilder().build();
* String connectionId = "connectionId1923106969";
* Connection response =
* connectionServiceClient.createConnection(parent, connection, connectionId);
* }
* }
*
* Note: close() needs to be called on the ConnectionServiceClient 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
*
*
* CreateConnection
Creates a new connection.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createConnection(CreateConnectionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createConnection(LocationName parent, Connection connection, String connectionId)
*
createConnection(String parent, Connection connection, String connectionId)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createConnectionCallable()
*
*
*
*
* GetConnection
Returns specified connection.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getConnection(GetConnectionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getConnection(ConnectionName name)
*
getConnection(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.
*
* getConnectionCallable()
*
*
*
*
* ListConnections
Returns a list of connections in the given project.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listConnections(ListConnectionsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listConnections(LocationName parent)
*
listConnections(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.
*
* listConnectionsPagedCallable()
*
listConnectionsCallable()
*
*
*
*
* UpdateConnection
Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateConnection(UpdateConnectionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateConnection(ConnectionName name, Connection connection, FieldMask updateMask)
*
updateConnection(String name, Connection connection, 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.
*
* updateConnectionCallable()
*
*
*
*
* DeleteConnection
Deletes connection and associated credential.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteConnection(DeleteConnectionRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteConnection(ConnectionName name)
*
deleteConnection(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.
*
* deleteConnectionCallable()
*
*
*
*
* GetIamPolicy
Gets the access control policy for a resource. Returns an empty policy if 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)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getIamPolicy(ResourceName resource, GetPolicyOptions options)
*
getIamPolicy(String resource, GetPolicyOptions options)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getIamPolicyCallable()
*
*
*
*
* SetIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
*
Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* setIamPolicy(SetIamPolicyRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* setIamPolicy(ResourceName resource, Policy policy)
*
setIamPolicy(String resource, Policy policy)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* setIamPolicyCallable()
*
*
*
*
* TestIamPermissions
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
*
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. 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)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* testIamPermissions(ResourceName resource, List<String> permissions)
*
testIamPermissions(String resource, List<String> permissions)
*
* 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 ConnectionServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@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
* ConnectionServiceSettings connectionServiceSettings =
* ConnectionServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ConnectionServiceClient connectionServiceClient =
* ConnectionServiceClient.create(connectionServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* ConnectionServiceSettings connectionServiceSettings =
* ConnectionServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* ConnectionServiceClient connectionServiceClient =
* ConnectionServiceClient.create(connectionServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* ConnectionServiceSettings connectionServiceSettings =
* ConnectionServiceSettings.newHttpJsonBuilder().build();
* ConnectionServiceClient connectionServiceClient =
* ConnectionServiceClient.create(connectionServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class ConnectionServiceClient implements BackgroundResource {
private final ConnectionServiceSettings settings;
private final ConnectionServiceStub stub;
/** Constructs an instance of ConnectionServiceClient with default settings. */
public static final ConnectionServiceClient create() throws IOException {
return create(ConnectionServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of ConnectionServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final ConnectionServiceClient create(ConnectionServiceSettings settings)
throws IOException {
return new ConnectionServiceClient(settings);
}
/**
* Constructs an instance of ConnectionServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(ConnectionServiceSettings).
*/
public static final ConnectionServiceClient create(ConnectionServiceStub stub) {
return new ConnectionServiceClient(stub);
}
/**
* Constructs an instance of ConnectionServiceClient, 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.
*/
protected ConnectionServiceClient(ConnectionServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((ConnectionServiceStubSettings) settings.getStubSettings()).createStub();
}
protected ConnectionServiceClient(ConnectionServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final ConnectionServiceSettings getSettings() {
return settings;
}
public ConnectionServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new connection.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Connection connection = Connection.newBuilder().build();
* String connectionId = "connectionId1923106969";
* Connection response =
* connectionServiceClient.createConnection(parent, connection, connectionId);
* }
* }
*
* @param parent Required. Parent resource name. Must be in the format
* `projects/{project_id}/locations/{location_id}`
* @param connection Required. Connection to create.
* @param connectionId Optional. Connection id that should be assigned to the created connection.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection createConnection(
LocationName parent, Connection connection, String connectionId) {
CreateConnectionRequest request =
CreateConnectionRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setConnection(connection)
.setConnectionId(connectionId)
.build();
return createConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* Connection connection = Connection.newBuilder().build();
* String connectionId = "connectionId1923106969";
* Connection response =
* connectionServiceClient.createConnection(parent, connection, connectionId);
* }
* }
*
* @param parent Required. Parent resource name. Must be in the format
* `projects/{project_id}/locations/{location_id}`
* @param connection Required. Connection to create.
* @param connectionId Optional. Connection id that should be assigned to the created connection.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection createConnection(
String parent, Connection connection, String connectionId) {
CreateConnectionRequest request =
CreateConnectionRequest.newBuilder()
.setParent(parent)
.setConnection(connection)
.setConnectionId(connectionId)
.build();
return createConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* CreateConnectionRequest request =
* CreateConnectionRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setConnectionId("connectionId1923106969")
* .setConnection(Connection.newBuilder().build())
* .build();
* Connection response = connectionServiceClient.createConnection(request);
* }
* }
*
* @param 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
*/
public final Connection createConnection(CreateConnectionRequest request) {
return createConnectionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* CreateConnectionRequest request =
* CreateConnectionRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setConnectionId("connectionId1923106969")
* .setConnection(Connection.newBuilder().build())
* .build();
* ApiFuture future =
* connectionServiceClient.createConnectionCallable().futureCall(request);
* // Do something.
* Connection response = future.get();
* }
* }
*/
public final UnaryCallable createConnectionCallable() {
return stub.createConnectionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns specified connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ConnectionName name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* Connection response = connectionServiceClient.getConnection(name);
* }
* }
*
* @param name Required. Name of the requested connection, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection getConnection(ConnectionName name) {
GetConnectionRequest request =
GetConnectionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns specified connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* Connection response = connectionServiceClient.getConnection(name);
* }
* }
*
* @param name Required. Name of the requested connection, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection getConnection(String name) {
GetConnectionRequest request = GetConnectionRequest.newBuilder().setName(name).build();
return getConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns specified connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* GetConnectionRequest request =
* GetConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .build();
* Connection response = connectionServiceClient.getConnection(request);
* }
* }
*
* @param 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
*/
public final Connection getConnection(GetConnectionRequest request) {
return getConnectionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns specified connection.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* GetConnectionRequest request =
* GetConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .build();
* ApiFuture future =
* connectionServiceClient.getConnectionCallable().futureCall(request);
* // Do something.
* Connection response = future.get();
* }
* }
*/
public final UnaryCallable getConnectionCallable() {
return stub.getConnectionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of connections in the given project.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (Connection element : connectionServiceClient.listConnections(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Parent resource name. Must be in the form:
* `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListConnectionsPagedResponse listConnections(LocationName parent) {
ListConnectionsRequest request =
ListConnectionsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listConnections(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of connections in the given project.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* for (Connection element : connectionServiceClient.listConnections(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Parent resource name. Must be in the form:
* `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListConnectionsPagedResponse listConnections(String parent) {
ListConnectionsRequest request = ListConnectionsRequest.newBuilder().setParent(parent).build();
return listConnections(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of connections in the given project.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ListConnectionsRequest request =
* ListConnectionsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Connection element : connectionServiceClient.listConnections(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListConnectionsPagedResponse listConnections(ListConnectionsRequest request) {
return listConnectionsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of connections in the given project.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ListConnectionsRequest request =
* ListConnectionsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* connectionServiceClient.listConnectionsPagedCallable().futureCall(request);
* // Do something.
* for (Connection element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listConnectionsPagedCallable() {
return stub.listConnectionsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns a list of connections in the given project.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ListConnectionsRequest request =
* ListConnectionsRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListConnectionsResponse response =
* connectionServiceClient.listConnectionsCallable().call(request);
* for (Connection element : response.getConnectionsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listConnectionsCallable() {
return stub.listConnectionsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified connection. For security reasons, also resets credential if connection
* properties are in the update field mask.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ConnectionName name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* Connection connection = Connection.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Connection response = connectionServiceClient.updateConnection(name, connection, updateMask);
* }
* }
*
* @param name Required. Name of the connection to update, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @param connection Required. Connection containing the updated fields.
* @param updateMask Required. Update mask for the connection fields to be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection updateConnection(
ConnectionName name, Connection connection, FieldMask updateMask) {
UpdateConnectionRequest request =
UpdateConnectionRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setConnection(connection)
.setUpdateMask(updateMask)
.build();
return updateConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified connection. For security reasons, also resets credential if connection
* properties are in the update field mask.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* Connection connection = Connection.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* Connection response = connectionServiceClient.updateConnection(name, connection, updateMask);
* }
* }
*
* @param name Required. Name of the connection to update, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @param connection Required. Connection containing the updated fields.
* @param updateMask Required. Update mask for the connection fields to be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Connection updateConnection(
String name, Connection connection, FieldMask updateMask) {
UpdateConnectionRequest request =
UpdateConnectionRequest.newBuilder()
.setName(name)
.setConnection(connection)
.setUpdateMask(updateMask)
.build();
return updateConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified connection. For security reasons, also resets credential if connection
* properties are in the update field mask.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* UpdateConnectionRequest request =
* UpdateConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setConnection(Connection.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Connection response = connectionServiceClient.updateConnection(request);
* }
* }
*
* @param 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
*/
public final Connection updateConnection(UpdateConnectionRequest request) {
return updateConnectionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates the specified connection. For security reasons, also resets credential if connection
* properties are in the update field mask.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* UpdateConnectionRequest request =
* UpdateConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setConnection(Connection.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future =
* connectionServiceClient.updateConnectionCallable().futureCall(request);
* // Do something.
* Connection response = future.get();
* }
* }
*/
public final UnaryCallable updateConnectionCallable() {
return stub.updateConnectionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes connection and associated credential.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ConnectionName name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* connectionServiceClient.deleteConnection(name);
* }
* }
*
* @param name Required. Name of the deleted connection, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteConnection(ConnectionName name) {
DeleteConnectionRequest request =
DeleteConnectionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
deleteConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes connection and associated credential.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String name = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* connectionServiceClient.deleteConnection(name);
* }
* }
*
* @param name Required. Name of the deleted connection, for example:
* `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteConnection(String name) {
DeleteConnectionRequest request = DeleteConnectionRequest.newBuilder().setName(name).build();
deleteConnection(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes connection and associated credential.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* DeleteConnectionRequest request =
* DeleteConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .build();
* connectionServiceClient.deleteConnection(request);
* }
* }
*
* @param 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
*/
public final void deleteConnection(DeleteConnectionRequest request) {
deleteConnectionCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes connection and associated credential.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* DeleteConnectionRequest request =
* DeleteConnectionRequest.newBuilder()
* .setName(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .build();
* ApiFuture future =
* connectionServiceClient.deleteConnectionCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteConnectionCallable() {
return stub.deleteConnectionCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ResourceName resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* GetPolicyOptions options = GetPolicyOptions.newBuilder().build();
* Policy response = connectionServiceClient.getIamPolicy(resource, options);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @param options OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(ResourceName resource, GetPolicyOptions options) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setOptions(options)
.build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* GetPolicyOptions options = GetPolicyOptions.newBuilder().build();
* Policy response = connectionServiceClient.getIamPolicy(resource, options);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being requested. See the
* operation documentation for the appropriate value for this field.
* @param options OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(String resource, GetPolicyOptions options) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder().setResource(resource).setOptions(options).build();
return getIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = connectionServiceClient.getIamPolicy(request);
* }
* }
*
* @param 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
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policy if the resource exists
* and does not have a policy set.
*
* Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture future = connectionServiceClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ResourceName resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* Policy policy = Policy.newBuilder().build();
* Policy response = connectionServiceClient.setIamPolicy(resource, policy);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(ResourceName resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.setPolicy(policy)
.build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* Policy policy = Policy.newBuilder().build();
* Policy response = connectionServiceClient.setIamPolicy(resource, policy);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy is being specified. See the
* operation documentation for the appropriate value for this field.
* @param policy REQUIRED: The complete policy to be applied to the `resource`. The size of the
* policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud
* Platform services (such as Projects) might reject them.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(String resource, Policy policy) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder().setResource(resource).setPolicy(policy).build();
return setIamPolicy(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Policy response = connectionServiceClient.setIamPolicy(request);
* }
* }
*
* @param 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
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replaces any existing policy.
*
* Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture future = connectionServiceClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }
*/
public final UnaryCallable setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for building permission-aware UIs and
* command-line tools, not for authorization checking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* ResourceName resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]");
* List permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* connectionServiceClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
ResourceName resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource == null ? null : resource.toString())
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for building permission-aware UIs and
* command-line tools, not for authorization checking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* String resource = ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString();
* List permissions = new ArrayList<>();
* TestIamPermissionsResponse response =
* connectionServiceClient.testIamPermissions(resource, permissions);
* }
* }
*
* @param resource REQUIRED: The resource for which the policy detail is being requested. See the
* operation documentation for the appropriate value for this field.
* @param permissions The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(
String resource, List permissions) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(resource)
.addAllPermissions(permissions)
.build();
return testIamPermissions(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for building permission-aware UIs and
* command-line tools, not for authorization checking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .addAllPermissions(new ArrayList())
* .build();
* TestIamPermissionsResponse response = connectionServiceClient.testIamPermissions(request);
* }
* }
*
* @param 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
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified resource. If the resource does not
* exist, this will return an empty set of permissions, not a `NOT_FOUND` error.
*
* Note: This operation is designed to be used for building permission-aware UIs and
* command-line tools, not for authorization checking. This operation may "fail open" without
* warning.
*
*
Sample code:
*
*
{@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 (ConnectionServiceClient connectionServiceClient = ConnectionServiceClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(ConnectionName.of("[PROJECT]", "[LOCATION]", "[CONNECTION]").toString())
* .addAllPermissions(new ArrayList())
* .build();
* ApiFuture future =
* connectionServiceClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListConnectionsPagedResponse
extends AbstractPagedListResponse<
ListConnectionsRequest,
ListConnectionsResponse,
Connection,
ListConnectionsPage,
ListConnectionsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListConnectionsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListConnectionsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListConnectionsPagedResponse(ListConnectionsPage page) {
super(page, ListConnectionsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListConnectionsPage
extends AbstractPage<
ListConnectionsRequest, ListConnectionsResponse, Connection, ListConnectionsPage> {
private ListConnectionsPage(
PageContext context,
ListConnectionsResponse response) {
super(context, response);
}
private static ListConnectionsPage createEmptyPage() {
return new ListConnectionsPage(null, null);
}
@Override
protected ListConnectionsPage createPage(
PageContext context,
ListConnectionsResponse response) {
return new ListConnectionsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListConnectionsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListConnectionsRequest,
ListConnectionsResponse,
Connection,
ListConnectionsPage,
ListConnectionsFixedSizeCollection> {
private ListConnectionsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListConnectionsFixedSizeCollection createEmptyCollection() {
return new ListConnectionsFixedSizeCollection(null, 0);
}
@Override
protected ListConnectionsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListConnectionsFixedSizeCollection(pages, collectionSize);
}
}
}