Cloud Commerce Consumer Procurement V1 API - Class Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::ServiceStub (v1.1.0)

Reference documentation and code samples for the Cloud Commerce Consumer Procurement V1 API class Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Rest::ServiceStub.

REST service stub for the ConsumerProcurementService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

Object

Methods

#cancel_order

def cancel_order(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the cancel_order REST call

Parameters

request_pb (::Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

(String)

#get_order

def get_order(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order

Baseline implementation for the get_order REST call

Parameters

request_pb (::Google::Cloud::Commerce::Consumer::Procurement::V1::GetOrderRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Commerce::Consumer::Procurement::V1::Order)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Commerce::Consumer::Procurement::V1::Order) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

(ServiceStub) — a new instance of ServiceStub

#list_orders

def list_orders(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersResponse

Baseline implementation for the list_orders REST call

Parameters

request_pb (::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersResponse) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#modify_order

def modify_order(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the modify_order REST call

Parameters

request_pb (::Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#place_order

def place_order(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the place_order REST call

Parameters

request_pb (::Google::Cloud::Commerce::Consumer::Procurement::V1::PlaceOrderRequest) — A request object representing the call parameters. Required.
options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)