Represents an Entitlement.
Package
@google-cloud/channelConstructors
(constructor)(properties)
constructor(properties?: google.cloud.channel.v1.IEntitlement);Constructs a new Entitlement.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEntitlement
Properties to set |
Properties
associationInfo
public associationInfo?: (google.cloud.channel.v1.IAssociationInfo|null);Entitlement associationInfo.
billingAccount
public billingAccount: string;Entitlement billingAccount.
commitmentSettings
public commitmentSettings?: (google.cloud.channel.v1.ICommitmentSettings|null);Entitlement commitmentSettings.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Entitlement createTime.
name
public name: string;Entitlement name.
offer
public offer: string;Entitlement offer.
parameters
public parameters: google.cloud.channel.v1.IParameter[];Entitlement parameters.
provisionedService
public provisionedService?: (google.cloud.channel.v1.IProvisionedService|null);Entitlement provisionedService.
provisioningState
public provisioningState: (google.cloud.channel.v1.Entitlement.ProvisioningState|keyof typeof google.cloud.channel.v1.Entitlement.ProvisioningState);Entitlement provisioningState.
purchaseOrderId
public purchaseOrderId: string;Entitlement purchaseOrderId.
suspensionReasons
public suspensionReasons: google.cloud.channel.v1.Entitlement.SuspensionReason[];Entitlement suspensionReasons.
trialSettings
public trialSettings?: (google.cloud.channel.v1.ITrialSettings|null);Entitlement trialSettings.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Entitlement updateTime.
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.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEntitlement
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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.
| Parameters | |
|---|---|
| Name | Description |
message |
IEntitlement
Entitlement message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
message |
IEntitlement
Entitlement message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| 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.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Entitlement | Entitlement |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Entitlement
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Entitlement to JSON.
| Returns | |
|---|---|
| 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.
| Parameters | |
|---|---|
| Name | Description |
message |
Entitlement
Entitlement |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Entitlement message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|