Class AggregateProductStatusesServiceClient (0.7.0)

Service Description: Service to manage aggregate product statuses.

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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AggregateProductStatus element :
       aggregateProductStatusesServiceClient.listAggregateProductStatuses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the AggregateProductStatusesServiceClient 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
ListAggregateProductStatuses	Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listAggregateProductStatuses(ListAggregateProductStatusesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listAggregateProductStatuses(AccountName parent) listAggregateProductStatuses(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. listAggregateProductStatusesPagedCallable() listAggregateProductStatusesCallable()

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 AggregateProductStatusesServiceSettings 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
 AggregateProductStatusesServiceSettings aggregateProductStatusesServiceSettings =
     AggregateProductStatusesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create(aggregateProductStatusesServiceSettings);

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
 AggregateProductStatusesServiceSettings aggregateProductStatusesServiceSettings =
     AggregateProductStatusesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create(aggregateProductStatusesServiceSettings);

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
 AggregateProductStatusesServiceSettings aggregateProductStatusesServiceSettings =
     AggregateProductStatusesServiceSettings.newHttpJsonBuilder().build();
 AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create(aggregateProductStatusesServiceSettings);

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

Inheritance

java.lang.Object > AggregateProductStatusesServiceClient

Static Methods

create()

public static final AggregateProductStatusesServiceClient create()

Constructs an instance of AggregateProductStatusesServiceClient with default settings.

Returns
Type	Description
`AggregateProductStatusesServiceClient`

Exceptions
Type	Description
`IOException`

create(AggregateProductStatusesServiceSettings settings)

public static final AggregateProductStatusesServiceClient create(AggregateProductStatusesServiceSettings settings)

Constructs an instance of AggregateProductStatusesServiceClient, 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`	`AggregateProductStatusesServiceSettings`

Returns
Type	Description
`AggregateProductStatusesServiceClient`

Exceptions
Type	Description
`IOException`

create(AggregateProductStatusesServiceStub stub)

public static final AggregateProductStatusesServiceClient create(AggregateProductStatusesServiceStub stub)

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

Parameter
Name	Description
`stub`	`AggregateProductStatusesServiceStub`

Returns
Type	Description
`AggregateProductStatusesServiceClient`

Constructors

AggregateProductStatusesServiceClient(AggregateProductStatusesServiceSettings settings)

protected AggregateProductStatusesServiceClient(AggregateProductStatusesServiceSettings settings)

Constructs an instance of AggregateProductStatusesServiceClient, 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`	`AggregateProductStatusesServiceSettings`

AggregateProductStatusesServiceClient(AggregateProductStatusesServiceStub stub)

protected AggregateProductStatusesServiceClient(AggregateProductStatusesServiceStub stub)

Parameter
Name	Description
`stub`	`AggregateProductStatusesServiceStub`

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

Returns
Type	Description
`AggregateProductStatusesServiceSettings`

getStub()

public AggregateProductStatusesServiceStub getStub()

Returns
Type	Description
`AggregateProductStatusesServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listAggregateProductStatuses(AccountName parent)

public final AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse listAggregateProductStatuses(AccountName parent)

Lists the AggregateProductStatuses resources for your merchant account. The response might contain fewer items than specified by pageSize. If pageToken was returned in previous request, it can be used to obtain additional results.

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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (AggregateProductStatus element :
       aggregateProductStatusesServiceClient.listAggregateProductStatuses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The account to list aggregate product statuses for. Format: `accounts/{account}`

Returns
Type	Description
`AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse`

listAggregateProductStatuses(ListAggregateProductStatusesRequest request)

public final AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse listAggregateProductStatuses(ListAggregateProductStatusesRequest 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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   ListAggregateProductStatusesRequest request =
       ListAggregateProductStatusesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (AggregateProductStatus element :
       aggregateProductStatusesServiceClient
           .listAggregateProductStatuses(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse`

listAggregateProductStatuses(String parent)

public final AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse listAggregateProductStatuses(String parent)

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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (AggregateProductStatus element :
       aggregateProductStatusesServiceClient.listAggregateProductStatuses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The account to list aggregate product statuses for. Format: `accounts/{account}`

Returns
Type	Description
`AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse`

listAggregateProductStatusesCallable()

public final UnaryCallable<ListAggregateProductStatusesRequest,ListAggregateProductStatusesResponse> listAggregateProductStatusesCallable()

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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   ListAggregateProductStatusesRequest request =
       ListAggregateProductStatusesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListAggregateProductStatusesResponse response =
         aggregateProductStatusesServiceClient
             .listAggregateProductStatusesCallable()
             .call(request);
     for (AggregateProductStatus element : response.getAggregateProductStatusesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListAggregateProductStatusesRequest,ListAggregateProductStatusesResponse>`

listAggregateProductStatusesPagedCallable()

public final UnaryCallable<ListAggregateProductStatusesRequest,AggregateProductStatusesServiceClient.ListAggregateProductStatusesPagedResponse> listAggregateProductStatusesPagedCallable()

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 (AggregateProductStatusesServiceClient aggregateProductStatusesServiceClient =
     AggregateProductStatusesServiceClient.create()) {
   ListAggregateProductStatusesRequest request =
       ListAggregateProductStatusesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<AggregateProductStatus> future =
       aggregateProductStatusesServiceClient
           .listAggregateProductStatusesPagedCallable()
           .futureCall(request);
   // Do something.
   for (AggregateProductStatus element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListAggregateProductStatusesRequest,ListAggregateProductStatusesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(AggregateProductStatusesServiceSettings settings)

create(AggregateProductStatusesServiceStub stub)

Constructors

AggregateProductStatusesServiceClient(AggregateProductStatusesServiceSettings settings)

AggregateProductStatusesServiceClient(AggregateProductStatusesServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getSettings()

getStub()

isShutdown()

isTerminated()

listAggregateProductStatuses(AccountName parent)

listAggregateProductStatuses(ListAggregateProductStatusesRequest request)

listAggregateProductStatuses(String parent)

listAggregateProductStatusesCallable()

listAggregateProductStatusesPagedCallable()

shutdown()

shutdownNow()

Class AggregateProductStatusesServiceClient (0.7.0)