Google Cloud Commerce Consumer Procurement V1 Client - Class LineItemChange (0.2.3)

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

A change made on a line item.

Generated from protobuf message google.cloud.commerce.consumer.procurement.v1.LineItemChange

Namespace

Google \ Cloud \ Commerce \ Consumer \ Procurement \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ change_id string

Output only. Change ID. All changes made within one order update operation have the same change_id.
↳ change_type int

Required. Type of the change to make.
↳ old_line_item_info Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo

Output only. Line item info before the change.
↳ new_line_item_info Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo

Line item info after the change.
↳ change_state int

Output only. State of the change.
↳ state_reason string

Output only. Provider-supplied message explaining the LineItemChange's state. Mainly used to communicate progress and ETA for provisioning in the case of PENDING_APPROVAL, and to explain why the change request was denied or canceled in the case of REJECTED and CANCELED states.
↳ change_state_reason_type int

Output only. Predefined enum types for why this line item change is in current state. For example, a line item change's state could be LINE_ITEM_CHANGE_STATE_COMPLETED because of end-of-term expiration, immediate cancellation initiated by the user, or system-initiated cancellation.
↳ change_effective_time Google\Protobuf\Timestamp

Output only. A time at which the change became or will become (in case of pending change) effective.
↳ create_time Google\Protobuf\Timestamp

Output only. The time when change was initiated.
↳ update_time Google\Protobuf\Timestamp

Output only. The time when change was updated, e.g. approved/rejected by partners or cancelled by the user.

getChangeId

Output only. Change ID.

All changes made within one order update operation have the same change_id.

Returns
Type Description
string

setChangeId

Output only. Change ID.

All changes made within one order update operation have the same change_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getChangeType

Required. Type of the change to make.

Returns
Type Description
int

setChangeType

Required. Type of the change to make.

Parameter
Name Description
var int
Returns
Type Description
$this

getOldLineItemInfo

Output only. Line item info before the change.

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

hasOldLineItemInfo

clearOldLineItemInfo

setOldLineItemInfo

Output only. Line item info before the change.

Parameter
Name Description
var Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo
Returns
Type Description
$this

getNewLineItemInfo

Line item info after the change.

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

hasNewLineItemInfo

clearNewLineItemInfo

setNewLineItemInfo

Line item info after the change.

Parameter
Name Description
var Google\Cloud\Commerce\Consumer\Procurement\V1\LineItemInfo
Returns
Type Description
$this

getChangeState

Output only. State of the change.

Returns
Type Description
int

setChangeState

Output only. State of the change.

Parameter
Name Description
var int
Returns
Type Description
$this

getStateReason

Output only. Provider-supplied message explaining the LineItemChange's state. Mainly used to communicate progress and ETA for provisioning in the case of PENDING_APPROVAL, and to explain why the change request was denied or canceled in the case of REJECTED and CANCELED states.

Returns
Type Description
string

setStateReason

Output only. Provider-supplied message explaining the LineItemChange's state. Mainly used to communicate progress and ETA for provisioning in the case of PENDING_APPROVAL, and to explain why the change request was denied or canceled in the case of REJECTED and CANCELED states.

Parameter
Name Description
var string
Returns
Type Description
$this

getChangeStateReasonType

Output only. Predefined enum types for why this line item change is in current state. For example, a line item change's state could be LINE_ITEM_CHANGE_STATE_COMPLETED because of end-of-term expiration, immediate cancellation initiated by the user, or system-initiated cancellation.

Returns
Type Description
int

setChangeStateReasonType

Output only. Predefined enum types for why this line item change is in current state. For example, a line item change's state could be LINE_ITEM_CHANGE_STATE_COMPLETED because of end-of-term expiration, immediate cancellation initiated by the user, or system-initiated cancellation.

Parameter
Name Description
var int
Returns
Type Description
$this

getChangeEffectiveTime

Output only. A time at which the change became or will become (in case of pending change) effective.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasChangeEffectiveTime

clearChangeEffectiveTime

setChangeEffectiveTime

Output only. A time at which the change became or will become (in case of pending change) effective.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCreateTime

Output only. The time when change was initiated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when change was initiated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time when change was updated, e.g. approved/rejected by partners or cancelled by the user.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when change was updated, e.g. approved/rejected by partners or cancelled by the user.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this