Class ClientConnectorServicesServiceClient (0.1.0)

Version 0.1.0

• 0.52.0 (latest)
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.3

public class ClientConnectorServicesServiceClient implements BackgroundResource

Service Description: ## API Overview

The beyondcorp.googleapis.com service implements the Google Cloud BeyondCorp API.

## Data Model

The ClientConnectorServicesService exposes the following resources:

• Client Connector Services, named as follows: projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorServiceName name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]");
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(name);
 }
 

Note: close() needs to be called on the ClientConnectorServicesServiceClient 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:

1. 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.
2. 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.
3. 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 ClientConnectorServicesServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ClientConnectorServicesServiceSettings clientConnectorServicesServiceSettings =
     ClientConnectorServicesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create(clientConnectorServicesServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ClientConnectorServicesServiceSettings clientConnectorServicesServiceSettings =
     ClientConnectorServicesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create(clientConnectorServicesServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ClientConnectorServicesServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ClientConnectorServicesServiceClient create()

Constructs an instance of ClientConnectorServicesServiceClient with default settings.

Returns

Type	Description
ClientConnectorServicesServiceClient

Exceptions

Type	Description
IOException

create(ClientConnectorServicesServiceSettings settings)

public static final ClientConnectorServicesServiceClient create(ClientConnectorServicesServiceSettings settings)

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

Parameter

Name	Description
settings	ClientConnectorServicesServiceSettings

Returns

Type	Description
ClientConnectorServicesServiceClient

Exceptions

Type	Description
IOException

create(ClientConnectorServicesServiceStub stub)

public static final ClientConnectorServicesServiceClient create(ClientConnectorServicesServiceStub stub)

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

Parameter

Name	Description
stub	ClientConnectorServicesServiceStub

Returns

Type	Description
ClientConnectorServicesServiceClient

Constructors

ClientConnectorServicesServiceClient(ClientConnectorServicesServiceSettings settings)

protected ClientConnectorServicesServiceClient(ClientConnectorServicesServiceSettings settings)

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

Parameter

Name	Description
settings	ClientConnectorServicesServiceSettings

ClientConnectorServicesServiceClient(ClientConnectorServicesServiceStub stub)

protected ClientConnectorServicesServiceClient(ClientConnectorServicesServiceStub stub)

Parameter

Name	Description
stub	ClientConnectorServicesServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createClientConnectorServiceAsync(CreateClientConnectorServiceRequest request)

public final OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata> createClientConnectorServiceAsync(CreateClientConnectorServiceRequest request)

Creates a new ClientConnectorService in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   CreateClientConnectorServiceRequest request =
       CreateClientConnectorServiceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientConnectorServiceId("clientConnectorServiceId766123022")
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ClientConnectorService response =
       clientConnectorServicesServiceClient.createClientConnectorServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateClientConnectorServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata>

createClientConnectorServiceAsync(LocationName parent, ClientConnectorService clientConnectorService, String clientConnectorServiceId)

public final OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata> createClientConnectorServiceAsync(LocationName parent, ClientConnectorService clientConnectorService, String clientConnectorServiceId)

Creates a new ClientConnectorService in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ClientConnectorService clientConnectorService = ClientConnectorService.newBuilder().build();
   String clientConnectorServiceId = "clientConnectorServiceId766123022";
   ClientConnectorService response =
       clientConnectorServicesServiceClient
           .createClientConnectorServiceAsync(
               parent, clientConnectorService, clientConnectorServiceId)
           .get();
 }
 

Parameters

Name	Description
parent	LocationName Required. Value for parent.
clientConnectorService	ClientConnectorService Required. The resource being created.
clientConnectorServiceId	String Optional. User-settable client connector service resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter. A random system generated name will be assigned if not specified by the user.

Returns

Type	Description
OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata>

createClientConnectorServiceAsync(String parent, ClientConnectorService clientConnectorService, String clientConnectorServiceId)

public final OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata> createClientConnectorServiceAsync(String parent, ClientConnectorService clientConnectorService, String clientConnectorServiceId)

Creates a new ClientConnectorService in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ClientConnectorService clientConnectorService = ClientConnectorService.newBuilder().build();
   String clientConnectorServiceId = "clientConnectorServiceId766123022";
   ClientConnectorService response =
       clientConnectorServicesServiceClient
           .createClientConnectorServiceAsync(
               parent, clientConnectorService, clientConnectorServiceId)
           .get();
 }
 

