Class OrderService.OrderServiceClient
Client for OrderService
Inheritance
Inherited Members
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public class OrderService.OrderServiceClient : ClientBase<OrderService.OrderServiceClient>
Constructors
OrderServiceClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected OrderServiceClient()
OrderServiceClient(CallInvoker)
Creates a new client for OrderService that uses a custom CallInvoker
.
Declaration
public OrderServiceClient(CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
OrderServiceClient(ChannelBase)
Creates a new client for OrderService
Declaration
public OrderServiceClient(ChannelBase channel)
Parameters
Type | Name | Description |
---|---|---|
ChannelBase | channel | The channel to use to make remote calls. |
OrderServiceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected OrderServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration | The client configuration. |
Methods
GetOrder(GetOrderRequest, CallOptions)
API to retrieve an Order object.
Declaration
public virtual Order GetOrder(GetOrderRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetOrderRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
Order | The response received from the server. |
GetOrder(GetOrderRequest, Metadata, DateTime?, CancellationToken)
API to retrieve an Order object.
Declaration
public virtual Order GetOrder(GetOrderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
GetOrderRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
Order | The response received from the server. |
GetOrderAsync(GetOrderRequest, CallOptions)
API to retrieve an Order object.
Declaration
public virtual AsyncUnaryCall<Order> GetOrderAsync(GetOrderRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
GetOrderRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<Order> | The call object. |
GetOrderAsync(GetOrderRequest, Metadata, DateTime?, CancellationToken)
API to retrieve an Order object.
Declaration
public virtual AsyncUnaryCall<Order> GetOrderAsync(GetOrderRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
GetOrderRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<Order> | The call object. |
ListOrders(ListOrdersRequest, CallOptions)
API to retrieve a list of Order
objects.
Fields used for literal matching in filter string:
order_id
display_name
external_order_id
Declaration
public virtual ListOrdersResponse ListOrders(ListOrdersRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
ListOrdersRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
ListOrdersResponse | The response received from the server. |
ListOrders(ListOrdersRequest, Metadata, DateTime?, CancellationToken)
API to retrieve a list of Order
objects.
Fields used for literal matching in filter string:
order_id
display_name
external_order_id
Declaration
public virtual ListOrdersResponse ListOrders(ListOrdersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrdersRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
ListOrdersResponse | The response received from the server. |
ListOrdersAsync(ListOrdersRequest, CallOptions)
API to retrieve a list of Order
objects.
Fields used for literal matching in filter string:
order_id
display_name
external_order_id
Declaration
public virtual AsyncUnaryCall<ListOrdersResponse> ListOrdersAsync(ListOrdersRequest request, CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
ListOrdersRequest | request | The request to send to the server. |
CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<ListOrdersResponse> | The call object. |
ListOrdersAsync(ListOrdersRequest, Metadata, DateTime?, CancellationToken)
API to retrieve a list of Order
objects.
Fields used for literal matching in filter string:
order_id
display_name
external_order_id
Declaration
public virtual AsyncUnaryCall<ListOrdersResponse> ListOrdersAsync(ListOrdersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
ListOrdersRequest | request | The request to send to the server. |
Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
DateTime? | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AsyncUnaryCall<ListOrdersResponse> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override OrderService.OrderServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBase.ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
OrderService.OrderServiceClient |