Constructor
new Entitlement(propertiesopt)
Constructs a new Entitlement.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.channel.v1.IEntitlement |
<optional> |
Properties to set |
- Implements:
-
- IEntitlement
Members
associationInfo
Entitlement associationInfo.
billingAccount
Entitlement billingAccount.
commitmentSettings
Entitlement commitmentSettings.
createTime
Entitlement createTime.
name
Entitlement name.
offer
Entitlement offer.
parameters
Entitlement parameters.
provisionedService
Entitlement provisionedService.
provisioningState
Entitlement provisioningState.
purchaseOrderId
Entitlement purchaseOrderId.
suspensionReasons
Entitlement suspensionReasons.
trialSettings
Entitlement trialSettings.
updateTime
Entitlement updateTime.
ProvisioningState
ProvisioningState enum.
Properties:
| Name | Type | Description |
|---|---|---|
PROVISIONING_STATE_UNSPECIFIED |
number |
PROVISIONING_STATE_UNSPECIFIED value |
ACTIVE |
number |
ACTIVE value |
SUSPENDED |
number |
SUSPENDED value |
SuspensionReason
SuspensionReason enum.
Properties:
| Name | Type | Description |
|---|---|---|
SUSPENSION_REASON_UNSPECIFIED |
number |
SUSPENSION_REASON_UNSPECIFIED value |
RESELLER_INITIATED |
number |
RESELLER_INITIATED value |
TRIAL_ENDED |
number |
TRIAL_ENDED value |
RENEWAL_WITH_TYPE_CANCEL |
number |
RENEWAL_WITH_TYPE_CANCEL value |
PENDING_TOS_ACCEPTANCE |
number |
PENDING_TOS_ACCEPTANCE value |
OTHER |
number |
OTHER value |
Methods
toJSON() → {Object.<string, *>}
Converts this Entitlement to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.channel.v1.Entitlement}
Creates a new Entitlement instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.channel.v1.IEntitlement |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.channel.v1.Entitlement |
Entitlement instance |
(static) decode(reader, lengthopt) → {google.cloud.channel.v1.Entitlement}
Decodes an Entitlement message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.channel.v1.Entitlement |
Entitlement |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.channel.v1.Entitlement}
Decodes an Entitlement message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.channel.v1.Entitlement |
Entitlement |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Entitlement message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.channel.v1.IEntitlement |
Entitlement message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Entitlement message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.channel.v1.IEntitlement |
Entitlement message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.channel.v1.Entitlement}
Creates an Entitlement message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.channel.v1.Entitlement |
Entitlement |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Entitlement
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from an Entitlement message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.channel.v1.Entitlement |
Entitlement |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies an Entitlement message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|