Class protos.google.cloud.discoveryengine.v1alpha.ListEnginesResponse (1.9.0)

Represents a ListEnginesResponse.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

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

Constructs a new ListEnginesResponse.

Parameter
Name Description
properties IListEnginesResponse

Properties to set

Properties

engines

public engines: google.cloud.discoveryengine.v1alpha.IEngine[];

ListEnginesResponse engines.

nextPageToken

public nextPageToken: string;

ListEnginesResponse nextPageToken.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.IListEnginesResponse): google.cloud.discoveryengine.v1alpha.ListEnginesResponse;

Creates a new ListEnginesResponse instance using the specified properties.

Parameter
Name Description
properties IListEnginesResponse

Properties to set

Returns
Type Description
ListEnginesResponse

ListEnginesResponse instance

decode(reader, length)

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

Decodes a ListEnginesResponse message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ListEnginesResponse

ListEnginesResponse

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ListEnginesResponse

ListEnginesResponse

encode(message, writer)

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

Encodes the specified ListEnginesResponse message. Does not implicitly messages.

Parameters
Name Description
message IListEnginesResponse

ListEnginesResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
Name Description
message IListEnginesResponse

ListEnginesResponse message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.ListEnginesResponse;

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

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

Plain object

Returns
Type Description
ListEnginesResponse

ListEnginesResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ListEnginesResponse

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this ListEnginesResponse to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ListEnginesResponse

ListEnginesResponse

options $protobuf.IConversionOptions

Conversion options

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

Plain object

verify(message)

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

Verifies a ListEnginesResponse message.

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

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not