# Google Cloud Channel V1 Client - Class EntitlementChange (2.4.1)

2.4.1 (latest) 2.4.0 2.3.1 2.2.1 2.1.4 2.0.0 1.9.5 1.8.2 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.1 1.1.1 1.0.1 Reference documentation and code samples for the Google Cloud Channel V1 Client class EntitlementChange.

Change event entry for Entitlement order history

Generated from protobuf message `google.cloud.channel.v1.EntitlementChange`

## Namespace

Google \\ Cloud \\ Channel \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ suspension_reason` | `int` Suspension reason for the Entitlement. |
| `↳ cancellation_reason` | `int` Cancellation reason for the Entitlement. |
| `↳ activation_reason` | `int` The Entitlement's activation reason |
| `↳ other_change_reason` | `string` e.g. purchase_number change reason, entered by CRS. |
| `↳ entitlement` | `string` Required. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} |
| `↳ offer` | `string` Required. Resource name of the Offer at the time of change. Takes the form: accounts/{account_id}/offers/{offer_id}. |
| `↳ provisioned_service` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.ProvisionedService` Service provisioned for an Entitlement. |
| `↳ change_type` | `int` The change action type. |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The submitted time of the change. |
| `↳ operator_type` | `int` Operator type responsible for the change. |
| `↳ parameters` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Parameter>` Extended parameters, such as: purchase_order_number, gcp_details; internal_correlation_id, long_running_operation_id, order_id; etc. |
| `↳ operator` | `string` Human-readable identifier that shows what operator made a change. When the operator_type is RESELLER, this is the user's email address. For all other operator types, this is empty. |

### getSuspensionReason

Suspension reason for the Entitlement.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [SuspensionReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Entitlement.SuspensionReason). |

### hasSuspensionReason

### setSuspensionReason

Suspension reason for the Entitlement.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [SuspensionReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Entitlement.SuspensionReason). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCancellationReason

Cancellation reason for the Entitlement.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [CancellationReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.CancellationReason). |

### hasCancellationReason

### setCancellationReason

Cancellation reason for the Entitlement.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [CancellationReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.CancellationReason). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getActivationReason

The Entitlement's activation reason

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ActivationReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.ActivationReason). |

### hasActivationReason

### setActivationReason

The Entitlement's activation reason

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ActivationReason](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.ActivationReason). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOtherChangeReason

e.g. purchase_number change reason, entered by CRS.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### hasOtherChangeReason

### setOtherChangeReason

e.g. purchase_number change reason, entered by CRS.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEntitlement

Required. Resource name of an entitlement in the form:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setEntitlement

Required. Resource name of an entitlement in the form:
accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOffer

Required. Resource name of the Offer at the time of change.

Takes the form: accounts/{account_id}/offers/{offer_id}.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOffer

Required. Resource name of the Offer at the time of change.

Takes the form: accounts/{account_id}/offers/{offer_id}.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProvisionedService

Service provisioned for an Entitlement.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.ProvisionedService|null` |   |

### hasProvisionedService

### clearProvisionedService

### setProvisionedService

Service provisioned for an Entitlement.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.ProvisionedService` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getChangeType

The change action type.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ChangeType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.ChangeType). |

### setChangeType

The change action type.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ChangeType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.ChangeType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCreateTime

The submitted time of the change.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasCreateTime

### clearCreateTime

### setCreateTime

The submitted time of the change.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOperatorType

Operator type responsible for the change.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [OperatorType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.OperatorType). |

### setOperatorType

Operator type responsible for the change.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [OperatorType](https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.EntitlementChange.OperatorType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getParameters

Extended parameters, such as:
purchase_order_number, gcp_details;
internal_correlation_id, long_running_operation_id, order_id;
etc.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Parameter>` |   |

### setParameters

Extended parameters, such as:
purchase_order_number, gcp_details;
internal_correlation_id, long_running_operation_id, order_id;
etc.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-channel/latest/V1.Parameter>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOperator

Human-readable identifier that shows what operator made a change.

When the operator_type is RESELLER, this is the user's email address.
For all other operator types, this is empty.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setOperator

Human-readable identifier that shows what operator made a change.

When the operator_type is RESELLER, this is the user's email address.
For all other operator types, this is empty.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getChangeReason

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |