Class BusinessInfoServiceClient (0.5.0)

GitHub RepositoryProduct Reference

Service Description: Service to support business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   BusinessInfoName name = BusinessInfoName.of("[ACCOUNT]");
   BusinessInfo response = businessInfoServiceClient.getBusinessInfo(name);
 }

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

GetBusinessInfo

Retrieves the business info of an account.

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

  • getBusinessInfo(GetBusinessInfoRequest request)

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

  • getBusinessInfo(BusinessInfoName name)

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

  • getBusinessInfoCallable()

UpdateBusinessInfo

Updates the business info 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.

  • updateBusinessInfo(UpdateBusinessInfoRequest request)

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

  • updateBusinessInfo(BusinessInfo businessInfo, 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.

  • updateBusinessInfoCallable()

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 BusinessInfoServiceSettings 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
 BusinessInfoServiceSettings businessInfoServiceSettings =
     BusinessInfoServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BusinessInfoServiceClient businessInfoServiceClient =
     BusinessInfoServiceClient.create(businessInfoServiceSettings);

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
 BusinessInfoServiceSettings businessInfoServiceSettings =
     BusinessInfoServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BusinessInfoServiceClient businessInfoServiceClient =
     BusinessInfoServiceClient.create(businessInfoServiceSettings);

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
 BusinessInfoServiceSettings businessInfoServiceSettings =
     BusinessInfoServiceSettings.newHttpJsonBuilder().build();
 BusinessInfoServiceClient businessInfoServiceClient =
     BusinessInfoServiceClient.create(businessInfoServiceSettings);

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

Inheritance

java.lang.Object > BusinessInfoServiceClient

Static Methods

create()

public static final BusinessInfoServiceClient create()

Constructs an instance of BusinessInfoServiceClient with default settings.

Returns
Type Description
BusinessInfoServiceClient
Exceptions
Type Description
IOException

create(BusinessInfoServiceSettings settings)

public static final BusinessInfoServiceClient create(BusinessInfoServiceSettings settings)

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

create(BusinessInfoServiceStub stub)

public static final BusinessInfoServiceClient create(BusinessInfoServiceStub stub)

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

Parameter
Name Description
stub BusinessInfoServiceStub
Returns
Type Description
BusinessInfoServiceClient

Constructors

BusinessInfoServiceClient(BusinessInfoServiceSettings settings)

protected BusinessInfoServiceClient(BusinessInfoServiceSettings settings)

Constructs an instance of BusinessInfoServiceClient, 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 BusinessInfoServiceSettings

BusinessInfoServiceClient(BusinessInfoServiceStub stub)

protected BusinessInfoServiceClient(BusinessInfoServiceStub stub)
Parameter
Name Description
stub BusinessInfoServiceStub

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

getBusinessInfo(BusinessInfoName name)

public final BusinessInfo getBusinessInfo(BusinessInfoName name)

Retrieves the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   BusinessInfoName name = BusinessInfoName.of("[ACCOUNT]");
   BusinessInfo response = businessInfoServiceClient.getBusinessInfo(name);
 }
Parameter
Name Description
name BusinessInfoName

Required. The resource name of the business info. Format: accounts/{account}/businessInfo
Returns
Type Description
BusinessInfo

getBusinessInfo(GetBusinessInfoRequest request)

public final BusinessInfo getBusinessInfo(GetBusinessInfoRequest request)

Retrieves the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   GetBusinessInfoRequest request =
       GetBusinessInfoRequest.newBuilder()
           .setName(BusinessInfoName.of("[ACCOUNT]").toString())
           .build();
   BusinessInfo response = businessInfoServiceClient.getBusinessInfo(request);
 }
Parameter
Name Description
request GetBusinessInfoRequest

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

getBusinessInfo(String name)

public final BusinessInfo getBusinessInfo(String name)

Retrieves the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   String name = BusinessInfoName.of("[ACCOUNT]").toString();
   BusinessInfo response = businessInfoServiceClient.getBusinessInfo(name);
 }
Parameter
Name Description
name String

Required. The resource name of the business info. Format: accounts/{account}/businessInfo
Returns
Type Description
BusinessInfo

getBusinessInfoCallable()

public final UnaryCallable<GetBusinessInfoRequest,BusinessInfo> getBusinessInfoCallable()

Retrieves the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   GetBusinessInfoRequest request =
       GetBusinessInfoRequest.newBuilder()
           .setName(BusinessInfoName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<BusinessInfo> future =
       businessInfoServiceClient.getBusinessInfoCallable().futureCall(request);
   // Do something.
   BusinessInfo response = future.get();
 }
Returns
Type Description
UnaryCallable<GetBusinessInfoRequest,BusinessInfo>

getSettings()

public final BusinessInfoServiceSettings getSettings()
Returns
Type Description
BusinessInfoServiceSettings

getStub()

public BusinessInfoServiceStub getStub()
Returns
Type Description
BusinessInfoServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateBusinessInfo(BusinessInfo businessInfo, FieldMask updateMask)

public final BusinessInfo updateBusinessInfo(BusinessInfo businessInfo, FieldMask updateMask)

Updates the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   BusinessInfo businessInfo = BusinessInfo.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   BusinessInfo response =
       businessInfoServiceClient.updateBusinessInfo(businessInfo, updateMask);
 }
Parameters
Name Description
businessInfo BusinessInfo

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

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

updateBusinessInfo(UpdateBusinessInfoRequest request)

public final BusinessInfo updateBusinessInfo(UpdateBusinessInfoRequest request)

Updates the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   UpdateBusinessInfoRequest request =
       UpdateBusinessInfoRequest.newBuilder()
           .setBusinessInfo(BusinessInfo.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   BusinessInfo response = businessInfoServiceClient.updateBusinessInfo(request);
 }
Parameter
Name Description
request UpdateBusinessInfoRequest

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

updateBusinessInfoCallable()

public final UnaryCallable<UpdateBusinessInfoRequest,BusinessInfo> updateBusinessInfoCallable()

Updates the business info 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 (BusinessInfoServiceClient businessInfoServiceClient = BusinessInfoServiceClient.create()) {
   UpdateBusinessInfoRequest request =
       UpdateBusinessInfoRequest.newBuilder()
           .setBusinessInfo(BusinessInfo.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<BusinessInfo> future =
       businessInfoServiceClient.updateBusinessInfoCallable().futureCall(request);
   // Do something.
   BusinessInfo response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateBusinessInfoRequest,BusinessInfo>