Class protos.google.cloud.channel.v1.ListPurchasableOffersRequest

Represents a ListPurchasableOffersRequest.

Package

@google-cloud/channel!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.channel.v1.IListPurchasableOffersRequest);

Constructs a new ListPurchasableOffersRequest.

Parameter
TypeNameDescription
IListPurchasableOffersRequestproperties

Properties to set

Properties

changeOfferPurchase

public changeOfferPurchase?: (google.cloud.channel.v1.ListPurchasableOffersRequest.IChangeOfferPurchase|null);

ListPurchasableOffersRequest changeOfferPurchase.

Property Value
TypeDescription
(google.cloud.channel.v1.ListPurchasableOffersRequest.IChangeOfferPurchase|null)

createEntitlementPurchase

public createEntitlementPurchase?: (google.cloud.channel.v1.ListPurchasableOffersRequest.ICreateEntitlementPurchase|null);

ListPurchasableOffersRequest createEntitlementPurchase.

Property Value
TypeDescription
(google.cloud.channel.v1.ListPurchasableOffersRequest.ICreateEntitlementPurchase|null)

customer

public customer: string;

ListPurchasableOffersRequest customer.

Property Value
TypeDescription
string

languageCode

public languageCode: string;

ListPurchasableOffersRequest languageCode.

Property Value
TypeDescription
string

pageSize

public pageSize: number;

ListPurchasableOffersRequest pageSize.

Property Value
TypeDescription
number

pageToken

public pageToken: string;

ListPurchasableOffersRequest pageToken.

Property Value
TypeDescription
string

purchaseOption

public purchaseOption?: ("createEntitlementPurchase"|"changeOfferPurchase");

ListPurchasableOffersRequest purchaseOption.

Property Value
TypeDescription
("createEntitlementPurchase"|"changeOfferPurchase")

Methods

create(properties)

public static create(properties?: google.cloud.channel.v1.IListPurchasableOffersRequest): google.cloud.channel.v1.ListPurchasableOffersRequest;

Creates a new ListPurchasableOffersRequest instance using the specified properties.

Parameter
TypeNameDescription
IListPurchasableOffersRequestproperties

Properties to set

Returns
TypeDescription
google.cloud.channel.v1.ListPurchasableOffersRequest

ListPurchasableOffersRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.channel.v1.ListPurchasableOffersRequest;

Decodes a ListPurchasableOffersRequest message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.channel.v1.ListPurchasableOffersRequest

ListPurchasableOffersRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.ListPurchasableOffersRequest;

Decodes a ListPurchasableOffersRequest message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.channel.v1.ListPurchasableOffersRequest

ListPurchasableOffersRequest

encode(message, writer)

public static encode(message: google.cloud.channel.v1.IListPurchasableOffersRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListPurchasableOffersRequest message. Does not implicitly messages.

Parameters
TypeNameDescription
IListPurchasableOffersRequestmessage

ListPurchasableOffersRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.channel.v1.IListPurchasableOffersRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListPurchasableOffersRequest message, length delimited. Does not implicitly messages.

Parameters
TypeNameDescription
IListPurchasableOffersRequestmessage

ListPurchasableOffersRequest message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.channel.v1.ListPurchasableOffersRequest;

Creates a ListPurchasableOffersRequest message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.channel.v1.ListPurchasableOffersRequest

ListPurchasableOffersRequest

toJSON()

public toJSON(): { [k: string]: any };

Converts this ListPurchasableOffersRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.channel.v1.ListPurchasableOffersRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a ListPurchasableOffersRequest message. Also converts values to other types if specified.

Parameters
TypeNameDescription
google.cloud.channel.v1.ListPurchasableOffersRequestmessage

ListPurchasableOffersRequest

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a ListPurchasableOffersRequest message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not