Class OrderTrackingSignalsServiceClient (0.2.0)

GitHub RepositoryProduct Reference

Service Description: Service to serve order tracking signals public API.

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 (OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   String orderTrackingSignalId = "orderTrackingSignalId1140832552";
   OrderTrackingSignal response =
       orderTrackingSignalsServiceClient.createOrderTrackingSignal(
           parent, orderTrackingSignalId);
 }

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

CreateOrderTrackingSignal

Creates new order tracking signal.

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

  • createOrderTrackingSignal(CreateOrderTrackingSignalRequest request)

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

  • createOrderTrackingSignal(AccountName parent, String orderTrackingSignalId)

  • createOrderTrackingSignal(String parent, String orderTrackingSignalId)

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

  • createOrderTrackingSignalCallable()

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 OrderTrackingSignalsServiceSettings 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
 OrderTrackingSignalsServiceSettings orderTrackingSignalsServiceSettings =
     OrderTrackingSignalsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create(orderTrackingSignalsServiceSettings);

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
 OrderTrackingSignalsServiceSettings orderTrackingSignalsServiceSettings =
     OrderTrackingSignalsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create(orderTrackingSignalsServiceSettings);

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
 OrderTrackingSignalsServiceSettings orderTrackingSignalsServiceSettings =
     OrderTrackingSignalsServiceSettings.newHttpJsonBuilder().build();
 OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create(orderTrackingSignalsServiceSettings);

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

Inheritance

java.lang.Object > OrderTrackingSignalsServiceClient

Static Methods

create()

public static final OrderTrackingSignalsServiceClient create()

Constructs an instance of OrderTrackingSignalsServiceClient with default settings.

Returns
Type Description
OrderTrackingSignalsServiceClient
Exceptions
Type Description
IOException

create(OrderTrackingSignalsServiceSettings settings)

public static final OrderTrackingSignalsServiceClient create(OrderTrackingSignalsServiceSettings settings)

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

create(OrderTrackingSignalsServiceStub stub)

public static final OrderTrackingSignalsServiceClient create(OrderTrackingSignalsServiceStub stub)

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

Parameter
Name Description
stub OrderTrackingSignalsServiceStub
Returns
Type Description
OrderTrackingSignalsServiceClient

Constructors

OrderTrackingSignalsServiceClient(OrderTrackingSignalsServiceSettings settings)

protected OrderTrackingSignalsServiceClient(OrderTrackingSignalsServiceSettings settings)

Constructs an instance of OrderTrackingSignalsServiceClient, 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 OrderTrackingSignalsServiceSettings

OrderTrackingSignalsServiceClient(OrderTrackingSignalsServiceStub stub)

protected OrderTrackingSignalsServiceClient(OrderTrackingSignalsServiceStub stub)
Parameter
Name Description
stub OrderTrackingSignalsServiceStub

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

createOrderTrackingSignal(AccountName parent, String orderTrackingSignalId)

public final OrderTrackingSignal createOrderTrackingSignal(AccountName parent, String orderTrackingSignalId)

Creates new order tracking signal.

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 (OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   String orderTrackingSignalId = "orderTrackingSignalId1140832552";
   OrderTrackingSignal response =
       orderTrackingSignalsServiceClient.createOrderTrackingSignal(
           parent, orderTrackingSignalId);
 }
Parameters
Name Description
parent AccountName

Required. The account of the business for which the order signal is created. Format: accounts/{account}
orderTrackingSignalId String

Output only. The ID that uniquely identifies this order tracking signal.
Returns
Type Description
OrderTrackingSignal

createOrderTrackingSignal(CreateOrderTrackingSignalRequest request)

public final OrderTrackingSignal createOrderTrackingSignal(CreateOrderTrackingSignalRequest request)

Creates new order tracking signal.

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 (OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create()) {
   CreateOrderTrackingSignalRequest request =
       CreateOrderTrackingSignalRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setOrderTrackingSignalId("orderTrackingSignalId1140832552")
           .setOrderTrackingSignal(OrderTrackingSignal.newBuilder().build())
           .build();
   OrderTrackingSignal response =
       orderTrackingSignalsServiceClient.createOrderTrackingSignal(request);
 }
Parameter
Name Description
request CreateOrderTrackingSignalRequest

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

createOrderTrackingSignal(String parent, String orderTrackingSignalId)

public final OrderTrackingSignal createOrderTrackingSignal(String parent, String orderTrackingSignalId)

Creates new order tracking signal.

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 (OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   String orderTrackingSignalId = "orderTrackingSignalId1140832552";
   OrderTrackingSignal response =
       orderTrackingSignalsServiceClient.createOrderTrackingSignal(
           parent, orderTrackingSignalId);
 }
Parameters
Name Description
parent String

Required. The account of the business for which the order signal is created. Format: accounts/{account}
orderTrackingSignalId String

Output only. The ID that uniquely identifies this order tracking signal.
Returns
Type Description
OrderTrackingSignal

createOrderTrackingSignalCallable()

public final UnaryCallable<CreateOrderTrackingSignalRequest,OrderTrackingSignal> createOrderTrackingSignalCallable()

Creates new order tracking signal.

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 (OrderTrackingSignalsServiceClient orderTrackingSignalsServiceClient =
     OrderTrackingSignalsServiceClient.create()) {
   CreateOrderTrackingSignalRequest request =
       CreateOrderTrackingSignalRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setOrderTrackingSignalId("orderTrackingSignalId1140832552")
           .setOrderTrackingSignal(OrderTrackingSignal.newBuilder().build())
           .build();
   ApiFuture<OrderTrackingSignal> future =
       orderTrackingSignalsServiceClient.createOrderTrackingSignalCallable().futureCall(request);
   // Do something.
   OrderTrackingSignal response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateOrderTrackingSignalRequest,OrderTrackingSignal>

getSettings()

public final OrderTrackingSignalsServiceSettings getSettings()
Returns
Type Description
OrderTrackingSignalsServiceSettings

getStub()

public OrderTrackingSignalsServiceStub getStub()
Returns
Type Description
OrderTrackingSignalsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()