Class AutomaticImprovementsServiceClient (0.16.0)

GitHub RepositoryProduct Reference

Service Description: Service to manage the automatic improvements of an account. The automatic improvements of the account can be used to automatically update products, improve images and shipping.

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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   AutomaticImprovementsName name = AutomaticImprovementsName.of("[ACCOUNT]");
   AutomaticImprovements response =
       automaticImprovementsServiceClient.getAutomaticImprovements(name);
 }

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

GetAutomaticImprovements

Retrieves the automatic improvements of an account.

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

  • getAutomaticImprovements(GetAutomaticImprovementsRequest request)

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

  • getAutomaticImprovements(AutomaticImprovementsName name)

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

  • getAutomaticImprovementsCallable()

UpdateAutomaticImprovements

Updates the automatic improvements of an account.

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

  • updateAutomaticImprovements(UpdateAutomaticImprovementsRequest request)

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

  • updateAutomaticImprovements(AutomaticImprovements automaticImprovements, 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.

  • updateAutomaticImprovementsCallable()

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 AutomaticImprovementsServiceSettings 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
 AutomaticImprovementsServiceSettings automaticImprovementsServiceSettings =
     AutomaticImprovementsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create(automaticImprovementsServiceSettings);

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
 AutomaticImprovementsServiceSettings automaticImprovementsServiceSettings =
     AutomaticImprovementsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create(automaticImprovementsServiceSettings);

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
 AutomaticImprovementsServiceSettings automaticImprovementsServiceSettings =
     AutomaticImprovementsServiceSettings.newHttpJsonBuilder().build();
 AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create(automaticImprovementsServiceSettings);

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

Inheritance

java.lang.Object > AutomaticImprovementsServiceClient

Static Methods

create()

public static final AutomaticImprovementsServiceClient create()

Constructs an instance of AutomaticImprovementsServiceClient with default settings.

Returns
Type Description
AutomaticImprovementsServiceClient
Exceptions
Type Description
IOException

create(AutomaticImprovementsServiceSettings settings)

public static final AutomaticImprovementsServiceClient create(AutomaticImprovementsServiceSettings settings)

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

create(AutomaticImprovementsServiceStub stub)

public static final AutomaticImprovementsServiceClient create(AutomaticImprovementsServiceStub stub)

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

Parameter
Name Description
stub AutomaticImprovementsServiceStub
Returns
Type Description
AutomaticImprovementsServiceClient

Constructors

AutomaticImprovementsServiceClient(AutomaticImprovementsServiceSettings settings)

protected AutomaticImprovementsServiceClient(AutomaticImprovementsServiceSettings settings)

Constructs an instance of AutomaticImprovementsServiceClient, 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 AutomaticImprovementsServiceSettings

AutomaticImprovementsServiceClient(AutomaticImprovementsServiceStub stub)

protected AutomaticImprovementsServiceClient(AutomaticImprovementsServiceStub stub)
Parameter
Name Description
stub AutomaticImprovementsServiceStub

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

getAutomaticImprovements(AutomaticImprovementsName name)

public final AutomaticImprovements getAutomaticImprovements(AutomaticImprovementsName name)

Retrieves the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   AutomaticImprovementsName name = AutomaticImprovementsName.of("[ACCOUNT]");
   AutomaticImprovements response =
       automaticImprovementsServiceClient.getAutomaticImprovements(name);
 }
Parameter
Name Description
name AutomaticImprovementsName

Required. The resource name of the automatic improvements. Format: accounts/{account}/automaticImprovements
Returns
Type Description
AutomaticImprovements

getAutomaticImprovements(GetAutomaticImprovementsRequest request)

public final AutomaticImprovements getAutomaticImprovements(GetAutomaticImprovementsRequest request)

Retrieves the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   GetAutomaticImprovementsRequest request =
       GetAutomaticImprovementsRequest.newBuilder()
           .setName(AutomaticImprovementsName.of("[ACCOUNT]").toString())
           .build();
   AutomaticImprovements response =
       automaticImprovementsServiceClient.getAutomaticImprovements(request);
 }
Parameter
Name Description
request GetAutomaticImprovementsRequest

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

getAutomaticImprovements(String name)

public final AutomaticImprovements getAutomaticImprovements(String name)

Retrieves the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   String name = AutomaticImprovementsName.of("[ACCOUNT]").toString();
   AutomaticImprovements response =
       automaticImprovementsServiceClient.getAutomaticImprovements(name);
 }
Parameter
Name Description
name String

Required. The resource name of the automatic improvements. Format: accounts/{account}/automaticImprovements
Returns
Type Description
AutomaticImprovements

getAutomaticImprovementsCallable()

public final UnaryCallable<GetAutomaticImprovementsRequest,AutomaticImprovements> getAutomaticImprovementsCallable()

Retrieves the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   GetAutomaticImprovementsRequest request =
       GetAutomaticImprovementsRequest.newBuilder()
           .setName(AutomaticImprovementsName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<AutomaticImprovements> future =
       automaticImprovementsServiceClient.getAutomaticImprovementsCallable().futureCall(request);
   // Do something.
   AutomaticImprovements response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAutomaticImprovementsRequest,AutomaticImprovements>

getSettings()

public final AutomaticImprovementsServiceSettings getSettings()
Returns
Type Description
AutomaticImprovementsServiceSettings

getStub()

public AutomaticImprovementsServiceStub getStub()
Returns
Type Description
AutomaticImprovementsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAutomaticImprovements(AutomaticImprovements automaticImprovements, FieldMask updateMask)

public final AutomaticImprovements updateAutomaticImprovements(AutomaticImprovements automaticImprovements, FieldMask updateMask)

Updates the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   AutomaticImprovements automaticImprovements = AutomaticImprovements.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   AutomaticImprovements response =
       automaticImprovementsServiceClient.updateAutomaticImprovements(
           automaticImprovements, updateMask);
 }
Parameters
Name Description
automaticImprovements AutomaticImprovements

Required. The new version of the automatic imrovements.
updateMask FieldMask

Required. List of fields being updated. The following fields are supported (in both snake_case and lowerCamelCase):

- item_updates - item_updates.account_level_settings - image_improvements - image_improvements.account_level_settings - shipping_improvements - shipping_improvements.allow_shipping_improvements
Returns
Type Description
AutomaticImprovements

updateAutomaticImprovements(UpdateAutomaticImprovementsRequest request)

public final AutomaticImprovements updateAutomaticImprovements(UpdateAutomaticImprovementsRequest request)

Updates the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   UpdateAutomaticImprovementsRequest request =
       UpdateAutomaticImprovementsRequest.newBuilder()
           .setAutomaticImprovements(AutomaticImprovements.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AutomaticImprovements response =
       automaticImprovementsServiceClient.updateAutomaticImprovements(request);
 }
Parameter
Name Description
request UpdateAutomaticImprovementsRequest

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

updateAutomaticImprovementsCallable()

public final UnaryCallable<UpdateAutomaticImprovementsRequest,AutomaticImprovements> updateAutomaticImprovementsCallable()

Updates the automatic improvements of an 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 (AutomaticImprovementsServiceClient automaticImprovementsServiceClient =
     AutomaticImprovementsServiceClient.create()) {
   UpdateAutomaticImprovementsRequest request =
       UpdateAutomaticImprovementsRequest.newBuilder()
           .setAutomaticImprovements(AutomaticImprovements.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AutomaticImprovements> future =
       automaticImprovementsServiceClient
           .updateAutomaticImprovementsCallable()
           .futureCall(request);
   // Do something.
   AutomaticImprovements response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateAutomaticImprovementsRequest,AutomaticImprovements>