Class: Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb

Overview

Client for the ConsumerProcurementService service.

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#billing_account_path, #offer_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ConsumerProcurementService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ConsumerProcurementService client.

Yield Parameters:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 146

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/commerce/consumer/procurement/v1/procurement_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @consumer_procurement_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @consumer_procurement_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



209
210
211
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 209

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ConsumerProcurementService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ConsumerProcurementService clients
::Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 72

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Commerce", "Consumer", "Procurement", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.place_order.timeout = 60.0

    default_config.rpcs.get_order.timeout = 60.0
    default_config.rpcs.get_order.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_orders.timeout = 60.0
    default_config.rpcs.list_orders.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_order(request, options = nil) ⇒ ::Gapic::Operation #cancel_order(name: nil, etag: nil, cancellation_policy: nil) ⇒ ::Gapic::Operation

Cancels an existing Order. Every product procured in the Order will be cancelled.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest.new

# Call the cancel_order method.
result = client.cancel_order request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #cancel_order(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to cancel_order via a request object, either of type Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #cancel_order(name: nil, etag: nil, cancellation_policy: nil) ⇒ ::Gapic::Operation

    Pass arguments to cancel_order via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The resource name of the order.

    • etag (::String) (defaults to: nil) —

      Optional. The weak etag, which can be optionally populated, of the order that this cancel request is based on. Validation checking will only happen if the invoker supplies this field.

    • cancellation_policy (::Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest::CancellationPolicy) (defaults to: nil) —

      Optional. Cancellation policy of this request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 706

def cancel_order request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_order.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Commerce::Consumer::Procurement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_order.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_order.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @consumer_procurement_service_stub.call_rpc :cancel_order, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the ConsumerProcurementService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



116
117
118
119
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 116

def configure
  yield @config if block_given?
  @config
end

#get_order(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order #get_order(name: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order

Returns the requested Order resource.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::GetOrderRequest.new

# Call the get_order method.
result = client.get_order request

# The returned object is of type Google::Cloud::Commerce::Consumer::Procurement::V1::Order.
p result

Overloads:

  • #get_order(request, options = nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order

    Pass arguments to get_order via a request object, either of type GetOrderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::GetOrderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_order(name: nil) ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order

    Pass arguments to get_order via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the order to retrieve.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 383

def get_order request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::GetOrderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_order.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Commerce::Consumer::Procurement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_order.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_order.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @consumer_procurement_service_stub.call_rpc :get_order, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_orders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order> #list_orders(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order>

Lists Order resources that the user has access to, within the scope of the parent resource.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersRequest.new

# Call the list_orders method.
result = client.list_orders request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Commerce::Consumer::Procurement::V1::Order.
  p item
end

Overloads:

  • #list_orders(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order>

    Pass arguments to list_orders via a request object, either of type ListOrdersRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_orders(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Commerce::Consumer::Procurement::V1::Order>

    Pass arguments to list_orders via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource to query for orders. This field has the form billingAccounts/{billing-account-id}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of entries requested. The default page size is 25 and the maximum page size is 200.

    • page_token (::String) (defaults to: nil) —

      The token for fetching the next page.

    • filter (::String) (defaults to: nil) —

      Filter that you can use to limit the list request.

      A query string that can match a selected set of attributes with string values. For example, display_name=abc. Supported query attributes are

      • display_name

      If the query contains special characters other than letters, underscore, or digits, the phrase must be quoted with double quotes. For example, display_name="foo:bar", where the display name needs to be quoted because it contains special character colon.

      Queries can be combined with OR, and NOT to form more complex queries. You can also group them to force a desired evaluation order. For example, display_name=abc OR display_name=def.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 498

def list_orders request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::ListOrdersRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_orders.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Commerce::Consumer::Procurement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_orders.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_orders.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @consumer_procurement_service_stub.call_rpc :list_orders, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @consumer_procurement_service_stub, :list_orders, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


216
217
218
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 216

def logger
  @consumer_procurement_service_stub.logger
end

#modify_order(request, options = nil) ⇒ ::Gapic::Operation #modify_order(name: nil, modifications: nil, display_name: nil, etag: nil) ⇒ ::Gapic::Operation

Modifies an existing Order resource.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest.new

# Call the modify_order method.
result = client.modify_order request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #modify_order(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to modify_order via a request object, either of type ModifyOrderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #modify_order(name: nil, modifications: nil, display_name: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to modify_order via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the order to update.

    • modifications (::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest::Modification, ::Hash>) (defaults to: nil) —

      Optional. Modifications for an existing Order created by an Offer. Required when Offer based Order is being modified, except for when going from an offer to a public plan.

    • display_name (::String) (defaults to: nil) —

      Optional. Updated display name of the order, leave as empty if you do not want to update current display name.

    • etag (::String) (defaults to: nil) —

      Optional. The weak etag, which can be optionally populated, of the order that this modify request is based on. Validation checking will only happen if the invoker supplies this field.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 604

def modify_order request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.modify_order.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Commerce::Consumer::Procurement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.modify_order.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.modify_order.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @consumer_procurement_service_stub.call_rpc :modify_order, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#place_order(request, options = nil) ⇒ ::Gapic::Operation #place_order(parent: nil, display_name: nil, line_item_info: nil, request_id: nil) ⇒ ::Gapic::Operation

Creates a new 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.

Examples:

Basic example

require "google/cloud/commerce/consumer/procurement/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Commerce::Consumer::Procurement::V1::ConsumerProcurementService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Commerce::Consumer::Procurement::V1::PlaceOrderRequest.new

# Call the place_order method.
result = client.place_order request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #place_order(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to place_order via a request object, either of type PlaceOrderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Commerce::Consumer::Procurement::V1::PlaceOrderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #place_order(parent: nil, display_name: nil, line_item_info: nil, request_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to place_order via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The resource name of the parent resource. This field has the form billingAccounts/{billing-account-id}.

    • display_name (::String) (defaults to: nil) —

      Required. The user-specified name of the order being placed.

    • line_item_info (::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo, ::Hash>) (defaults to: nil) —

      Optional. Places order for offer. Required when an offer-based order is being placed.

    • request_id (::String) (defaults to: nil) —

      Optional. A unique identifier for this request. The server will ignore subsequent requests that provide a duplicate request ID for at least 24 hours after the first request.

      The request ID must be a valid UUID.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 295

def place_order request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Commerce::Consumer::Procurement::V1::PlaceOrderRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.place_order.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Commerce::Consumer::Procurement::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.place_order.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.place_order.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @consumer_procurement_service_stub.call_rpc :place_order, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/cloud/commerce/consumer/procurement/v1/consumer_procurement_service/client.rb', line 126

def universe_domain
  @consumer_procurement_service_stub.universe_domain
end