Class ShippingSettingsServiceClient (0.9.0)

Service Description: Service to get method call shipping setting information per Merchant API method.

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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   ShippingSettingsName name = ShippingSettingsName.of("[ACCOUNT]");
   ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(name);
 }
 

Note: close() needs to be called on the ShippingSettingsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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 ShippingSettingsServiceSettings 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
 ShippingSettingsServiceSettings shippingSettingsServiceSettings =
     ShippingSettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create(shippingSettingsServiceSettings);
 

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
 ShippingSettingsServiceSettings shippingSettingsServiceSettings =
     ShippingSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create(shippingSettingsServiceSettings);
 

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
 ShippingSettingsServiceSettings shippingSettingsServiceSettings =
     ShippingSettingsServiceSettings.newHttpJsonBuilder().build();
 ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create(shippingSettingsServiceSettings);
 

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

Constructs an instance of ShippingSettingsServiceClient with default settings.

Constructs an instance of ShippingSettingsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

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

Constructs an instance of ShippingSettingsServiceClient, 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.

Retrieve shipping setting information.

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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   GetShippingSettingsRequest request =
       GetShippingSettingsRequest.newBuilder()
           .setName(ShippingSettingsName.of("[ACCOUNT]").toString())
           .build();
   ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(request);
 }
 

Retrieve shipping setting information.

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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   ShippingSettingsName name = ShippingSettingsName.of("[ACCOUNT]");
   ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(name);
 }
 

Retrieve shipping setting information.

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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   String name = ShippingSettingsName.of("[ACCOUNT]").toString();
   ShippingSettings response = shippingSettingsServiceClient.getShippingSettings(name);
 }
 

Retrieve shipping setting information.

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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   GetShippingSettingsRequest request =
       GetShippingSettingsRequest.newBuilder()
           .setName(ShippingSettingsName.of("[ACCOUNT]").toString())
           .build();
   ApiFuture<ShippingSettings> future =
       shippingSettingsServiceClient.getShippingSettingsCallable().futureCall(request);
   // Do something.
   ShippingSettings response = future.get();
 }
 

Replace the shipping setting of a merchant with the request shipping setting. 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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   InsertShippingSettingsRequest request =
       InsertShippingSettingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setShippingSetting(ShippingSettings.newBuilder().build())
           .build();
   ShippingSettings response = shippingSettingsServiceClient.insertShippingSettings(request);
 }
 

Replace the shipping setting of a merchant with the request shipping setting. 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 (ShippingSettingsServiceClient shippingSettingsServiceClient =
     ShippingSettingsServiceClient.create()) {
   InsertShippingSettingsRequest request =
       InsertShippingSettingsRequest.newBuilder()
           .setParent("parent-995424086")
           .setShippingSetting(ShippingSettings.newBuilder().build())
           .build();
   ApiFuture<ShippingSettings> future =
       shippingSettingsServiceClient.insertShippingSettingsCallable().futureCall(request);
   // Do something.
   ShippingSettings response = future.get();
 }