Class protos.google.cloud.channel.v1.ListSubscribersRequest

Represents a ListSubscribersRequest.

Package

@google-cloud/channel!

Constructors

(constructor)(properties)

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

Constructs a new ListSubscribersRequest.

Parameter
Type Name Description
google.cloud.channel.v1.IListSubscribersRequest properties

Properties to set

Properties

account

public account: string;

ListSubscribersRequest account.

Property Value
Type Description
string

pageSize

public pageSize: number;

ListSubscribersRequest pageSize.

Property Value
Type Description
number

pageToken

public pageToken: string;

ListSubscribersRequest pageToken.

Property Value
Type Description
string

Methods

create(properties)

public static create(properties?: google.cloud.channel.v1.IListSubscribersRequest): google.cloud.channel.v1.ListSubscribersRequest;

Creates a new ListSubscribersRequest instance using the specified properties.

Parameter
Type Name Description
google.cloud.channel.v1.IListSubscribersRequest properties

Properties to set
Returns
Type Description
google.cloud.channel.v1.ListSubscribersRequest

ListSubscribersRequest instance

decode(reader, length)

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

Decodes a ListSubscribersRequest message from the specified reader or buffer.

Parameters
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
number length

Message length if known beforehand
Returns
Type Description
google.cloud.channel.v1.ListSubscribersRequest

ListSubscribersRequest

decodeDelimited(reader)

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

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

Parameter
Type Name Description
($protobuf.Reader|Uint8Array) reader

Reader or buffer to decode from
Returns
Type Description
google.cloud.channel.v1.ListSubscribersRequest

ListSubscribersRequest

encode(message, writer)

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

Encodes the specified ListSubscribersRequest message. Does not implicitly messages.

Parameters
Type Name Description
google.cloud.channel.v1.IListSubscribersRequest message

ListSubscribersRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Type Name Description
google.cloud.channel.v1.IListSubscribersRequest message

ListSubscribersRequest message or plain object to encode
$protobuf.Writer writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
Type Name Description
{ [k: string]: any } object

Plain object
Returns
Type Description
google.cloud.channel.v1.ListSubscribersRequest

ListSubscribersRequest

toJSON()

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

Converts this ListSubscribersRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Type Name Description
google.cloud.channel.v1.ListSubscribersRequest message

ListSubscribersRequest
$protobuf.IConversionOptions options

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ListSubscribersRequest message.

Parameter
Type Name Description
{ [k: string]: any } message

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not