Class RegionsServiceClient (0.8.0)

GitHub RepositoryProduct Reference

Service Description: Manages regions configuration.

This API defines the following resource model:

- Region

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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   RegionName name = RegionName.of("[ACCOUNT]", "[REGION]");
   Region response = regionsServiceClient.getRegion(name);
 }
 

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

GetRegion

Retrieves a region defined in your Merchant Center account.

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

  • getRegion(GetRegionRequest request)

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

  • getRegion(RegionName name)

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

  • getRegionCallable()

CreateRegion

Creates a region definition in your Merchant Center account. Executing this method requires admin access.

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

  • createRegion(CreateRegionRequest request)

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

  • createRegion(AccountName parent, Region region, String regionId)

  • createRegion(String parent, Region region, String regionId)

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

  • createRegionCallable()

UpdateRegion

Updates a region definition in your Merchant Center account. Executing this method requires admin access.

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

  • updateRegion(UpdateRegionRequest request)

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

  • updateRegion(Region region, 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.

  • updateRegionCallable()

DeleteRegion

Deletes a region definition from your Merchant Center account. Executing this method requires admin access.

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

  • deleteRegion(DeleteRegionRequest request)

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

  • deleteRegion(RegionName name)

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

  • deleteRegionCallable()

ListRegions

Lists the regions in your Merchant Center account.

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

  • listRegions(ListRegionsRequest request)

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

  • listRegions(AccountName parent)

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

  • listRegionsPagedCallable()

  • listRegionsCallable()

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 RegionsServiceSettings 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
 RegionsServiceSettings regionsServiceSettings =
     RegionsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionsServiceClient regionsServiceClient = RegionsServiceClient.create(regionsServiceSettings);
 

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
 RegionsServiceSettings regionsServiceSettings =
     RegionsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionsServiceClient regionsServiceClient = RegionsServiceClient.create(regionsServiceSettings);
 

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
 RegionsServiceSettings regionsServiceSettings =
     RegionsServiceSettings.newHttpJsonBuilder().build();
 RegionsServiceClient regionsServiceClient = RegionsServiceClient.create(regionsServiceSettings);
 

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

Inheritance

java.lang.Object > RegionsServiceClient

Static Methods

create()

public static final RegionsServiceClient create()

Constructs an instance of RegionsServiceClient with default settings.

Returns
Type Description
RegionsServiceClient
Exceptions
Type Description
IOException

create(RegionsServiceSettings settings)

public static final RegionsServiceClient create(RegionsServiceSettings settings)

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

create(RegionsServiceStub stub)

public static final RegionsServiceClient create(RegionsServiceStub stub)

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

Parameter
Name Description
stub RegionsServiceStub
Returns
Type Description
RegionsServiceClient

Constructors

RegionsServiceClient(RegionsServiceSettings settings)

protected RegionsServiceClient(RegionsServiceSettings settings)

Constructs an instance of RegionsServiceClient, 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 RegionsServiceSettings

RegionsServiceClient(RegionsServiceStub stub)

protected RegionsServiceClient(RegionsServiceStub stub)
Parameter
Name Description
stub RegionsServiceStub

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

createRegion(AccountName parent, Region region, String regionId)

public final Region createRegion(AccountName parent, Region region, String regionId)

Creates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   Region region = Region.newBuilder().build();
   String regionId = "regionId-690339025";
   Region response = regionsServiceClient.createRegion(parent, region, regionId);
 }
 
Parameters
Name Description
parent AccountName

Required. The account to create a region for. Format: accounts/{account}

region Region

Required. The region to create.

regionId String

Required. The identifier for the region, unique over all regions of the same account.

Returns
Type Description
Region

createRegion(CreateRegionRequest request)

public final Region createRegion(CreateRegionRequest request)

Creates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   CreateRegionRequest request =
       CreateRegionRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setRegionId("regionId-690339025")
           .setRegion(Region.newBuilder().build())
           .build();
   Region response = regionsServiceClient.createRegion(request);
 }
 
