Class protos.google.cloud.dataplex.v1.SearchEntriesResponse (3.8.0)

Represents a SearchEntriesResponse.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.ISearchEntriesResponse);

Constructs a new SearchEntriesResponse.

Parameter
Name Description
properties ISearchEntriesResponse

Properties to set

Properties

nextPageToken

public nextPageToken: string;

SearchEntriesResponse nextPageToken.

results

public results: google.cloud.dataplex.v1.ISearchEntriesResult[];

SearchEntriesResponse results.

totalSize

public totalSize: number;

SearchEntriesResponse totalSize.

unreachable

public unreachable: string[];

SearchEntriesResponse unreachable.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.ISearchEntriesResponse): google.cloud.dataplex.v1.SearchEntriesResponse;

Creates a new SearchEntriesResponse instance using the specified properties.

Parameter
Name Description
properties ISearchEntriesResponse

Properties to set

Returns
Type Description
SearchEntriesResponse

SearchEntriesResponse instance

decode(reader, length)

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

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

SearchEntriesResponse

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SearchEntriesResponse

SearchEntriesResponse

encode(message, writer)

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

Encodes the specified SearchEntriesResponse message. Does not implicitly messages.

Parameters
Name Description
message ISearchEntriesResponse

SearchEntriesResponse 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.dataplex.v1.ISearchEntriesResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISearchEntriesResponse

SearchEntriesResponse 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.dataplex.v1.SearchEntriesResponse;

Creates a SearchEntriesResponse 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
SearchEntriesResponse

SearchEntriesResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchEntriesResponse

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SearchEntriesResponse

SearchEntriesResponse

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