Cloud Commerce Consumer Procurement v1 API - Class ConsumerProcurementService.ConsumerProcurementServiceBase (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(ConsumerProcurementService), "BindService")]
public abstract class ConsumerProcurementService.ConsumerProcurementServiceBase

Reference documentation and code samples for the Cloud Commerce Consumer Procurement v1 API class ConsumerProcurementService.ConsumerProcurementServiceBase.

Base class for server-side implementations of ConsumerProcurementService

Inheritance

object > ConsumerProcurementService.ConsumerProcurementServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Commerce.Consumer.Procurement.V1

Assembly

Google.Cloud.Commerce.Consumer.Procurement.V1.dll

Methods

CancelOrder(CancelOrderRequest, ServerCallContext)

public virtual Task<Operation> CancelOrder(CancelOrderRequest request, ServerCallContext context)

Cancels an existing [Order][google.cloud.commerce.consumer.procurement.v1.Order]. Every product procured in the Order will be cancelled.

Parameters
Name	Description
request	CancelOrderRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetOrder(GetOrderRequest, ServerCallContext)

public virtual Task<Order> GetOrder(GetOrderRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetOrderRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOrder	The response to send back to the client (wrapped by a task).

ListOrders(ListOrdersRequest, ServerCallContext)

public virtual Task<ListOrdersResponse> ListOrders(ListOrdersRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListOrdersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListOrdersResponse	The response to send back to the client (wrapped by a task).

ModifyOrder(ModifyOrderRequest, ServerCallContext)

public virtual Task<Operation> ModifyOrder(ModifyOrderRequest request, ServerCallContext context)

Modifies an existing [Order][google.cloud.commerce.consumer.procurement.v1.Order] resource.

Parameters
Name	Description
request	ModifyOrderRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

PlaceOrder(PlaceOrderRequest, ServerCallContext)

public virtual Task<Operation> PlaceOrder(PlaceOrderRequest request, ServerCallContext context)

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

This API only supports GCP spend-based committed use discounts specified by GCP documentation.

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.v1.OrderState.ORDER_STATE_ACTIVE]. In case of failure, the order resource will be removed.

Parameters
Name	Description
request	PlaceOrderRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).