Parameters

Name	Description
parent	String Required. Value for parent.
clientConnectorService	ClientConnectorService Required. The resource being created.
clientConnectorServiceId	String Optional. User-settable client connector service resource ID. * Must start with a letter. * Must contain between 4-63 characters from /a-z-/. * Must end with a number or a letter. A random system generated name will be assigned if not specified by the user.

Returns

Type	Description
OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata>

createClientConnectorServiceCallable()

public final UnaryCallable<CreateClientConnectorServiceRequest,Operation> createClientConnectorServiceCallable()

Creates a new ClientConnectorService in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   CreateClientConnectorServiceRequest request =
       CreateClientConnectorServiceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientConnectorServiceId("clientConnectorServiceId766123022")
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       clientConnectorServicesServiceClient
           .createClientConnectorServiceCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateClientConnectorServiceRequest,Operation>

createClientConnectorServiceOperationCallable()

public final OperationCallable<CreateClientConnectorServiceRequest,ClientConnectorService,ClientConnectorServiceOperationMetadata> createClientConnectorServiceOperationCallable()

Creates a new ClientConnectorService in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   CreateClientConnectorServiceRequest request =
       CreateClientConnectorServiceRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClientConnectorServiceId("clientConnectorServiceId766123022")
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<ClientConnectorService, ClientConnectorServiceOperationMetadata> future =
       clientConnectorServicesServiceClient
           .createClientConnectorServiceOperationCallable()
           .futureCall(request);
   // Do something.
   ClientConnectorService response = future.get();
 }
 

Returns

Type	Description
OperationCallable<CreateClientConnectorServiceRequest,ClientConnectorService,ClientConnectorServiceOperationMetadata>

deleteClientConnectorServiceAsync(ClientConnectorServiceName name)

public final OperationFuture<Empty,ClientConnectorServiceOperationMetadata> deleteClientConnectorServiceAsync(ClientConnectorServiceName name)

Deletes a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorServiceName name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]");
   clientConnectorServicesServiceClient.deleteClientConnectorServiceAsync(name).get();
 }
 

Parameter

Name	Description
name	ClientConnectorServiceName Required. Name of the resource.

Returns

Type	Description
OperationFuture<Empty,ClientConnectorServiceOperationMetadata>

deleteClientConnectorServiceAsync(DeleteClientConnectorServiceRequest request)

public final OperationFuture<Empty,ClientConnectorServiceOperationMetadata> deleteClientConnectorServiceAsync(DeleteClientConnectorServiceRequest request)

