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

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

Defined Under Namespace

Classes: Modification

Instance Attribute Summary collapse

Instance Attribute Details

#display_name::String

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

Returns:

  • (::String)

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 138

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

  # Modifications to make on the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. ID of the existing line item to make change to.
  #     Required when change type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL].
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeType]
  #     Required. Type of change to make.
  # @!attribute [rw] new_line_item_info
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
  #     Optional. The line item to update to.
  #     Required when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE].
  # @!attribute [rw] auto_renewal_behavior
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::AutoRenewalBehavior]
  #     Optional. Auto renewal behavior of the subscription for the update.
  #     Applied when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default
  #     config when this field is not specified.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag::String

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

Returns:

  • (::String)

    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.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 138

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

  # Modifications to make on the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. ID of the existing line item to make change to.
  #     Required when change type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL].
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeType]
  #     Required. Type of change to make.
  # @!attribute [rw] new_line_item_info
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
  #     Optional. The line item to update to.
  #     Required when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE].
  # @!attribute [rw] auto_renewal_behavior
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::AutoRenewalBehavior]
  #     Optional. Auto renewal behavior of the subscription for the update.
  #     Applied when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default
  #     config when this field is not specified.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#modifications::Array<::Google::Cloud::Commerce::Consumer::Procurement::V1::ModifyOrderRequest::Modification>

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

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 138

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

  # Modifications to make on the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. ID of the existing line item to make change to.
  #     Required when change type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL].
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeType]
  #     Required. Type of change to make.
  # @!attribute [rw] new_line_item_info
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
  #     Optional. The line item to update to.
  #     Required when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE].
  # @!attribute [rw] auto_renewal_behavior
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::AutoRenewalBehavior]
  #     Optional. Auto renewal behavior of the subscription for the update.
  #     Applied when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default
  #     config when this field is not specified.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name::String

Returns Required. Name of the order to update.

Returns:

  • (::String)

    Required. Name of the order to update.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'proto_docs/google/cloud/commerce/consumer/procurement/v1/procurement_service.rb', line 138

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

  # Modifications to make on the order.
  # @!attribute [rw] line_item_id
  #   @return [::String]
  #     Required. ID of the existing line item to make change to.
  #     Required when change type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CANCEL].
  # @!attribute [rw] change_type
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemChangeType]
  #     Required. Type of change to make.
  # @!attribute [rw] new_line_item_info
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::LineItemInfo]
  #     Optional. The line item to update to.
  #     Required when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_CREATE] or
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE].
  # @!attribute [rw] auto_renewal_behavior
  #   @return [::Google::Cloud::Commerce::Consumer::Procurement::V1::AutoRenewalBehavior]
  #     Optional. Auto renewal behavior of the subscription for the update.
  #     Applied when change_type is
  #     [LineItemChangeType.LINE_ITEM_CHANGE_TYPE_UPDATE]. Follows plan default
  #     config when this field is not specified.
  class Modification
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end