Class BusinessIdentityServiceClient (0.11.0)

GitHub RepositoryProduct Reference

Service Description: Service to support business identity API.

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   BusinessIdentityName name = BusinessIdentityName.of("[ACCOUNT]");
   BusinessIdentity response = businessIdentityServiceClient.getBusinessIdentity(name);
 }

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

GetBusinessIdentity

Retrieves the business identity of an account.

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

  • getBusinessIdentity(GetBusinessIdentityRequest request)

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

  • getBusinessIdentity(BusinessIdentityName name)

  • getBusinessIdentity(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.

  • getBusinessIdentityCallable()

UpdateBusinessIdentity

Updates the business identity of an account. Executing this method requires admin access.

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

  • updateBusinessIdentity(UpdateBusinessIdentityRequest request)

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

  • updateBusinessIdentity(BusinessIdentity businessIdentity, 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.

  • updateBusinessIdentityCallable()

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 BusinessIdentityServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BusinessIdentityServiceSettings businessIdentityServiceSettings =
     BusinessIdentityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create(businessIdentityServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 BusinessIdentityServiceSettings businessIdentityServiceSettings =
     BusinessIdentityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create(businessIdentityServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 BusinessIdentityServiceSettings businessIdentityServiceSettings =
     BusinessIdentityServiceSettings.newHttpJsonBuilder().build();
 BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create(businessIdentityServiceSettings);

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

Inheritance

java.lang.Object > BusinessIdentityServiceClient

Static Methods

create()

public static final BusinessIdentityServiceClient create()

Constructs an instance of BusinessIdentityServiceClient with default settings.

Returns
Type Description
BusinessIdentityServiceClient
Exceptions
Type Description
IOException

create(BusinessIdentityServiceSettings settings)

public static final BusinessIdentityServiceClient create(BusinessIdentityServiceSettings settings)

Constructs an instance of BusinessIdentityServiceClient, 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 BusinessIdentityServiceSettings
Returns
Type Description
BusinessIdentityServiceClient
Exceptions
Type Description
IOException

create(BusinessIdentityServiceStub stub)

public static final BusinessIdentityServiceClient create(BusinessIdentityServiceStub stub)

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

Parameter
Name Description
stub BusinessIdentityServiceStub
Returns
Type Description
BusinessIdentityServiceClient

Constructors

BusinessIdentityServiceClient(BusinessIdentityServiceSettings settings)

protected BusinessIdentityServiceClient(BusinessIdentityServiceSettings settings)

Constructs an instance of BusinessIdentityServiceClient, 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 BusinessIdentityServiceSettings

BusinessIdentityServiceClient(BusinessIdentityServiceStub stub)

protected BusinessIdentityServiceClient(BusinessIdentityServiceStub stub)
Parameter
Name Description
stub BusinessIdentityServiceStub

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

getBusinessIdentity(BusinessIdentityName name)

public final BusinessIdentity getBusinessIdentity(BusinessIdentityName name)

Retrieves the business identity of an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   BusinessIdentityName name = BusinessIdentityName.of("[ACCOUNT]");
   BusinessIdentity response = businessIdentityServiceClient.getBusinessIdentity(name);
 }
Parameter
Name Description
name BusinessIdentityName

Required. The resource name of the business identity. Format: accounts/{account}/businessIdentity
Returns
Type Description
BusinessIdentity

getBusinessIdentity(GetBusinessIdentityRequest request)

public final BusinessIdentity getBusinessIdentity(GetBusinessIdentityRequest request)

Retrieves the business identity of an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   GetBusinessIdentityRequest request =
       GetBusinessIdentityRequest.newBuilder()
           .setName(BusinessIdentityName.of("[ACCOUNT]").toString())
           .build();
   BusinessIdentity response = businessIdentityServiceClient.getBusinessIdentity(request);
 }
Parameter
Name Description
request GetBusinessIdentityRequest

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

getBusinessIdentity(String name)

public final BusinessIdentity getBusinessIdentity(String name)

Retrieves the business identity of an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   String name = BusinessIdentityName.of("[ACCOUNT]").toString();
   BusinessIdentity response = businessIdentityServiceClient.getBusinessIdentity(name);
 }
Parameter
Name Description
name String

Required. The resource name of the business identity. Format: accounts/{account}/businessIdentity
Returns
Type Description
BusinessIdentity

getBusinessIdentityCallable()

public final UnaryCallable<GetBusinessIdentityRequest,BusinessIdentity> getBusinessIdentityCallable()

Retrieves the business identity of an account.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   GetBusinessIdentityRequest request =
       GetBusinessIdentityRequest.newBuilder()
           .setName(BusinessIdentityName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<BusinessIdentity> future =
       businessIdentityServiceClient.getBusinessIdentityCallable().futureCall(request);
   // Do something.
   BusinessIdentity response = future.get();
 }
Returns
Type Description
UnaryCallable<GetBusinessIdentityRequest,BusinessIdentity>

getSettings()

public final BusinessIdentityServiceSettings getSettings()
Returns
Type Description
BusinessIdentityServiceSettings

getStub()

public BusinessIdentityServiceStub getStub()
Returns
Type Description
BusinessIdentityServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBusinessIdentity(BusinessIdentity businessIdentity, FieldMask updateMask)

public final BusinessIdentity updateBusinessIdentity(BusinessIdentity businessIdentity, FieldMask updateMask)

Updates the business identity of an account. Executing this method requires admin access.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   BusinessIdentity businessIdentity = BusinessIdentity.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BusinessIdentity response =
       businessIdentityServiceClient.updateBusinessIdentity(businessIdentity, updateMask);
 }
Parameters
Name Description
businessIdentity BusinessIdentity

Required. The new version of the business identity.
updateMask FieldMask

Required. List of fields being updated.
Returns
Type Description
BusinessIdentity

updateBusinessIdentity(UpdateBusinessIdentityRequest request)

public final BusinessIdentity updateBusinessIdentity(UpdateBusinessIdentityRequest request)

Updates the business identity of an account. Executing this method requires admin access.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   UpdateBusinessIdentityRequest request =
       UpdateBusinessIdentityRequest.newBuilder()
           .setBusinessIdentity(BusinessIdentity.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BusinessIdentity response = businessIdentityServiceClient.updateBusinessIdentity(request);
 }
Parameter
Name Description
request UpdateBusinessIdentityRequest

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

updateBusinessIdentityCallable()

public final UnaryCallable<UpdateBusinessIdentityRequest,BusinessIdentity> updateBusinessIdentityCallable()

Updates the business identity of an account. Executing this method requires admin access.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (BusinessIdentityServiceClient businessIdentityServiceClient =
     BusinessIdentityServiceClient.create()) {
   UpdateBusinessIdentityRequest request =
       UpdateBusinessIdentityRequest.newBuilder()
           .setBusinessIdentity(BusinessIdentity.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<BusinessIdentity> future =
       businessIdentityServiceClient.updateBusinessIdentityCallable().futureCall(request);
   // Do something.
   BusinessIdentity response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateBusinessIdentityRequest,BusinessIdentity>