Class MerchantReviewsServiceClient (0.1.0)

GitHub RepositoryProduct Reference

Service Description: Service to manage merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   MerchantReviewName name = MerchantReviewName.of("[ACCOUNT]", "[NAME]");
   MerchantReview response = merchantReviewsServiceClient.getMerchantReview(name);
 }

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

GetMerchantReview

Gets a merchant review.

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

  • getMerchantReview(GetMerchantReviewRequest request)

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

  • getMerchantReview(MerchantReviewName name)

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

  • getMerchantReviewCallable()

ListMerchantReviews

Lists merchant reviews.

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

  • listMerchantReviews(ListMerchantReviewsRequest request)

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

  • listMerchantReviews(AccountName parent)

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

  • listMerchantReviewsPagedCallable()

  • listMerchantReviewsCallable()

InsertMerchantReview

Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

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

  • insertMerchantReview(InsertMerchantReviewRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertMerchantReviewCallable()

DeleteMerchantReview

Deletes merchant review.

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

  • deleteMerchantReview(DeleteMerchantReviewRequest request)

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

  • deleteMerchantReview(MerchantReviewName name)

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

  • deleteMerchantReviewCallable()

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 MerchantReviewsServiceSettings 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
 MerchantReviewsServiceSettings merchantReviewsServiceSettings =
     MerchantReviewsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create(merchantReviewsServiceSettings);

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
 MerchantReviewsServiceSettings merchantReviewsServiceSettings =
     MerchantReviewsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create(merchantReviewsServiceSettings);

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
 MerchantReviewsServiceSettings merchantReviewsServiceSettings =
     MerchantReviewsServiceSettings.newHttpJsonBuilder().build();
 MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create(merchantReviewsServiceSettings);

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

Inheritance

java.lang.Object > MerchantReviewsServiceClient

Static Methods

create()

public static final MerchantReviewsServiceClient create()

Constructs an instance of MerchantReviewsServiceClient with default settings.

Returns
Type Description
MerchantReviewsServiceClient
Exceptions
Type Description
IOException

create(MerchantReviewsServiceSettings settings)

public static final MerchantReviewsServiceClient create(MerchantReviewsServiceSettings settings)

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

create(MerchantReviewsServiceStub stub)

public static final MerchantReviewsServiceClient create(MerchantReviewsServiceStub stub)

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

Parameter
Name Description
stub MerchantReviewsServiceStub
Returns
Type Description
MerchantReviewsServiceClient

Constructors

MerchantReviewsServiceClient(MerchantReviewsServiceSettings settings)

protected MerchantReviewsServiceClient(MerchantReviewsServiceSettings settings)

Constructs an instance of MerchantReviewsServiceClient, 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 MerchantReviewsServiceSettings

MerchantReviewsServiceClient(MerchantReviewsServiceStub stub)

protected MerchantReviewsServiceClient(MerchantReviewsServiceStub stub)
Parameter
Name Description
stub MerchantReviewsServiceStub

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

deleteMerchantReview(DeleteMerchantReviewRequest request)

public final void deleteMerchantReview(DeleteMerchantReviewRequest request)

Deletes merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   DeleteMerchantReviewRequest request =
       DeleteMerchantReviewRequest.newBuilder()
           .setName(MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString())
           .build();
   merchantReviewsServiceClient.deleteMerchantReview(request);
 }
Parameter
Name Description
request DeleteMerchantReviewRequest

The request object containing all of the parameters for the API call.

deleteMerchantReview(MerchantReviewName name)

public final void deleteMerchantReview(MerchantReviewName name)

Deletes merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   MerchantReviewName name = MerchantReviewName.of("[ACCOUNT]", "[NAME]");
   merchantReviewsServiceClient.deleteMerchantReview(name);
 }
Parameter
Name Description
name MerchantReviewName

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

deleteMerchantReview(String name)

public final void deleteMerchantReview(String name)

Deletes merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   String name = MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString();
   merchantReviewsServiceClient.deleteMerchantReview(name);
 }
Parameter
Name Description
name String

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}

deleteMerchantReviewCallable()

public final UnaryCallable<DeleteMerchantReviewRequest,Empty> deleteMerchantReviewCallable()

Deletes merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   DeleteMerchantReviewRequest request =
       DeleteMerchantReviewRequest.newBuilder()
           .setName(MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString())
           .build();
   ApiFuture<Empty> future =
       merchantReviewsServiceClient.deleteMerchantReviewCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteMerchantReviewRequest,Empty>

getMerchantReview(GetMerchantReviewRequest request)

public final MerchantReview getMerchantReview(GetMerchantReviewRequest request)

Gets a merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   GetMerchantReviewRequest request =
       GetMerchantReviewRequest.newBuilder()
           .setName(MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString())
           .build();
   MerchantReview response = merchantReviewsServiceClient.getMerchantReview(request);
 }
Parameter
Name Description
request GetMerchantReviewRequest

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

