Class AccountIssueServiceClient (0.11.0)

Service Description: Service to support AccountIssueService 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccountIssue element :
       accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the AccountIssueServiceClient 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
ListAccountIssues	Lists all account issues of a Merchant Center account.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAccountIssues(ListAccountIssuesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAccountIssues(AccountName parent) listAccountIssues(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. listAccountIssuesPagedCallable() listAccountIssuesCallable()

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 AccountIssueServiceSettings 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
 AccountIssueServiceSettings accountIssueServiceSettings =
     AccountIssueServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AccountIssueServiceClient accountIssueServiceClient =
     AccountIssueServiceClient.create(accountIssueServiceSettings);

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
 AccountIssueServiceSettings accountIssueServiceSettings =
     AccountIssueServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AccountIssueServiceClient accountIssueServiceClient =
     AccountIssueServiceClient.create(accountIssueServiceSettings);

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
 AccountIssueServiceSettings accountIssueServiceSettings =
     AccountIssueServiceSettings.newHttpJsonBuilder().build();
 AccountIssueServiceClient accountIssueServiceClient =
     AccountIssueServiceClient.create(accountIssueServiceSettings);

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

Inheritance

java.lang.Object > AccountIssueServiceClient

Static Methods

create()

public static final AccountIssueServiceClient create()

Constructs an instance of AccountIssueServiceClient with default settings.

Returns
Type	Description
`AccountIssueServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountIssueServiceSettings settings)

public static final AccountIssueServiceClient create(AccountIssueServiceSettings settings)

Constructs an instance of AccountIssueServiceClient, 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`	`AccountIssueServiceSettings`

Returns
Type	Description
`AccountIssueServiceClient`

Exceptions
Type	Description
`IOException`

create(AccountIssueServiceStub stub)

public static final AccountIssueServiceClient create(AccountIssueServiceStub stub)

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

Parameter
Name	Description
`stub`	`AccountIssueServiceStub`

Returns
Type	Description
`AccountIssueServiceClient`

Constructors

AccountIssueServiceClient(AccountIssueServiceSettings settings)

protected AccountIssueServiceClient(AccountIssueServiceSettings settings)

Constructs an instance of AccountIssueServiceClient, 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`	`AccountIssueServiceSettings`

AccountIssueServiceClient(AccountIssueServiceStub stub)

protected AccountIssueServiceClient(AccountIssueServiceStub stub)

Parameter
Name	Description
`stub`	`AccountIssueServiceStub`

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

getSettings()

public final AccountIssueServiceSettings getSettings()

Returns
Type	Description
`AccountIssueServiceSettings`

getStub()

public AccountIssueServiceStub getStub()

Returns
Type	Description
`AccountIssueServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAccountIssues(AccountName parent)

public final AccountIssueServiceClient.ListAccountIssuesPagedResponse listAccountIssues(AccountName parent)

Lists all account issues of a Merchant Center 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AccountIssue element :
       accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The parent, which owns this collection of issues. Format: `accounts/{account}`

Returns
Type	Description
`AccountIssueServiceClient.ListAccountIssuesPagedResponse`

listAccountIssues(ListAccountIssuesRequest request)

public final AccountIssueServiceClient.ListAccountIssuesPagedResponse listAccountIssues(ListAccountIssuesRequest request)

Lists all account issues of a Merchant Center 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   ListAccountIssuesRequest request =
       ListAccountIssuesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .setTimeZone("timeZone-2077180903")
           .build();
   for (AccountIssue element :
       accountIssueServiceClient.listAccountIssues(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`AccountIssueServiceClient.ListAccountIssuesPagedResponse`

listAccountIssues(String parent)

public final AccountIssueServiceClient.ListAccountIssuesPagedResponse listAccountIssues(String parent)

Lists all account issues of a Merchant Center 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AccountIssue element :
       accountIssueServiceClient.listAccountIssues(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of issues. Format: `accounts/{account}`

Returns
Type	Description
`AccountIssueServiceClient.ListAccountIssuesPagedResponse`

listAccountIssuesCallable()

public final UnaryCallable<ListAccountIssuesRequest,ListAccountIssuesResponse> listAccountIssuesCallable()

Lists all account issues of a Merchant Center 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   ListAccountIssuesRequest request =
       ListAccountIssuesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .setTimeZone("timeZone-2077180903")
           .build();
   while (true) {
     ListAccountIssuesResponse response =
         accountIssueServiceClient.listAccountIssuesCallable().call(request);
     for (AccountIssue element : response.getAccountIssuesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountIssuesRequest,ListAccountIssuesResponse>`

listAccountIssuesPagedCallable()

public final UnaryCallable<ListAccountIssuesRequest,AccountIssueServiceClient.ListAccountIssuesPagedResponse> listAccountIssuesPagedCallable()

Lists all account issues of a Merchant Center 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 (AccountIssueServiceClient accountIssueServiceClient = AccountIssueServiceClient.create()) {
   ListAccountIssuesRequest request =
       ListAccountIssuesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .setTimeZone("timeZone-2077180903")
           .build();
   ApiFuture<AccountIssue> future =
       accountIssueServiceClient.listAccountIssuesPagedCallable().futureCall(request);
   // Do something.
   for (AccountIssue element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAccountIssuesRequest,ListAccountIssuesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()