Parameter
Name Description
request CreateRegionRequest

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

Returns
Type Description
Region

createRegion(String parent, Region region, String regionId)

public final Region createRegion(String parent, Region region, String regionId)

Creates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   Region region = Region.newBuilder().build();
   String regionId = "regionId-690339025";
   Region response = regionsServiceClient.createRegion(parent, region, regionId);
 }
 
Parameters
Name Description
parent String

Required. The account to create a region for. Format: accounts/{account}

region Region

Required. The region to create.

regionId String

Required. The identifier for the region, unique over all regions of the same account.

Returns
Type Description
Region

createRegionCallable()

public final UnaryCallable<CreateRegionRequest,Region> createRegionCallable()

Creates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   CreateRegionRequest request =
       CreateRegionRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setRegionId("regionId-690339025")
           .setRegion(Region.newBuilder().build())
           .build();
   ApiFuture<Region> future = regionsServiceClient.createRegionCallable().futureCall(request);
   // Do something.
   Region response = future.get();
 }
 
Returns
Type Description
UnaryCallable<CreateRegionRequest,Region>

deleteRegion(DeleteRegionRequest request)

public final void deleteRegion(DeleteRegionRequest request)

Deletes a region definition from your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   DeleteRegionRequest request =
       DeleteRegionRequest.newBuilder()
           .setName(RegionName.of("[ACCOUNT]", "[REGION]").toString())
           .build();
   regionsServiceClient.deleteRegion(request);
 }
 
Parameter
Name Description
request DeleteRegionRequest

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

deleteRegion(RegionName name)

public final void deleteRegion(RegionName name)

Deletes a region definition from your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   RegionName name = RegionName.of("[ACCOUNT]", "[REGION]");
   regionsServiceClient.deleteRegion(name);
 }
 
Parameter
Name Description
name RegionName

Required. The name of the region to delete. Format: accounts/{account}/regions/{region}

deleteRegion(String name)

public final void deleteRegion(String name)

Deletes a region definition from your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   String name = RegionName.of("[ACCOUNT]", "[REGION]").toString();
   regionsServiceClient.deleteRegion(name);
 }
 
Parameter
Name Description
name String

Required. The name of the region to delete. Format: accounts/{account}/regions/{region}

deleteRegionCallable()

public final UnaryCallable<DeleteRegionRequest,Empty> deleteRegionCallable()

Deletes a region definition from your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   DeleteRegionRequest request =
       DeleteRegionRequest.newBuilder()
           .setName(RegionName.of("[ACCOUNT]", "[REGION]").toString())
           .build();
   ApiFuture<Empty> future = regionsServiceClient.deleteRegionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
Type Description
UnaryCallable<DeleteRegionRequest,Empty>

getRegion(GetRegionRequest request)

public final Region getRegion(GetRegionRequest request)

Retrieves a region defined in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   GetRegionRequest request =
       GetRegionRequest.newBuilder()
           .setName(RegionName.of("[ACCOUNT]", "[REGION]").toString())
           .build();
   Region response = regionsServiceClient.getRegion(request);
 }
 
Parameter
Name Description
request GetRegionRequest

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

Returns
Type Description
Region

getRegion(RegionName name)

public final Region getRegion(RegionName name)

Retrieves a region defined in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   RegionName name = RegionName.of("[ACCOUNT]", "[REGION]");
   Region response = regionsServiceClient.getRegion(name);
 }
 
Parameter
Name Description
name RegionName

Required. The name of the region to retrieve. Format: accounts/{account}/regions/{region}

Returns
Type Description
Region

getRegion(String name)

public final Region getRegion(String name)

Retrieves a region defined in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   String name = RegionName.of("[ACCOUNT]", "[REGION]").toString();
   Region response = regionsServiceClient.getRegion(name);
 }
 
Parameter
Name Description
name String

Required. The name of the region to retrieve. Format: accounts/{account}/regions/{region}

Returns
Type Description
Region

getRegionCallable()

