ConsumerProcurementServiceClient (Google Cloud Commerce Consumer Procurement 0.4.0 API)

java.lang.Object
- com.google.cloud.commerce.consumer.procurement.v1alpha1.ConsumerProcurementServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ConsumerProcurementServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.

When purchases are made, the [ConsumerProcurementService][google.cloud.commerce.consumer.procurement.v1alpha1.ConsumerProcurementService] programs the appropriate backends, including both Google's own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   GetOrderRequest request = GetOrderRequest.newBuilder().setName("name3373707").build();
   Order response = consumerProcurementServiceClient.getOrder(request);
 }

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 ConsumerProcurementServiceSettings 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
 ConsumerProcurementServiceSettings consumerProcurementServiceSettings =
     ConsumerProcurementServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create(consumerProcurementServiceSettings);

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
 ConsumerProcurementServiceSettings consumerProcurementServiceSettings =
     ConsumerProcurementServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create(consumerProcurementServiceSettings);

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
 ConsumerProcurementServiceSettings consumerProcurementServiceSettings =
     ConsumerProcurementServiceSettings.newHttpJsonBuilder().build();
 ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create(consumerProcurementServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConsumerProcurementServiceClient.ListOrdersFixedSizeCollection`
`static class`	`ConsumerProcurementServiceClient.ListOrdersPage`
`static class`	`ConsumerProcurementServiceClient.ListOrdersPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConsumerProcurementServiceClient(ConsumerProcurementServiceSettings settings)` Constructs an instance of ConsumerProcurementServiceClient, using the given settings.
`protected`	`ConsumerProcurementServiceClient(ConsumerProcurementServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ConsumerProcurementServiceClient`	`create()` Constructs an instance of ConsumerProcurementServiceClient with default settings.
`static ConsumerProcurementServiceClient`	`create(ConsumerProcurementServiceSettings settings)` Constructs an instance of ConsumerProcurementServiceClient, using the given settings.
`static ConsumerProcurementServiceClient`	`create(ConsumerProcurementServiceStub stub)` Constructs an instance of ConsumerProcurementServiceClient, using the given stub for making calls.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Order`	`getOrder(GetOrderRequest request)` Returns the requested [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resource.
`com.google.api.gax.rpc.UnaryCallable<GetOrderRequest,Order>`	`getOrderCallable()` Returns the requested [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resource.
`ConsumerProcurementServiceSettings`	`getSettings()`
`ConsumerProcurementServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ConsumerProcurementServiceClient.ListOrdersPagedResponse`	`listOrders(ListOrdersRequest request)` Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.
`com.google.api.gax.rpc.UnaryCallable<ListOrdersRequest,ListOrdersResponse>`	`listOrdersCallable()` Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.
`com.google.api.gax.rpc.UnaryCallable<ListOrdersRequest,ConsumerProcurementServiceClient.ListOrdersPagedResponse>`	`listOrdersPagedCallable()` Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.
`com.google.api.gax.longrunning.OperationFuture<Order,PlaceOrderMetadata>`	`placeOrderAsync(PlaceOrderRequest request)` Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].
`com.google.api.gax.rpc.UnaryCallable<PlaceOrderRequest,com.google.longrunning.Operation>`	`placeOrderCallable()` Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].
`com.google.api.gax.rpc.OperationCallable<PlaceOrderRequest,Order,PlaceOrderMetadata>`	`placeOrderOperationCallable()` Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ConsumerProcurementServiceClient
```
protected ConsumerProcurementServiceClient(ConsumerProcurementServiceSettings settings)
                                    throws IOException
```
  Constructs an instance of ConsumerProcurementServiceClient, 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.
  
  Throws:
  
  IOException
- ConsumerProcurementServiceClient
```
protected ConsumerProcurementServiceClient(ConsumerProcurementServiceStub stub)
```

Method Detail

create

public static final ConsumerProcurementServiceClient create()
                                                     throws IOException

Constructs an instance of ConsumerProcurementServiceClient with default settings.

Throws:: IOException

create
```
public static final ConsumerProcurementServiceClient create(ConsumerProcurementServiceSettings settings)
                                                     throws IOException
```
Constructs an instance of ConsumerProcurementServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final ConsumerProcurementServiceClient create(ConsumerProcurementServiceStub stub)
```
Constructs an instance of ConsumerProcurementServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConsumerProcurementServiceSettings).

getSettings

public final ConsumerProcurementServiceSettings getSettings()

getStub

public ConsumerProcurementServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

placeOrderAsync

public final com.google.api.gax.longrunning.OperationFuture<Order,PlaceOrderMetadata> placeOrderAsync(PlaceOrderRequest request)

Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].

The returned long-running operation is in-progress until the backend completes the creation of the resource. Once completed, the order is in [OrderState.ORDER_STATE_ACTIVE][google.cloud.commerce.consumer.procurement.v1alpha1.OrderState.ORDER_STATE_ACTIVE]. In case of failure, the order resource will be removed.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   PlaceOrderRequest request =
       PlaceOrderRequest.newBuilder()
           .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
           .setDisplayName("displayName1714148973")
           .addAllLineItemInfo(new ArrayList<LineItemInfo>())
           .setRequestId("requestId693933066")
           .build();
   Order response = consumerProcurementServiceClient.placeOrderAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

placeOrderOperationCallable

public final com.google.api.gax.rpc.OperationCallable<PlaceOrderRequest,Order,PlaceOrderMetadata> placeOrderOperationCallable()

Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   PlaceOrderRequest request =
       PlaceOrderRequest.newBuilder()
           .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
           .setDisplayName("displayName1714148973")
           .addAllLineItemInfo(new ArrayList<LineItemInfo>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Order, PlaceOrderMetadata> future =
       consumerProcurementServiceClient.placeOrderOperationCallable().futureCall(request);
   // Do something.
   Order response = future.get();
 }

placeOrderCallable

public final com.google.api.gax.rpc.UnaryCallable<PlaceOrderRequest,com.google.longrunning.Operation> placeOrderCallable()

Creates a new [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order].

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   PlaceOrderRequest request =
       PlaceOrderRequest.newBuilder()
           .setParent(BillingAccountName.of("[BILLING_ACCOUNT]").toString())
           .setDisplayName("displayName1714148973")
           .addAllLineItemInfo(new ArrayList<LineItemInfo>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       consumerProcurementServiceClient.placeOrderCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

getOrder

public final Order getOrder(GetOrderRequest request)

Returns the requested [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resource.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   GetOrderRequest request = GetOrderRequest.newBuilder().setName("name3373707").build();
   Order response = consumerProcurementServiceClient.getOrder(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getOrderCallable

public final com.google.api.gax.rpc.UnaryCallable<GetOrderRequest,Order> getOrderCallable()

Returns the requested [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resource.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   GetOrderRequest request = GetOrderRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Order> future =
       consumerProcurementServiceClient.getOrderCallable().futureCall(request);
   // Do something.
   Order response = future.get();
 }

listOrders

public final ConsumerProcurementServiceClient.ListOrdersPagedResponse listOrders(ListOrdersRequest request)

Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   ListOrdersRequest request =
       ListOrdersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (Order element : consumerProcurementServiceClient.listOrders(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listOrdersPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListOrdersRequest,ConsumerProcurementServiceClient.ListOrdersPagedResponse> listOrdersPagedCallable()

Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   ListOrdersRequest request =
       ListOrdersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Order> future =
       consumerProcurementServiceClient.listOrdersPagedCallable().futureCall(request);
   // Do something.
   for (Order element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listOrdersCallable

public final com.google.api.gax.rpc.UnaryCallable<ListOrdersRequest,ListOrdersResponse> listOrdersCallable()

Lists [Order][google.cloud.commerce.consumer.procurement.v1alpha1.Order] resources that the user has access to, within the scope of the parent resource.

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 (ConsumerProcurementServiceClient consumerProcurementServiceClient =
     ConsumerProcurementServiceClient.create()) {
   ListOrdersRequest request =
       ListOrdersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListOrdersResponse response =
         consumerProcurementServiceClient.listOrdersCallable().call(request);
     for (Order element : response.getOrdersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class ConsumerProcurementServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumerProcurementServiceClient

ConsumerProcurementServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

placeOrderAsync

placeOrderOperationCallable

placeOrderCallable

getOrder

getOrderCallable

listOrders

listOrdersPagedCallable

listOrdersCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination