Class protos.google.pubsub.v1.ListTopicsRequest (2.17.0)

Represents a ListTopicsRequest.

Package

@google-cloud/pubsub!

Constructors

(constructor)(properties)

constructor(properties?: google.pubsub.v1.IListTopicsRequest);

Constructs a new ListTopicsRequest.

Parameter
NameDescription
properties google.pubsub.v1.IListTopicsRequest

Properties to set

Properties

pageSize

public pageSize: number;

ListTopicsRequest pageSize.

Property Value
TypeDescription
number

pageToken

public pageToken: string;

ListTopicsRequest pageToken.

Property Value
TypeDescription
string

project

public project: string;

ListTopicsRequest project.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.pubsub.v1.IListTopicsRequest): google.pubsub.v1.ListTopicsRequest;

Creates a new ListTopicsRequest instance using the specified properties.

Parameter
NameDescription
properties google.pubsub.v1.IListTopicsRequest

Properties to set

Returns
TypeDescription
google.pubsub.v1.ListTopicsRequest

ListTopicsRequest instance

decode(reader, length)

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

Decodes a ListTopicsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.pubsub.v1.ListTopicsRequest

ListTopicsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.pubsub.v1.ListTopicsRequest;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.pubsub.v1.ListTopicsRequest

ListTopicsRequest

encode(message, writer)

public static encode(message: google.pubsub.v1.IListTopicsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListTopicsRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.pubsub.v1.IListTopicsRequest

ListTopicsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.pubsub.v1.IListTopicsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message google.pubsub.v1.IListTopicsRequest

ListTopicsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.pubsub.v1.ListTopicsRequest;

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

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

Plain object

Returns
TypeDescription
google.pubsub.v1.ListTopicsRequest

ListTopicsRequest

toJSON()

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

Converts this ListTopicsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.pubsub.v1.ListTopicsRequest

ListTopicsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a ListTopicsRequest message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not