public final UnaryCallable<GetRegionRequest,Region> getRegionCallable()

Retrieves a region defined in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   GetRegionRequest request =
       GetRegionRequest.newBuilder()
           .setName(RegionName.of("[ACCOUNT]", "[REGION]").toString())
           .build();
   ApiFuture<Region> future = regionsServiceClient.getRegionCallable().futureCall(request);
   // Do something.
   Region response = future.get();
 }
 
Returns
Type Description
UnaryCallable<GetRegionRequest,Region>

getSettings()

public final RegionsServiceSettings getSettings()
Returns
Type Description
RegionsServiceSettings

getStub()

public RegionsServiceStub getStub()
Returns
Type Description
RegionsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listRegions(AccountName parent)

public final RegionsServiceClient.ListRegionsPagedResponse listRegions(AccountName parent)

Lists the regions in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (Region element : regionsServiceClient.listRegions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent AccountName

Required. The account to list regions for. Format: accounts/{account}

Returns
Type Description
RegionsServiceClient.ListRegionsPagedResponse

listRegions(ListRegionsRequest request)

public final RegionsServiceClient.ListRegionsPagedResponse listRegions(ListRegionsRequest request)

Lists the regions in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   ListRegionsRequest request =
       ListRegionsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Region element : regionsServiceClient.listRegions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
request ListRegionsRequest

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

Returns
Type Description
RegionsServiceClient.ListRegionsPagedResponse

listRegions(String parent)

public final RegionsServiceClient.ListRegionsPagedResponse listRegions(String parent)

Lists the regions in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (Region element : regionsServiceClient.listRegions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
Name Description
parent String

Required. The account to list regions for. Format: accounts/{account}

Returns
Type Description
RegionsServiceClient.ListRegionsPagedResponse

listRegionsCallable()

public final UnaryCallable<ListRegionsRequest,ListRegionsResponse> listRegionsCallable()

Lists the regions in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   ListRegionsRequest request =
       ListRegionsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRegionsResponse response = regionsServiceClient.listRegionsCallable().call(request);
     for (Region element : response.getRegionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
Type Description
UnaryCallable<ListRegionsRequest,ListRegionsResponse>

listRegionsPagedCallable()

public final UnaryCallable<ListRegionsRequest,RegionsServiceClient.ListRegionsPagedResponse> listRegionsPagedCallable()

Lists the regions in your 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   ListRegionsRequest request =
       ListRegionsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Region> future =
       regionsServiceClient.listRegionsPagedCallable().futureCall(request);
   // Do something.
   for (Region element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
Type Description
UnaryCallable<ListRegionsRequest,ListRegionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateRegion(Region region, FieldMask updateMask)

public final Region updateRegion(Region region, FieldMask updateMask)

Updates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   Region region = Region.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Region response = regionsServiceClient.updateRegion(region, updateMask);
 }
 
Parameters
Name Description
region Region

Required. The updated region.

updateMask FieldMask

Optional. The comma-separated field mask indicating the fields to update. Example: "displayName,postalCodeArea.regionCode".

Returns
Type Description
Region

updateRegion(UpdateRegionRequest request)

public final Region updateRegion(UpdateRegionRequest request)

Updates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   UpdateRegionRequest request =
       UpdateRegionRequest.newBuilder()
           .setRegion(Region.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Region response = regionsServiceClient.updateRegion(request);
 }
 
Parameter
Name Description
request UpdateRegionRequest

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

Returns
Type Description
Region

updateRegionCallable()

public final UnaryCallable<UpdateRegionRequest,Region> updateRegionCallable()

Updates a region definition in your Merchant Center account. 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 (RegionsServiceClient regionsServiceClient = RegionsServiceClient.create()) {
   UpdateRegionRequest request =
       UpdateRegionRequest.newBuilder()
           .setRegion(Region.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Region> future = regionsServiceClient.updateRegionCallable().futureCall(request);
   // Do something.
   Region response = future.get();
 }
 
Returns
Type Description
UnaryCallable<UpdateRegionRequest,Region>