Represents an Entitlement.
Package
@google-cloud/channel!Constructors
(constructor)(properties)
constructor(properties?: google.cloud.channel.v1.IEntitlement);
Constructs a new Entitlement.
Type | Name | Description |
---|---|---|
IEntitlement | properties |
Properties to set |
Properties
associationInfo
public associationInfo?: (google.cloud.channel.v1.IAssociationInfo|null);
Entitlement associationInfo.
Type | Description |
---|---|
(google.cloud.channel.v1.IAssociationInfo|null) |
commitmentSettings
public commitmentSettings?: (google.cloud.channel.v1.ICommitmentSettings|null);
Entitlement commitmentSettings.
Type | Description |
---|---|
(google.cloud.channel.v1.ICommitmentSettings|null) |
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Entitlement createTime.
Type | Description |
---|---|
(google.protobuf.ITimestamp|null) |
name
public name: string;
Entitlement name.
Type | Description |
---|---|
string |
offer
public offer: string;
Entitlement offer.
Type | Description |
---|---|
string |
parameters
public parameters: google.cloud.channel.v1.IParameter[];
Entitlement parameters.
Type | Description |
---|---|
google.cloud.channel.v1.IParameter[] |
provisionedService
public provisionedService?: (google.cloud.channel.v1.IProvisionedService|null);
Entitlement provisionedService.
Type | Description |
---|---|
(google.cloud.channel.v1.IProvisionedService|null) |
provisioningState
public provisioningState: (google.cloud.channel.v1.Entitlement.ProvisioningState|keyof typeof google.cloud.channel.v1.Entitlement.ProvisioningState);
Entitlement provisioningState.
Type | Description |
---|---|
(google.cloud.channel.v1.Entitlement.ProvisioningState|keyof typeof google.cloud.channel.v1.Entitlement.ProvisioningState) |
purchaseOrderId
public purchaseOrderId: string;
Entitlement purchaseOrderId.
Type | Description |
---|---|
string |
suspensionReasons
public suspensionReasons: google.cloud.channel.v1.Entitlement.SuspensionReason[];
Entitlement suspensionReasons.
Type | Description |
---|---|
google.cloud.channel.v1.Entitlement.SuspensionReason[] |
trialSettings
public trialSettings?: (google.cloud.channel.v1.ITrialSettings|null);
Entitlement trialSettings.
Type | Description |
---|---|
(google.cloud.channel.v1.ITrialSettings|null) |
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);
Entitlement updateTime.
Type | Description |
---|---|
(google.protobuf.ITimestamp|null) |
Methods
create(properties)
public static create(properties?: google.cloud.channel.v1.IEntitlement): google.cloud.channel.v1.Entitlement;
Creates a new Entitlement instance using the specified properties.
Type | Name | Description |
---|---|---|
IEntitlement | properties |
Properties to set |
Type | Description |
---|---|
google.cloud.channel.v1.Entitlement | Entitlement instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.channel.v1.Entitlement;
Decodes an Entitlement message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.cloud.channel.v1.Entitlement | Entitlement |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.Entitlement;
Decodes an Entitlement message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.cloud.channel.v1.Entitlement | Entitlement |
encode(message, writer)
public static encode(message: google.cloud.channel.v1.IEntitlement, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Entitlement message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IEntitlement | message |
Entitlement message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.channel.v1.IEntitlement, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Entitlement message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IEntitlement | message |
Entitlement message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.channel.v1.Entitlement;
Creates an Entitlement message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.cloud.channel.v1.Entitlement | Entitlement |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Entitlement to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.channel.v1.Entitlement, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an Entitlement message. Also converts values to other types if specified.
Type | Name | Description |
---|---|---|
google.cloud.channel.v1.Entitlement | message |
Entitlement |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies an Entitlement message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|