Class BusinessIdentityServiceClient (0.3.0)

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

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.

Constructs an instance of BusinessIdentityServiceClient with default 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.

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

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.

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);
 }
 

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);
 }
 

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);
 }
 

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

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);
 }
 

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);
 }
 

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