Class protos.google.cloud.discoveryengine.v1alpha.ListEnginesRequest (1.7.0)

Represents a ListEnginesRequest.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.IListEnginesRequest);

Constructs a new ListEnginesRequest.

Parameter
NameDescription
properties IListEnginesRequest

Properties to set

Properties

filter

public filter: string;

ListEnginesRequest filter.

pageSize

public pageSize: number;

ListEnginesRequest pageSize.

pageToken

public pageToken: string;

ListEnginesRequest pageToken.

parent

public parent: string;

ListEnginesRequest parent.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.IListEnginesRequest): google.cloud.discoveryengine.v1alpha.ListEnginesRequest;

Creates a new ListEnginesRequest instance using the specified properties.

Parameter
NameDescription
properties IListEnginesRequest

Properties to set

Returns
TypeDescription
ListEnginesRequest

ListEnginesRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.ListEnginesRequest;

Decodes a ListEnginesRequest 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
ListEnginesRequest

ListEnginesRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.ListEnginesRequest;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
ListEnginesRequest

ListEnginesRequest

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.IListEnginesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ListEnginesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IListEnginesRequest

ListEnginesRequest 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.discoveryengine.v1alpha.IListEnginesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IListEnginesRequest

ListEnginesRequest 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.discoveryengine.v1alpha.ListEnginesRequest;

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

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

Plain object

Returns
TypeDescription
ListEnginesRequest

ListEnginesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListEnginesRequest

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 ListEnginesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message ListEnginesRequest

ListEnginesRequest

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