Package com.google.cloud.commerce.consumer.procurement.v1alpha1 (0.4.0)

A client to Cloud Commerce Consumer Procurement API

The interfaces provided are listed below, along with usage samples.

ConsumerProcurementServiceClient

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

When purchases are made, the 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.

Sample for ConsumerProcurementServiceClient:


 // 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);
 }

Classes

BillingAccountName

BillingAccountName.Builder

Builder for billingAccounts/{billing_account}.

ConsumerProcurementServiceClient

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

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.

ConsumerProcurementServiceClient.ListOrdersFixedSizeCollection

ConsumerProcurementServiceClient.ListOrdersPage

ConsumerProcurementServiceClient.ListOrdersPagedResponse

ConsumerProcurementServiceGrpc

ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform. When purchases are made, the 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.

ConsumerProcurementServiceGrpc.ConsumerProcurementServiceBlockingStub

ConsumerProcurementServiceGrpc.ConsumerProcurementServiceFutureStub

ConsumerProcurementServiceGrpc.ConsumerProcurementServiceImplBase

ConsumerProcurementServiceGrpc.ConsumerProcurementServiceStub

ConsumerProcurementServiceSettings

Settings class to configure an instance of ConsumerProcurementServiceClient.

The default instance has everything set to sensible defaults:

The default service address (cloudcommerceconsumerprocurement.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getOrder to 30 seconds:


 // 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.Builder consumerProcurementServiceSettingsBuilder =
     ConsumerProcurementServiceSettings.newBuilder();
 consumerProcurementServiceSettingsBuilder
     .getOrderSettings()
     .setRetrySettings(
         consumerProcurementServiceSettingsBuilder
             .getOrderSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConsumerProcurementServiceSettings consumerProcurementServiceSettings =
     consumerProcurementServiceSettingsBuilder.build();

ConsumerProcurementServiceSettings.Builder

Builder for ConsumerProcurementServiceSettings.

GetOrderRequest

Request message for ConsumerProcurementService.GetOrder

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.GetOrderRequest

GetOrderRequest.Builder

Request message for ConsumerProcurementService.GetOrder

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.GetOrderRequest

LineItem

A single item within an order.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItem

LineItem.Builder

A single item within an order.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItem

LineItemChange

A change made on a line item.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItemChange

LineItemChange.Builder

A change made on a line item.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItemChange

LineItemInfo

Line item information.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItemInfo

LineItemInfo.Builder

Line item information.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.LineItemInfo

ListOrdersRequest

Request message for ConsumerProcurementService.ListOrders.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.ListOrdersRequest

ListOrdersRequest.Builder

Request message for ConsumerProcurementService.ListOrders.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.ListOrdersRequest

ListOrdersResponse

Response message for ConsumerProcurementService.ListOrders.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.ListOrdersResponse

ListOrdersResponse.Builder

Response message for ConsumerProcurementService.ListOrders.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.ListOrdersResponse

Order

Represents a purchase made by a customer on Cloud Marketplace. Creating an order makes sure that both the Google backend systems as well as external service provider's systems (if needed) allow use of purchased products and ensures the appropriate billing events occur. An Order can be made against one Product with multiple add-ons (optional) or one Quote which might reference multiple products. Customers typically choose a price plan for each Product purchased when they create an order and can change their plan later, if the product allows.

Protobuf type google.cloud.commerce.consumer.procurement.v1alpha1.Order

Package com.google.cloud.commerce.consumer.procurement.v1alpha1 (0.4.0)

ConsumerProcurementServiceClient

Classes

Interfaces

Enums