Class AccountTaxServiceClient (0.8.0)

GitHub RepositoryProduct Reference

Service Description: Manages account level tax setting data.

This API defines the following resource model:

- AccountTax

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   AccountTaxName name = AccountTaxName.of("[ACCOUNT]", "[TAX]");
   AccountTax response = accountTaxServiceClient.getAccountTax(name);
 }

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

GetAccountTax

Returns the tax rules that match the conditions of GetAccountTaxRequest

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

  • getAccountTax(GetAccountTaxRequest request)

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

  • getAccountTax(AccountTaxName name)

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

  • getAccountTaxCallable()

ListAccountTax

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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

  • listAccountTax(ListAccountTaxRequest request)

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

  • listAccountTax(AccountName parent)

  • listAccountTax(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAccountTaxPagedCallable()

  • listAccountTaxCallable()

UpdateAccountTax

Updates the tax settings of the account.

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

  • updateAccountTax(UpdateAccountTaxRequest request)

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

  • updateAccountTax(AccountTax accountTax)

  • updateAccountTax(AccountTax accountTax, 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.

  • updateAccountTaxCallable()

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 AccountTaxServiceSettings 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
 AccountTaxServiceSettings accountTaxServiceSettings =
     AccountTaxServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountTaxServiceClient accountTaxServiceClient =
     AccountTaxServiceClient.create(accountTaxServiceSettings);

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
 AccountTaxServiceSettings accountTaxServiceSettings =
     AccountTaxServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountTaxServiceClient accountTaxServiceClient =
     AccountTaxServiceClient.create(accountTaxServiceSettings);

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
 AccountTaxServiceSettings accountTaxServiceSettings =
     AccountTaxServiceSettings.newHttpJsonBuilder().build();
 AccountTaxServiceClient accountTaxServiceClient =
     AccountTaxServiceClient.create(accountTaxServiceSettings);

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

Inheritance

java.lang.Object > AccountTaxServiceClient

Static Methods

create()

public static final AccountTaxServiceClient create()

Constructs an instance of AccountTaxServiceClient with default settings.

Returns
Type Description
AccountTaxServiceClient
Exceptions
Type Description
IOException

create(AccountTaxServiceSettings settings)

public static final AccountTaxServiceClient create(AccountTaxServiceSettings settings)

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

create(AccountTaxServiceStub stub)

public static final AccountTaxServiceClient create(AccountTaxServiceStub stub)

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

Parameter
Name Description
stub AccountTaxServiceStub
Returns
Type Description
AccountTaxServiceClient

Constructors

AccountTaxServiceClient(AccountTaxServiceSettings settings)

protected AccountTaxServiceClient(AccountTaxServiceSettings settings)

Constructs an instance of AccountTaxServiceClient, 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 AccountTaxServiceSettings

AccountTaxServiceClient(AccountTaxServiceStub stub)

protected AccountTaxServiceClient(AccountTaxServiceStub stub)
Parameter
Name Description
stub AccountTaxServiceStub

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

getAccountTax(AccountTaxName name)

public final AccountTax getAccountTax(AccountTaxName name)

Returns the tax rules that match the conditions of GetAccountTaxRequest

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   AccountTaxName name = AccountTaxName.of("[ACCOUNT]", "[TAX]");
   AccountTax response = accountTaxServiceClient.getAccountTax(name);
 }
Parameter
Name Description
name AccountTaxName

Required. The name from which tax settings will be retrieved
Returns
Type Description
AccountTax

getAccountTax(GetAccountTaxRequest request)

public final AccountTax getAccountTax(GetAccountTaxRequest request)

Returns the tax rules that match the conditions of GetAccountTaxRequest

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   GetAccountTaxRequest request =
       GetAccountTaxRequest.newBuilder()
           .setName(AccountTaxName.of("[ACCOUNT]", "[TAX]").toString())
           .build();
   AccountTax response = accountTaxServiceClient.getAccountTax(request);
 }
Parameter
Name Description
request GetAccountTaxRequest

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

getAccountTax(String name)

public final AccountTax getAccountTax(String name)

Returns the tax rules that match the conditions of GetAccountTaxRequest

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   String name = AccountTaxName.of("[ACCOUNT]", "[TAX]").toString();
   AccountTax response = accountTaxServiceClient.getAccountTax(name);
 }
Parameter
Name Description
name String

Required. The name from which tax settings will be retrieved
Returns
Type Description
AccountTax

getAccountTaxCallable()

public final UnaryCallable<GetAccountTaxRequest,AccountTax> getAccountTaxCallable()