getMerchantReview(MerchantReviewName name)

public final MerchantReview getMerchantReview(MerchantReviewName name)

Gets a merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   MerchantReviewName name = MerchantReviewName.of("[ACCOUNT]", "[NAME]");
   MerchantReview response = merchantReviewsServiceClient.getMerchantReview(name);
 }
Parameter
Name Description
name MerchantReviewName

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}
Returns
Type Description
MerchantReview

getMerchantReview(String name)

public final MerchantReview getMerchantReview(String name)

Gets a merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   String name = MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString();
   MerchantReview response = merchantReviewsServiceClient.getMerchantReview(name);
 }
Parameter
Name Description
name String

Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}
Returns
Type Description
MerchantReview

getMerchantReviewCallable()

public final UnaryCallable<GetMerchantReviewRequest,MerchantReview> getMerchantReviewCallable()

Gets a merchant review.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   GetMerchantReviewRequest request =
       GetMerchantReviewRequest.newBuilder()
           .setName(MerchantReviewName.of("[ACCOUNT]", "[NAME]").toString())
           .build();
   ApiFuture<MerchantReview> future =
       merchantReviewsServiceClient.getMerchantReviewCallable().futureCall(request);
   // Do something.
   MerchantReview response = future.get();
 }
Returns
Type Description
UnaryCallable<GetMerchantReviewRequest,MerchantReview>

getSettings()

public final MerchantReviewsServiceSettings getSettings()
Returns
Type Description
MerchantReviewsServiceSettings

getStub()

public MerchantReviewsServiceStub getStub()
Returns
Type Description
MerchantReviewsServiceStub

insertMerchantReview(InsertMerchantReviewRequest request)

public final MerchantReview insertMerchantReview(InsertMerchantReviewRequest request)

Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   InsertMerchantReviewRequest request =
       InsertMerchantReviewRequest.newBuilder()
           .setParent("parent-995424086")
           .setMerchantReview(MerchantReview.newBuilder().build())
           .setDataSource("dataSource1272470629")
           .build();
   MerchantReview response = merchantReviewsServiceClient.insertMerchantReview(request);
 }
Parameter
Name Description
request InsertMerchantReviewRequest

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

insertMerchantReviewCallable()

public final UnaryCallable<InsertMerchantReviewRequest,MerchantReview> insertMerchantReviewCallable()

Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   InsertMerchantReviewRequest request =
       InsertMerchantReviewRequest.newBuilder()
           .setParent("parent-995424086")
           .setMerchantReview(MerchantReview.newBuilder().build())
           .setDataSource("dataSource1272470629")
           .build();
   ApiFuture<MerchantReview> future =
       merchantReviewsServiceClient.insertMerchantReviewCallable().futureCall(request);
   // Do something.
   MerchantReview response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertMerchantReviewRequest,MerchantReview>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listMerchantReviews(AccountName parent)

public final MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse listMerchantReviews(AccountName parent)

Lists merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (MerchantReview element :
       merchantReviewsServiceClient.listMerchantReviews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AccountName

Required. The account to list merchant reviews for. Format: accounts/{account}
Returns
Type Description
MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse

listMerchantReviews(ListMerchantReviewsRequest request)

public final MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse listMerchantReviews(ListMerchantReviewsRequest request)

Lists merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   ListMerchantReviewsRequest request =
       ListMerchantReviewsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (MerchantReview element :
       merchantReviewsServiceClient.listMerchantReviews(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListMerchantReviewsRequest

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

listMerchantReviews(String parent)

public final MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse listMerchantReviews(String parent)

Lists merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (MerchantReview element :
       merchantReviewsServiceClient.listMerchantReviews(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The account to list merchant reviews for. Format: accounts/{account}
Returns
Type Description
MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse

listMerchantReviewsCallable()

public final UnaryCallable<ListMerchantReviewsRequest,ListMerchantReviewsResponse> listMerchantReviewsCallable()

Lists merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   ListMerchantReviewsRequest request =
       ListMerchantReviewsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListMerchantReviewsResponse response =
         merchantReviewsServiceClient.listMerchantReviewsCallable().call(request);
     for (MerchantReview element : response.getMerchantReviewsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListMerchantReviewsRequest,ListMerchantReviewsResponse>

listMerchantReviewsPagedCallable()

public final UnaryCallable<ListMerchantReviewsRequest,MerchantReviewsServiceClient.ListMerchantReviewsPagedResponse> listMerchantReviewsPagedCallable()

Lists merchant reviews.

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 (MerchantReviewsServiceClient merchantReviewsServiceClient =
     MerchantReviewsServiceClient.create()) {
   ListMerchantReviewsRequest request =
       ListMerchantReviewsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<MerchantReview> future =
       merchantReviewsServiceClient.listMerchantReviewsPagedCallable().futureCall(request);
   // Do something.
   for (MerchantReview element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListMerchantReviewsRequest,ListMerchantReviewsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()