Represents an EntitlementChange.
Package
@google-cloud/channelConstructors
(constructor)(properties)
constructor(properties?: google.cloud.channel.v1.IEntitlementChange);Constructs a new EntitlementChange.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEntitlementChange
Properties to set |
Properties
activationReason
public activationReason?: (google.cloud.channel.v1.EntitlementChange.ActivationReason|keyof typeof google.cloud.channel.v1.EntitlementChange.ActivationReason|null);EntitlementChange activationReason.
cancellationReason
public cancellationReason?: (google.cloud.channel.v1.EntitlementChange.CancellationReason|keyof typeof google.cloud.channel.v1.EntitlementChange.CancellationReason|null);EntitlementChange cancellationReason.
changeReason
public changeReason?: ("suspensionReason"|"cancellationReason"|"activationReason"|"otherChangeReason");EntitlementChange changeReason.
changeType
public changeType: (google.cloud.channel.v1.EntitlementChange.ChangeType|keyof typeof google.cloud.channel.v1.EntitlementChange.ChangeType);EntitlementChange changeType.
createTime
public createTime?: (google.protobuf.ITimestamp|null);EntitlementChange createTime.
entitlement
public entitlement: string;EntitlementChange entitlement.
offer
public offer: string;EntitlementChange offer.
operator
public operator: string;EntitlementChange operator.
operatorType
public operatorType: (google.cloud.channel.v1.EntitlementChange.OperatorType|keyof typeof google.cloud.channel.v1.EntitlementChange.OperatorType);EntitlementChange operatorType.
otherChangeReason
public otherChangeReason?: (string|null);EntitlementChange otherChangeReason.
parameters
public parameters: google.cloud.channel.v1.IParameter[];EntitlementChange parameters.
provisionedService
public provisionedService?: (google.cloud.channel.v1.IProvisionedService|null);EntitlementChange provisionedService.
suspensionReason
public suspensionReason?: (google.cloud.channel.v1.Entitlement.SuspensionReason|keyof typeof google.cloud.channel.v1.Entitlement.SuspensionReason|null);EntitlementChange suspensionReason.
Methods
create(properties)
public static create(properties?: google.cloud.channel.v1.IEntitlementChange): google.cloud.channel.v1.EntitlementChange;Creates a new EntitlementChange instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IEntitlementChange
Properties to set |
| Returns | |
|---|---|
| Type | Description |
EntitlementChange | EntitlementChange instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.channel.v1.EntitlementChange;Decodes an EntitlementChange 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 |
EntitlementChange | EntitlementChange |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.EntitlementChange;Decodes an EntitlementChange message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
EntitlementChange | EntitlementChange |
encode(message, writer)
public static encode(message: google.cloud.channel.v1.IEntitlementChange, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EntitlementChange message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEntitlementChange
EntitlementChange 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.IEntitlementChange, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified EntitlementChange message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IEntitlementChange
EntitlementChange 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.EntitlementChange;Creates an EntitlementChange 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 |
EntitlementChange | EntitlementChange |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for EntitlementChange
| 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 EntitlementChange to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.channel.v1.EntitlementChange, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an EntitlementChange message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
EntitlementChange
EntitlementChange |
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 EntitlementChange message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|