Class HomepageServiceClient (0.11.0)

GitHub RepositoryProduct Reference

Service Description: Service to support an API for a store's homepage.

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   HomepageName name = HomepageName.of("[ACCOUNT]");
   Homepage response = homepageServiceClient.getHomepage(name);
 }

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

GetHomepage

Retrieves a store's homepage.

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

  • getHomepage(GetHomepageRequest request)

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

  • getHomepage(HomepageName name)

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

  • getHomepageCallable()

UpdateHomepage

Updates a store's homepage. Executing this method requires admin access.

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

  • updateHomepage(UpdateHomepageRequest request)

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

  • updateHomepage(Homepage homepage, 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.

  • updateHomepageCallable()

ClaimHomepage

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).

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

  • claimHomepage(ClaimHomepageRequest request)

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

  • claimHomepageCallable()

UnclaimHomepage

Unclaims a store's homepage. Executing this method requires admin access.

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

  • unclaimHomepage(UnclaimHomepageRequest request)

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

  • unclaimHomepageCallable()

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 HomepageServiceSettings 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
 HomepageServiceSettings homepageServiceSettings =
     HomepageServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 HomepageServiceClient homepageServiceClient =
     HomepageServiceClient.create(homepageServiceSettings);

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
 HomepageServiceSettings homepageServiceSettings =
     HomepageServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 HomepageServiceClient homepageServiceClient =
     HomepageServiceClient.create(homepageServiceSettings);

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
 HomepageServiceSettings homepageServiceSettings =
     HomepageServiceSettings.newHttpJsonBuilder().build();
 HomepageServiceClient homepageServiceClient =
     HomepageServiceClient.create(homepageServiceSettings);

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

Inheritance

java.lang.Object > HomepageServiceClient

Static Methods

create()

public static final HomepageServiceClient create()

Constructs an instance of HomepageServiceClient with default settings.

Returns
Type Description
HomepageServiceClient
Exceptions
Type Description
IOException

create(HomepageServiceSettings settings)

public static final HomepageServiceClient create(HomepageServiceSettings settings)

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

create(HomepageServiceStub stub)

public static final HomepageServiceClient create(HomepageServiceStub stub)

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

Parameter
Name Description
stub HomepageServiceStub
Returns
Type Description
HomepageServiceClient

Constructors

HomepageServiceClient(HomepageServiceSettings settings)

protected HomepageServiceClient(HomepageServiceSettings settings)

Constructs an instance of HomepageServiceClient, 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 HomepageServiceSettings

HomepageServiceClient(HomepageServiceStub stub)

protected HomepageServiceClient(HomepageServiceStub stub)
Parameter
Name Description
stub HomepageServiceStub

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

claimHomepage(ClaimHomepageRequest request)

public final Homepage claimHomepage(ClaimHomepageRequest request)

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   ClaimHomepageRequest request =
       ClaimHomepageRequest.newBuilder()
           .setName(HomepageName.of("[ACCOUNT]").toString())
           .build();
   Homepage response = homepageServiceClient.claimHomepage(request);
 }
Parameter
Name Description
request ClaimHomepageRequest

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

claimHomepageCallable()

public final UnaryCallable<ClaimHomepageRequest,Homepage> claimHomepageCallable()

Claims a store's homepage. Executing this method requires admin access.

If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   ClaimHomepageRequest request =
       ClaimHomepageRequest.newBuilder()
           .setName(HomepageName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<Homepage> future =
       homepageServiceClient.claimHomepageCallable().futureCall(request);
   // Do something.
   Homepage response = future.get();
 }
Returns
Type Description
UnaryCallable<ClaimHomepageRequest,Homepage>

close()

public final void close()

getHomepage(GetHomepageRequest request)

public final Homepage getHomepage(GetHomepageRequest request)

Retrieves a store's homepage.

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   GetHomepageRequest request =
       GetHomepageRequest.newBuilder().setName(HomepageName.of("[ACCOUNT]").toString()).build();
   Homepage response = homepageServiceClient.getHomepage(request);
 }