Deletes a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   DeleteClientConnectorServiceRequest request =
       DeleteClientConnectorServiceRequest.newBuilder()
           .setName(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   clientConnectorServicesServiceClient.deleteClientConnectorServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteClientConnectorServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,ClientConnectorServiceOperationMetadata>

deleteClientConnectorServiceAsync(String name)

public final OperationFuture<Empty,ClientConnectorServiceOperationMetadata> deleteClientConnectorServiceAsync(String name)

Deletes a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   String name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
           .toString();
   clientConnectorServicesServiceClient.deleteClientConnectorServiceAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. Name of the resource.

Returns

Type	Description
OperationFuture<Empty,ClientConnectorServiceOperationMetadata>

deleteClientConnectorServiceCallable()

public final UnaryCallable<DeleteClientConnectorServiceRequest,Operation> deleteClientConnectorServiceCallable()

Deletes a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   DeleteClientConnectorServiceRequest request =
       DeleteClientConnectorServiceRequest.newBuilder()
           .setName(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       clientConnectorServicesServiceClient
           .deleteClientConnectorServiceCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteClientConnectorServiceRequest,Operation>

deleteClientConnectorServiceOperationCallable()

public final OperationCallable<DeleteClientConnectorServiceRequest,Empty,ClientConnectorServiceOperationMetadata> deleteClientConnectorServiceOperationCallable()

Deletes a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   DeleteClientConnectorServiceRequest request =
       DeleteClientConnectorServiceRequest.newBuilder()
           .setName(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Empty, ClientConnectorServiceOperationMetadata> future =
       clientConnectorServicesServiceClient
           .deleteClientConnectorServiceOperationCallable()
           .futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteClientConnectorServiceRequest,Empty,ClientConnectorServiceOperationMetadata>

getClientConnectorService(ClientConnectorServiceName name)

public final ClientConnectorService getClientConnectorService(ClientConnectorServiceName name)

Gets details of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorServiceName name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]");
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(name);
 }
 

Parameter

Name	Description
name	ClientConnectorServiceName Required. Name of the resource.

Returns

Type	Description
ClientConnectorService

getClientConnectorService(GetClientConnectorServiceRequest request)

public final ClientConnectorService getClientConnectorService(GetClientConnectorServiceRequest request)

Gets details of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetClientConnectorServiceRequest request =
       GetClientConnectorServiceRequest.newBuilder()
           .setName(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .build();
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(request);
 }
 

Parameter

Name	Description
request	GetClientConnectorServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ClientConnectorService

getClientConnectorService(String name)

public final ClientConnectorService getClientConnectorService(String name)

Gets details of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   String name =
       ClientConnectorServiceName.of("[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
           .toString();
   ClientConnectorService response =
       clientConnectorServicesServiceClient.getClientConnectorService(name);
 }
 

Parameter

Name	Description
name	String Required. Name of the resource.

Returns

Type	Description
ClientConnectorService

getClientConnectorServiceCallable()

public final UnaryCallable<GetClientConnectorServiceRequest,ClientConnectorService> getClientConnectorServiceCallable()

Gets details of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetClientConnectorServiceRequest request =
       GetClientConnectorServiceRequest.newBuilder()
           .setName(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .build();
   ApiFuture<ClientConnectorService> future =
       clientConnectorServicesServiceClient
           .getClientConnectorServiceCallable()
           .futureCall(request);
   // Do something.
   ClientConnectorService response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetClientConnectorServiceRequest,ClientConnectorService>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = clientConnectorServicesServiceClient.getIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       clientConnectorServicesServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = clientConnectorServicesServiceClient.getLocation(request);
 }
 

Parameter

Name	Description
request	com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       clientConnectorServicesServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

getSettings()

public final ClientConnectorServicesServiceSettings getSettings()

Returns

Type	Description
ClientConnectorServicesServiceSettings

getStub()

public ClientConnectorServicesServiceStub getStub()

Returns

Type	Description
ClientConnectorServicesServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listClientConnectorServices(ListClientConnectorServicesRequest request)

public final ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse listClientConnectorServices(ListClientConnectorServicesRequest request)

Lists ClientConnectorServices in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListClientConnectorServicesRequest request =
       ListClientConnectorServicesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (ClientConnectorService element :
       clientConnectorServicesServiceClient.listClientConnectorServices(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListClientConnectorServicesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse

listClientConnectorServices(LocationName parent)

public final ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse listClientConnectorServices(LocationName parent)

Lists ClientConnectorServices in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ClientConnectorService element :
       clientConnectorServicesServiceClient.listClientConnectorServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	LocationName Required. Parent value for ListClientConnectorServicesRequest.

Returns

Type	Description
ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse

listClientConnectorServices(String parent)

public final ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse listClientConnectorServices(String parent)

Lists ClientConnectorServices in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ClientConnectorService element :
       clientConnectorServicesServiceClient.listClientConnectorServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. Parent value for ListClientConnectorServicesRequest.

Returns

Type	Description
ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse

listClientConnectorServicesCallable()

public final UnaryCallable<ListClientConnectorServicesRequest,ListClientConnectorServicesResponse> listClientConnectorServicesCallable()

Lists ClientConnectorServices in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListClientConnectorServicesRequest request =
       ListClientConnectorServicesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListClientConnectorServicesResponse response =
         clientConnectorServicesServiceClient
             .listClientConnectorServicesCallable()
             .call(request);
     for (ClientConnectorService element : response.getClientConnectorServicesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListClientConnectorServicesRequest,ListClientConnectorServicesResponse>

listClientConnectorServicesPagedCallable()

public final UnaryCallable<ListClientConnectorServicesRequest,ClientConnectorServicesServiceClient.ListClientConnectorServicesPagedResponse> listClientConnectorServicesPagedCallable()

Lists ClientConnectorServices in a given project and location.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListClientConnectorServicesRequest request =
       ListClientConnectorServicesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<ClientConnectorService> future =
       clientConnectorServicesServiceClient
           .listClientConnectorServicesPagedCallable()
           .futureCall(request);
   // Do something.
   for (ClientConnectorService element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListClientConnectorServicesRequest,ListClientConnectorServicesPagedResponse>

listLocations(ListLocationsRequest request)

public final ClientConnectorServicesServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element :
       clientConnectorServicesServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ClientConnectorServicesServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         clientConnectorServicesServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

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

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       clientConnectorServicesServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = clientConnectorServicesServiceClient.setIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       clientConnectorServicesServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response =
       clientConnectorServicesServiceClient.testIamPermissions(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

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

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               ClientConnectorServiceName.of(
                       "[PROJECT]", "[LOCATION]", "[CLIENT_CONNECTOR_SERVICE]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       clientConnectorServicesServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateClientConnectorServiceAsync(ClientConnectorService clientConnectorService, FieldMask updateMask)

public final OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata> updateClientConnectorServiceAsync(ClientConnectorService clientConnectorService, FieldMask updateMask)

Updates the parameters of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   ClientConnectorService clientConnectorService = ClientConnectorService.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ClientConnectorService response =
       clientConnectorServicesServiceClient
           .updateClientConnectorServiceAsync(clientConnectorService, updateMask)
           .get();
 }
 

Parameters

Name	Description
clientConnectorService	ClientConnectorService Required. The resource being updated.
updateMask	FieldMask Required. Field mask is used to specify the fields to be overwritten in the ClientConnectorService resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Mutable fields: display_name.

Returns

Type	Description
OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata>

updateClientConnectorServiceAsync(UpdateClientConnectorServiceRequest request)

public final OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata> updateClientConnectorServiceAsync(UpdateClientConnectorServiceRequest request)

Updates the parameters of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   UpdateClientConnectorServiceRequest request =
       UpdateClientConnectorServiceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   ClientConnectorService response =
       clientConnectorServicesServiceClient.updateClientConnectorServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateClientConnectorServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<ClientConnectorService,ClientConnectorServiceOperationMetadata>

updateClientConnectorServiceCallable()

public final UnaryCallable<UpdateClientConnectorServiceRequest,Operation> updateClientConnectorServiceCallable()

Updates the parameters of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   UpdateClientConnectorServiceRequest request =
       UpdateClientConnectorServiceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   ApiFuture<Operation> future =
       clientConnectorServicesServiceClient
           .updateClientConnectorServiceCallable()
           .futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateClientConnectorServiceRequest,Operation>

updateClientConnectorServiceOperationCallable()

public final OperationCallable<UpdateClientConnectorServiceRequest,ClientConnectorService,ClientConnectorServiceOperationMetadata> updateClientConnectorServiceOperationCallable()

Updates the parameters of a single ClientConnectorService.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ClientConnectorServicesServiceClient clientConnectorServicesServiceClient =
     ClientConnectorServicesServiceClient.create()) {
   UpdateClientConnectorServiceRequest request =
       UpdateClientConnectorServiceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setClientConnectorService(ClientConnectorService.newBuilder().build())
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .setAllowMissing(true)
           .build();
   OperationFuture<ClientConnectorService, ClientConnectorServiceOperationMetadata> future =
       clientConnectorServicesServiceClient
           .updateClientConnectorServiceOperationCallable()
           .futureCall(request);
   // Do something.
   ClientConnectorService response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateClientConnectorServiceRequest,ClientConnectorService,ClientConnectorServiceOperationMetadata>