Google Cloud Commerce Consumer Procurement V1 Client - Class Modification (1.2.2)

Reference documentation and code samples for the Google Cloud Commerce Consumer Procurement V1 Client class Modification.

Modifications to make on the order.

Generated from protobuf message google.cloud.commerce.consumer.procurement.v1.ModifyOrderRequest.Modification

Namespace

Google \ Cloud \ Commerce \ Consumer \ Procurement \ V1 \ ModifyOrderRequest

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ line_item_id`	`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].
`↳ change_type`	`int` Required. Type of change to make.
`↳ new_line_item_info`	`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].
`↳ auto_renewal_behavior`	`int` 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.

getLineItemId

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

Returns
Type	Description
`string`

setLineItemId

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getChangeType

Required. Type of change to make.

Returns
Type	Description
`int`	Enum of type LineItemChangeType.

setChangeType

Required. Type of change to make.

Parameter
Name	Description
`var`	`int` Enum of type LineItemChangeType.

Returns
Type	Description
`$this`

getNewLineItemInfo

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

Returns
Type	Description
`Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo\|null`

hasNewLineItemInfo

clearNewLineItemInfo

setNewLineItemInfo