Class AccountsServiceClient (0.8.0)

Service Description: Service to support Accounts 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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   Account response = accountsServiceClient.getAccount(name);
 }

Note: close() needs to be called on the AccountsServiceClient 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
GetAccount	Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAccount(GetAccountRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAccount(AccountName name) getAccount(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. getAccountCallable()
CreateAndConfigureAccount	Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createAndConfigureAccount(CreateAndConfigureAccountRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createAndConfigureAccountCallable()
DeleteAccount	Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAccount(DeleteAccountRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteAccount(AccountName name) deleteAccount(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. deleteAccountCallable()
UpdateAccount	Updates an account regardless of its type: standalone, MCA or sub-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. updateAccount(UpdateAccountRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAccount(Account account, 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. updateAccountCallable()
ListAccounts	Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAccounts(ListAccountsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listAccountsPagedCallable() listAccountsCallable()
ListSubAccounts	List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSubAccounts(ListSubAccountsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSubAccounts(AccountName provider) listSubAccounts(String provider) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSubAccountsPagedCallable() listSubAccountsCallable()

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 AccountsServiceSettings 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
 AccountsServiceSettings accountsServiceSettings =
     AccountsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountsServiceClient accountsServiceClient =
     AccountsServiceClient.create(accountsServiceSettings);

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
 AccountsServiceSettings accountsServiceSettings =
     AccountsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountsServiceClient accountsServiceClient =
     AccountsServiceClient.create(accountsServiceSettings);

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
 AccountsServiceSettings accountsServiceSettings =
     AccountsServiceSettings.newHttpJsonBuilder().build();
 AccountsServiceClient accountsServiceClient =
     AccountsServiceClient.create(accountsServiceSettings);

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

Inheritance

java.lang.Object > AccountsServiceClient

Static Methods

create()

public static final AccountsServiceClient create()

Constructs an instance of AccountsServiceClient with default settings.

Returns
Type	Description
`AccountsServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountsServiceSettings settings)

public static final AccountsServiceClient create(AccountsServiceSettings settings)

Constructs an instance of AccountsServiceClient, 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`	`AccountsServiceSettings`

Returns
Type	Description
`AccountsServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountsServiceStub stub)

public static final AccountsServiceClient create(AccountsServiceStub stub)

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

Parameter
Name	Description
`stub`	`AccountsServiceStub`

Returns
Type	Description
`AccountsServiceClient`

Constructors

AccountsServiceClient(AccountsServiceSettings settings)

protected AccountsServiceClient(AccountsServiceSettings settings)

Constructs an instance of AccountsServiceClient, 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`	`AccountsServiceSettings`

AccountsServiceClient(AccountsServiceStub stub)

protected AccountsServiceClient(AccountsServiceStub stub)

Parameter
Name	Description
`stub`	`AccountsServiceStub`

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

createAndConfigureAccount(CreateAndConfigureAccountRequest request)

public final Account createAndConfigureAccount(CreateAndConfigureAccountRequest request)

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new 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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   CreateAndConfigureAccountRequest request =
       CreateAndConfigureAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .addAllUsers(new ArrayList<CreateUserRequest>())
           .setAcceptTermsOfService(
               CreateAndConfigureAccountRequest.AcceptTermsOfService.newBuilder().build())
           .addAllService(new ArrayList<CreateAndConfigureAccountRequest.AddAccountService>())
           .build();
   Account response = accountsServiceClient.createAndConfigureAccount(request);
 }

Parameter
Name	Description
`request`	`CreateAndConfigureAccountRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Account`

createAndConfigureAccountCallable()

public final UnaryCallable<CreateAndConfigureAccountRequest,Account> createAndConfigureAccountCallable()

Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new 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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   CreateAndConfigureAccountRequest request =
       CreateAndConfigureAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .addAllUsers(new ArrayList<CreateUserRequest>())
           .setAcceptTermsOfService(
               CreateAndConfigureAccountRequest.AcceptTermsOfService.newBuilder().build())
           .addAllService(new ArrayList<CreateAndConfigureAccountRequest.AddAccountService>())
           .build();
   ApiFuture<Account> future =
       accountsServiceClient.createAndConfigureAccountCallable().futureCall(request);
   // Do something.
   Account response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateAndConfigureAccountRequest,Account>`

deleteAccount(AccountName name)

public final void deleteAccount(AccountName name)

Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the force parameter to override this.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   accountsServiceClient.deleteAccount(name);
 }

Parameter
Name	Description
`name`	`AccountName` Required. The name of the account to delete. Format: `accounts/{account}`

deleteAccount(DeleteAccountRequest request)

public final void deleteAccount(DeleteAccountRequest request)

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   DeleteAccountRequest request =
       DeleteAccountRequest.newBuilder()
           .setName(AccountName.of("[ACCOUNT]").toString())
           .setForce(true)
           .build();
   accountsServiceClient.deleteAccount(request);
 }

Parameter
Name	Description
`request`	`DeleteAccountRequest` The request object containing all of the parameters for the API call.

deleteAccount(String name)

public final void deleteAccount(String name)

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   String name = AccountName.of("[ACCOUNT]").toString();
   accountsServiceClient.deleteAccount(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the account to delete. Format: `accounts/{account}`

deleteAccountCallable()

public final UnaryCallable<DeleteAccountRequest,Empty> deleteAccountCallable()

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   DeleteAccountRequest request =
       DeleteAccountRequest.newBuilder()
           .setName(AccountName.of("[ACCOUNT]").toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future = accountsServiceClient.deleteAccountCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteAccountRequest,Empty>`

getAccount(AccountName name)

public final Account getAccount(AccountName name)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   AccountName name = AccountName.of("[ACCOUNT]");
   Account response = accountsServiceClient.getAccount(name);
 }

Parameter
Name	Description
`name`	`AccountName` Required. The name of the account to retrieve. Format: `accounts/{account}`

Returns
Type	Description
`Account`

getAccount(GetAccountRequest request)

public final Account getAccount(GetAccountRequest request)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   GetAccountRequest request =
       GetAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   Account response = accountsServiceClient.getAccount(request);
 }

Parameter
Name	Description
`request`	`GetAccountRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Account`

getAccount(String name)

public final Account getAccount(String name)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   String name = AccountName.of("[ACCOUNT]").toString();
   Account response = accountsServiceClient.getAccount(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the account to retrieve. Format: `accounts/{account}`

Returns
Type	Description
`Account`

getAccountCallable()

public final UnaryCallable<GetAccountRequest,Account> getAccountCallable()

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   GetAccountRequest request =
       GetAccountRequest.newBuilder().setName(AccountName.of("[ACCOUNT]").toString()).build();
   ApiFuture<Account> future = accountsServiceClient.getAccountCallable().futureCall(request);
   // Do something.
   Account response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAccountRequest,Account>`

getSettings()

public final AccountsServiceSettings getSettings()

Returns
Type	Description
`AccountsServiceSettings`

getStub()

public AccountsServiceStub getStub()

Returns
Type	Description
`AccountsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAccounts(ListAccountsRequest request)

public final AccountsServiceClient.ListAccountsPagedResponse listAccounts(ListAccountsRequest request)

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Account element : accountsServiceClient.listAccounts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListAccountsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AccountsServiceClient.ListAccountsPagedResponse`

listAccountsCallable()

public final UnaryCallable<ListAccountsRequest,ListAccountsResponse> listAccountsCallable()

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListAccountsResponse response = accountsServiceClient.listAccountsCallable().call(request);
     for (Account element : response.getAccountsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountsRequest,ListAccountsResponse>`

listAccountsPagedCallable()

public final UnaryCallable<ListAccountsRequest,AccountsServiceClient.ListAccountsPagedResponse> listAccountsPagedCallable()

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListAccountsRequest request =
       ListAccountsRequest.newBuilder()
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Account> future =
       accountsServiceClient.listAccountsPagedCallable().futureCall(request);
   // Do something.
   for (Account element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountsRequest,ListAccountsPagedResponse>`

listSubAccounts(AccountName provider)

public final AccountsServiceClient.ListSubAccountsPagedResponse listSubAccounts(AccountName provider)

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful ListAccounts method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   AccountName provider = AccountName.of("[ACCOUNT]");
   for (Account element : accountsServiceClient.listSubAccounts(provider).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`provider`	`AccountName` Required. The parent account. Format: `accounts/{account}`

Returns
Type	Description
`AccountsServiceClient.ListSubAccountsPagedResponse`

listSubAccounts(ListSubAccountsRequest request)

public final AccountsServiceClient.ListSubAccountsPagedResponse listSubAccounts(ListSubAccountsRequest request)

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListSubAccountsRequest request =
       ListSubAccountsRequest.newBuilder()
           .setProvider(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Account element : accountsServiceClient.listSubAccounts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListSubAccountsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AccountsServiceClient.ListSubAccountsPagedResponse`

listSubAccounts(String provider)

public final AccountsServiceClient.ListSubAccountsPagedResponse listSubAccounts(String provider)

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   String provider = AccountName.of("[ACCOUNT]").toString();
   for (Account element : accountsServiceClient.listSubAccounts(provider).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`provider`	`String` Required. The parent account. Format: `accounts/{account}`

Returns
Type	Description
`AccountsServiceClient.ListSubAccountsPagedResponse`

listSubAccountsCallable()

public final UnaryCallable<ListSubAccountsRequest,ListSubAccountsResponse> listSubAccountsCallable()

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListSubAccountsRequest request =
       ListSubAccountsRequest.newBuilder()
           .setProvider(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSubAccountsResponse response =
         accountsServiceClient.listSubAccountsCallable().call(request);
     for (Account element : response.getAccountsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListSubAccountsRequest,ListSubAccountsResponse>`

listSubAccountsPagedCallable()

public final UnaryCallable<ListSubAccountsRequest,AccountsServiceClient.ListSubAccountsPagedResponse> listSubAccountsPagedCallable()

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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   ListSubAccountsRequest request =
       ListSubAccountsRequest.newBuilder()
           .setProvider(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Account> future =
       accountsServiceClient.listSubAccountsPagedCallable().futureCall(request);
   // Do something.
   for (Account element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListSubAccountsRequest,ListSubAccountsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAccount(Account account, FieldMask updateMask)

public final Account updateAccount(Account account, FieldMask updateMask)

Updates an account regardless of its type: standalone, MCA or sub-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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   Account account = Account.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Account response = accountsServiceClient.updateAccount(account, updateMask);
 }

Parameters
Name	Description
`account`	`Account` Required. The new version of the account.
`updateMask`	`FieldMask` Required. List of fields being updated.

Returns
Type	Description
`Account`

updateAccount(UpdateAccountRequest request)

public final Account updateAccount(UpdateAccountRequest request)

Updates an account regardless of its type: standalone, MCA or sub-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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   UpdateAccountRequest request =
       UpdateAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Account response = accountsServiceClient.updateAccount(request);
 }

Parameter
Name	Description
`request`	`UpdateAccountRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Account`

updateAccountCallable()

public final UnaryCallable<UpdateAccountRequest,Account> updateAccountCallable()

Updates an account regardless of its type: standalone, MCA or sub-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 (AccountsServiceClient accountsServiceClient = AccountsServiceClient.create()) {
   UpdateAccountRequest request =
       UpdateAccountRequest.newBuilder()
           .setAccount(Account.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Account> future = accountsServiceClient.updateAccountCallable().futureCall(request);
   // Do something.
   Account response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateAccountRequest,Account>`