Returns the tax rules that match the conditions of GetAccountTaxRequest

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   GetAccountTaxRequest request =
       GetAccountTaxRequest.newBuilder()
           .setName(AccountTaxName.of("[ACCOUNT]", "[TAX]").toString())
           .build();
   ApiFuture<AccountTax> future =
       accountTaxServiceClient.getAccountTaxCallable().futureCall(request);
   // Do something.
   AccountTax response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAccountTaxRequest,AccountTax>

getSettings()

public final AccountTaxServiceSettings getSettings()
Returns
Type Description
AccountTaxServiceSettings

getStub()

public AccountTaxServiceStub getStub()
Returns
Type Description
AccountTaxServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listAccountTax(AccountName parent)

public final AccountTaxServiceClient.ListAccountTaxPagedResponse listAccountTax(AccountName parent)

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccountTax element : accountTaxServiceClient.listAccountTax(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AccountName

Required. The parent, which owns this collection of account tax. Format: accounts/{account}
Returns
Type Description
AccountTaxServiceClient.ListAccountTaxPagedResponse

listAccountTax(ListAccountTaxRequest request)

public final AccountTaxServiceClient.ListAccountTaxPagedResponse listAccountTax(ListAccountTaxRequest request)

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   ListAccountTaxRequest request =
       ListAccountTaxRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AccountTax element : accountTaxServiceClient.listAccountTax(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListAccountTaxRequest

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

listAccountTax(String parent)

public final AccountTaxServiceClient.ListAccountTaxPagedResponse listAccountTax(String parent)

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AccountTax element : accountTaxServiceClient.listAccountTax(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of account tax. Format: accounts/{account}
Returns
Type Description
AccountTaxServiceClient.ListAccountTaxPagedResponse

listAccountTaxCallable()

public final UnaryCallable<ListAccountTaxRequest,ListAccountTaxResponse> listAccountTaxCallable()

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   ListAccountTaxRequest request =
       ListAccountTaxRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAccountTaxResponse response =
         accountTaxServiceClient.listAccountTaxCallable().call(request);
     for (AccountTax element : response.getAccountTaxesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListAccountTaxRequest,ListAccountTaxResponse>

listAccountTaxPagedCallable()

public final UnaryCallable<ListAccountTaxRequest,AccountTaxServiceClient.ListAccountTaxPagedResponse> listAccountTaxPagedCallable()

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   ListAccountTaxRequest request =
       ListAccountTaxRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AccountTax> future =
       accountTaxServiceClient.listAccountTaxPagedCallable().futureCall(request);
   // Do something.
   for (AccountTax element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAccountTaxRequest,ListAccountTaxPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAccountTax(AccountTax accountTax)

public final AccountTax updateAccountTax(AccountTax accountTax)

Updates the tax settings of the 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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   AccountTax accountTax = AccountTax.newBuilder().build();
   AccountTax response = accountTaxServiceClient.updateAccountTax(accountTax);
 }
Parameter
Name Description
accountTax AccountTax

Required. The tax setting that will be updated
Returns
Type Description
AccountTax

updateAccountTax(AccountTax accountTax, FieldMask updateMask)

public final AccountTax updateAccountTax(AccountTax accountTax, FieldMask updateMask)

Updates the tax settings of the 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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   AccountTax accountTax = AccountTax.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AccountTax response = accountTaxServiceClient.updateAccountTax(accountTax, updateMask);
 }
Parameters
Name Description
accountTax AccountTax

Required. The tax setting that will be updated
updateMask FieldMask

The list of fields to be updated
Returns
Type Description
AccountTax

updateAccountTax(UpdateAccountTaxRequest request)

public final AccountTax updateAccountTax(UpdateAccountTaxRequest request)

Updates the tax settings of the 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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   UpdateAccountTaxRequest request =
       UpdateAccountTaxRequest.newBuilder()
           .setAccountTax(AccountTax.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AccountTax response = accountTaxServiceClient.updateAccountTax(request);
 }
Parameter
Name Description
request UpdateAccountTaxRequest

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

updateAccountTaxCallable()

public final UnaryCallable<UpdateAccountTaxRequest,AccountTax> updateAccountTaxCallable()

Updates the tax settings of the 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 (AccountTaxServiceClient accountTaxServiceClient = AccountTaxServiceClient.create()) {
   UpdateAccountTaxRequest request =
       UpdateAccountTaxRequest.newBuilder()
           .setAccountTax(AccountTax.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AccountTax> future =
       accountTaxServiceClient.updateAccountTaxCallable().futureCall(request);
   // Do something.
   AccountTax response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAccountTaxRequest,AccountTax>