Class: Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb

Overview

Request message for .

Defined Under Namespace

Modules: CancellationPolicy

Instance Attribute Summary collapse

Instance Attribute Details

#cancellation_policy ⇒ ::Google::Cloud::Commerce::Consumer::Procurement::V1::CancelOrderRequest::CancellationPolicy

Returns Optional. Cancellation policy of this request.

Returns:



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 190

class CancelOrderRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the cancellation policy the customer uses to cancel the order.
  module CancellationPolicy
    # If unspecified, cancellation will try to cancel the order, if order
    # cannot be immediately cancelled, auto renewal will be turned off.
    # However, caller should avoid using the value as it will yield a
    # non-deterministic result. This is still supported mainly to maintain
    # existing integrated usages and ensure backwards compatibility.
    CANCELLATION_POLICY_UNSPECIFIED = 0

    # Request will cancel the whole order immediately, if order cannot be
    # immediately cancelled, the request will fail.
    CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1

    # Request will cancel the auto renewal, if order is not subscription based,
    # the request will fail.
    CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2
  end
end

#etag ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 190

class CancelOrderRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the cancellation policy the customer uses to cancel the order.
  module CancellationPolicy
    # If unspecified, cancellation will try to cancel the order, if order
    # cannot be immediately cancelled, auto renewal will be turned off.
    # However, caller should avoid using the value as it will yield a
    # non-deterministic result. This is still supported mainly to maintain
    # existing integrated usages and ensure backwards compatibility.
    CANCELLATION_POLICY_UNSPECIFIED = 0

    # Request will cancel the whole order immediately, if order cannot be
    # immediately cancelled, the request will fail.
    CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1

    # Request will cancel the auto renewal, if order is not subscription based,
    # the request will fail.
    CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2
  end
end

#name ⇒ ::String

Returns Required. The resource name of the order.

Returns:

  • (::String) —

    Required. The resource name of the order.



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 190

class CancelOrderRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the cancellation policy the customer uses to cancel the order.
  module CancellationPolicy
    # If unspecified, cancellation will try to cancel the order, if order
    # cannot be immediately cancelled, auto renewal will be turned off.
    # However, caller should avoid using the value as it will yield a
    # non-deterministic result. This is still supported mainly to maintain
    # existing integrated usages and ensure backwards compatibility.
    CANCELLATION_POLICY_UNSPECIFIED = 0

    # Request will cancel the whole order immediately, if order cannot be
    # immediately cancelled, the request will fail.
    CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1

    # Request will cancel the auto renewal, if order is not subscription based,
    # the request will fail.
    CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2
  end
end