Class AccountRelationshipsServiceClient (1.0.0)

Service Description: Service to support AccountRelationship 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   AccountRelationshipName name = AccountRelationshipName.of("[ACCOUNT]", "[RELATIONSHIP]");
   AccountRelationship response = accountRelationshipsServiceClient.getAccountRelationship(name);
 }

Note: close() needs to be called on the AccountRelationshipsServiceClient 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
GetAccountRelationship	Retrieve an account relationship.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getAccountRelationship(GetAccountRelationshipRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAccountRelationship(AccountRelationshipName name) getAccountRelationship(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. getAccountRelationshipCallable()
UpdateAccountRelationship	Updates the account relationship. Executing this method requires admin access.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAccountRelationship(UpdateAccountRelationshipRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAccountRelationship(AccountRelationship accountRelationship, 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. updateAccountRelationshipCallable()
ListAccountRelationships	List account relationships for the specified account.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAccountRelationships(ListAccountRelationshipsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAccountRelationships(AccountName parent) listAccountRelationships(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. listAccountRelationshipsPagedCallable() listAccountRelationshipsCallable()

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 AccountRelationshipsServiceSettings 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
 AccountRelationshipsServiceSettings accountRelationshipsServiceSettings =
     AccountRelationshipsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create(accountRelationshipsServiceSettings);

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
 AccountRelationshipsServiceSettings accountRelationshipsServiceSettings =
     AccountRelationshipsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create(accountRelationshipsServiceSettings);

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
 AccountRelationshipsServiceSettings accountRelationshipsServiceSettings =
     AccountRelationshipsServiceSettings.newHttpJsonBuilder().build();
 AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create(accountRelationshipsServiceSettings);

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

Inheritance

java.lang.Object > AccountRelationshipsServiceClient

Static Methods

create()

public static final AccountRelationshipsServiceClient create()

Constructs an instance of AccountRelationshipsServiceClient with default settings.

Returns
Type	Description
`AccountRelationshipsServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountRelationshipsServiceSettings settings)

public static final AccountRelationshipsServiceClient create(AccountRelationshipsServiceSettings settings)

Constructs an instance of AccountRelationshipsServiceClient, 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`	`AccountRelationshipsServiceSettings`

Returns
Type	Description
`AccountRelationshipsServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountRelationshipsServiceStub stub)

public static final AccountRelationshipsServiceClient create(AccountRelationshipsServiceStub stub)

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

Parameter
Name	Description
`stub`	`AccountRelationshipsServiceStub`

Returns
Type	Description
`AccountRelationshipsServiceClient`

Constructors

AccountRelationshipsServiceClient(AccountRelationshipsServiceSettings settings)

protected AccountRelationshipsServiceClient(AccountRelationshipsServiceSettings settings)

Constructs an instance of AccountRelationshipsServiceClient, 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`	`AccountRelationshipsServiceSettings`

AccountRelationshipsServiceClient(AccountRelationshipsServiceStub stub)

protected AccountRelationshipsServiceClient(AccountRelationshipsServiceStub stub)

Parameter
Name	Description
`stub`	`AccountRelationshipsServiceStub`

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

getAccountRelationship(AccountRelationshipName name)

public final AccountRelationship getAccountRelationship(AccountRelationshipName name)

Retrieve an account relationship.

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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   AccountRelationshipName name = AccountRelationshipName.of("[ACCOUNT]", "[RELATIONSHIP]");
   AccountRelationship response = accountRelationshipsServiceClient.getAccountRelationship(name);
 }

Parameter
Name	Description
`name`	`AccountRelationshipName` Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.

Returns
Type	Description
`AccountRelationship`

getAccountRelationship(GetAccountRelationshipRequest request)

public final AccountRelationship getAccountRelationship(GetAccountRelationshipRequest request)

Retrieve an account relationship.

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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   GetAccountRelationshipRequest request =
       GetAccountRelationshipRequest.newBuilder()
           .setName(AccountRelationshipName.of("[ACCOUNT]", "[RELATIONSHIP]").toString())
           .build();
   AccountRelationship response =
       accountRelationshipsServiceClient.getAccountRelationship(request);
 }

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

Returns
Type	Description
`AccountRelationship`

getAccountRelationship(String name)

public final AccountRelationship getAccountRelationship(String name)

Retrieve an account relationship.

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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   String name = AccountRelationshipName.of("[ACCOUNT]", "[RELATIONSHIP]").toString();
   AccountRelationship response = accountRelationshipsServiceClient.getAccountRelationship(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.

Returns
Type	Description
`AccountRelationship`

getAccountRelationshipCallable()

public final UnaryCallable<GetAccountRelationshipRequest,AccountRelationship> getAccountRelationshipCallable()

Retrieve an account relationship.

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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   GetAccountRelationshipRequest request =
       GetAccountRelationshipRequest.newBuilder()
           .setName(AccountRelationshipName.of("[ACCOUNT]", "[RELATIONSHIP]").toString())
           .build();
   ApiFuture<AccountRelationship> future =
       accountRelationshipsServiceClient.getAccountRelationshipCallable().futureCall(request);
   // Do something.
   AccountRelationship response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetAccountRelationshipRequest,AccountRelationship>`

getSettings()

public final AccountRelationshipsServiceSettings getSettings()

Returns
Type	Description
`AccountRelationshipsServiceSettings`

getStub()

public AccountRelationshipsServiceStub getStub()

Returns
Type	Description
`AccountRelationshipsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAccountRelationships(AccountName parent)

public final AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse listAccountRelationships(AccountName parent)

List account relationships for the specified 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccountRelationship element :
       accountRelationshipsServiceClient.listAccountRelationships(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The parent account of the account relationship to filter by. Format: `accounts/{account}`

Returns
Type	Description
`AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse`

listAccountRelationships(ListAccountRelationshipsRequest request)

public final AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse listAccountRelationships(ListAccountRelationshipsRequest request)

List account relationships for the specified 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   ListAccountRelationshipsRequest request =
       ListAccountRelationshipsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   for (AccountRelationship element :
       accountRelationshipsServiceClient.listAccountRelationships(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse`

listAccountRelationships(String parent)

public final AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse listAccountRelationships(String parent)

List account relationships for the specified 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AccountRelationship element :
       accountRelationshipsServiceClient.listAccountRelationships(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent account of the account relationship to filter by. Format: `accounts/{account}`

Returns
Type	Description
`AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse`

listAccountRelationshipsCallable()

public final UnaryCallable<ListAccountRelationshipsRequest,ListAccountRelationshipsResponse> listAccountRelationshipsCallable()

List account relationships for the specified 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   ListAccountRelationshipsRequest request =
       ListAccountRelationshipsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   while (true) {
     ListAccountRelationshipsResponse response =
         accountRelationshipsServiceClient.listAccountRelationshipsCallable().call(request);
     for (AccountRelationship element : response.getAccountRelationshipsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountRelationshipsRequest,ListAccountRelationshipsResponse>`

listAccountRelationshipsPagedCallable()

public final UnaryCallable<ListAccountRelationshipsRequest,AccountRelationshipsServiceClient.ListAccountRelationshipsPagedResponse> listAccountRelationshipsPagedCallable()

List account relationships for the specified 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   ListAccountRelationshipsRequest request =
       ListAccountRelationshipsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   ApiFuture<AccountRelationship> future =
       accountRelationshipsServiceClient
           .listAccountRelationshipsPagedCallable()
           .futureCall(request);
   // Do something.
   for (AccountRelationship element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountRelationshipsRequest,ListAccountRelationshipsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAccountRelationship(AccountRelationship accountRelationship, FieldMask updateMask)

public final AccountRelationship updateAccountRelationship(AccountRelationship accountRelationship, FieldMask updateMask)

Updates the account relationship. 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   AccountRelationship accountRelationship = AccountRelationship.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AccountRelationship response =
       accountRelationshipsServiceClient.updateAccountRelationship(
           accountRelationship, updateMask);
 }

Parameters

Name Description

accountRelationship

AccountRelationship

Required. The new version of the account relationship.

updateMask

FieldMask

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

- account_id_alias

Returns
Type	Description
`AccountRelationship`

updateAccountRelationship(UpdateAccountRelationshipRequest request)

public final AccountRelationship updateAccountRelationship(UpdateAccountRelationshipRequest request)

Updates the account relationship. 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   UpdateAccountRelationshipRequest request =
       UpdateAccountRelationshipRequest.newBuilder()
           .setAccountRelationship(AccountRelationship.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AccountRelationship response =
       accountRelationshipsServiceClient.updateAccountRelationship(request);
 }

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

Returns
Type	Description
`AccountRelationship`

updateAccountRelationshipCallable()

public final UnaryCallable<UpdateAccountRelationshipRequest,AccountRelationship> updateAccountRelationshipCallable()

Updates the account relationship. 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 (AccountRelationshipsServiceClient accountRelationshipsServiceClient =
     AccountRelationshipsServiceClient.create()) {
   UpdateAccountRelationshipRequest request =
       UpdateAccountRelationshipRequest.newBuilder()
           .setAccountRelationship(AccountRelationship.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AccountRelationship> future =
       accountRelationshipsServiceClient.updateAccountRelationshipCallable().futureCall(request);
   // Do something.
   AccountRelationship response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateAccountRelationshipRequest,AccountRelationship>`

Class AccountRelationshipsServiceClient (1.0.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(AccountRelationshipsServiceSettings settings)

create(AccountRelationshipsServiceStub stub)

Constructors

AccountRelationshipsServiceClient(AccountRelationshipsServiceSettings settings)

AccountRelationshipsServiceClient(AccountRelationshipsServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getAccountRelationship(AccountRelationshipName name)

getAccountRelationship(GetAccountRelationshipRequest request)

getAccountRelationship(String name)

getAccountRelationshipCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listAccountRelationships(AccountName parent)

listAccountRelationships(ListAccountRelationshipsRequest request)

listAccountRelationships(String parent)

listAccountRelationshipsCallable()

listAccountRelationshipsPagedCallable()

shutdown()

shutdownNow()

updateAccountRelationship(AccountRelationship accountRelationship, FieldMask updateMask)

updateAccountRelationship(UpdateAccountRelationshipRequest request)

updateAccountRelationshipCallable()

Class AccountRelationshipsServiceClient (1.0.0)