Class protos.google.cloud.filestore.v1.ListInstancesRequest (3.3.0)

Represents a ListInstancesRequest.

Package

@google-cloud/filestore

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.filestore.v1.IListInstancesRequest);

Constructs a new ListInstancesRequest.

Parameter
NameDescription
properties IListInstancesRequest

Properties to set

Properties

filter

public filter: string;

ListInstancesRequest filter.

orderBy

public orderBy: string;

ListInstancesRequest orderBy.

pageSize

public pageSize: number;

ListInstancesRequest pageSize.

pageToken

public pageToken: string;

ListInstancesRequest pageToken.

parent

public parent: string;

ListInstancesRequest parent.

Methods

create(properties)

public static create(properties?: google.cloud.filestore.v1.IListInstancesRequest): google.cloud.filestore.v1.ListInstancesRequest;

Creates a new ListInstancesRequest instance using the specified properties.

Parameter
NameDescription
properties IListInstancesRequest

Properties to set

Returns
TypeDescription
ListInstancesRequest

ListInstancesRequest instance

decode(reader, length)

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

Decodes a ListInstancesRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
ListInstancesRequest

ListInstancesRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ListInstancesRequest

ListInstancesRequest

encode(message, writer)

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

Encodes the specified ListInstancesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IListInstancesRequest

ListInstancesRequest 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.cloud.filestore.v1.IListInstancesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IListInstancesRequest

ListInstancesRequest 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.cloud.filestore.v1.ListInstancesRequest;

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

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

Plain object

Returns
TypeDescription
ListInstancesRequest

ListInstancesRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ListInstancesRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this ListInstancesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ListInstancesRequest

ListInstancesRequest

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 ListInstancesRequest 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