Parameter
Name Description
request GetHomepageRequest

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

getHomepage(HomepageName name)

public final Homepage getHomepage(HomepageName name)

Retrieves a store's homepage.

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   HomepageName name = HomepageName.of("[ACCOUNT]");
   Homepage response = homepageServiceClient.getHomepage(name);
 }
Parameter
Name Description
name HomepageName

Required. The name of the homepage to retrieve. Format: accounts/{account}/homepage
Returns
Type Description
Homepage

getHomepage(String name)

public final Homepage getHomepage(String name)

Retrieves a store's homepage.

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   String name = HomepageName.of("[ACCOUNT]").toString();
   Homepage response = homepageServiceClient.getHomepage(name);
 }
Parameter
Name Description
name String

Required. The name of the homepage to retrieve. Format: accounts/{account}/homepage
Returns
Type Description
Homepage

getHomepageCallable()

public final UnaryCallable<GetHomepageRequest,Homepage> getHomepageCallable()

Retrieves a store's homepage.

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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   GetHomepageRequest request =
       GetHomepageRequest.newBuilder().setName(HomepageName.of("[ACCOUNT]").toString()).build();
   ApiFuture<Homepage> future = homepageServiceClient.getHomepageCallable().futureCall(request);
   // Do something.
   Homepage response = future.get();
 }
Returns
Type Description
UnaryCallable<GetHomepageRequest,Homepage>

getSettings()

public final HomepageServiceSettings getSettings()
Returns
Type Description
HomepageServiceSettings

getStub()

public HomepageServiceStub getStub()
Returns
Type Description
HomepageServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

unclaimHomepage(UnclaimHomepageRequest request)

public final Homepage unclaimHomepage(UnclaimHomepageRequest request)

Unclaims a store's homepage. 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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   UnclaimHomepageRequest request =
       UnclaimHomepageRequest.newBuilder()
           .setName(HomepageName.of("[ACCOUNT]").toString())
           .build();
   Homepage response = homepageServiceClient.unclaimHomepage(request);
 }
Parameter
Name Description
request UnclaimHomepageRequest

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

unclaimHomepageCallable()

public final UnaryCallable<UnclaimHomepageRequest,Homepage> unclaimHomepageCallable()

Unclaims a store's homepage. 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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   UnclaimHomepageRequest request =
       UnclaimHomepageRequest.newBuilder()
           .setName(HomepageName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<Homepage> future =
       homepageServiceClient.unclaimHomepageCallable().futureCall(request);
   // Do something.
   Homepage response = future.get();
 }
Returns
Type Description
UnaryCallable<UnclaimHomepageRequest,Homepage>

updateHomepage(Homepage homepage, FieldMask updateMask)

public final Homepage updateHomepage(Homepage homepage, FieldMask updateMask)

Updates a store's homepage. 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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   Homepage homepage = Homepage.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Homepage response = homepageServiceClient.updateHomepage(homepage, updateMask);
 }
Parameters
Name Description
homepage Homepage

Required. The new version of the homepage.
updateMask FieldMask

Required. List of fields being updated.
Returns
Type Description
Homepage

updateHomepage(UpdateHomepageRequest request)

public final Homepage updateHomepage(UpdateHomepageRequest request)

Updates a store's homepage. 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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   UpdateHomepageRequest request =
       UpdateHomepageRequest.newBuilder()
           .setHomepage(Homepage.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Homepage response = homepageServiceClient.updateHomepage(request);
 }
Parameter
Name Description
request UpdateHomepageRequest

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

updateHomepageCallable()

public final UnaryCallable<UpdateHomepageRequest,Homepage> updateHomepageCallable()

Updates a store's homepage. 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 (HomepageServiceClient homepageServiceClient = HomepageServiceClient.create()) {
   UpdateHomepageRequest request =
       UpdateHomepageRequest.newBuilder()
           .setHomepage(Homepage.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Homepage> future =
       homepageServiceClient.updateHomepageCallable().futureCall(request);
   // Do something.
   Homepage response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateHomepageRequest,Homepage>