Class protos.google.cloud.dataplex.v1.SearchEntriesResult (3.7.0)

Represents a SearchEntriesResult.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new SearchEntriesResult.

Parameter
NameDescription
properties ISearchEntriesResult

Properties to set

Properties

dataplexEntry

public dataplexEntry?: (google.cloud.dataplex.v1.IEntry|null);

SearchEntriesResult dataplexEntry.

description

public description: string;

SearchEntriesResult description.

displayName

public displayName: string;

SearchEntriesResult displayName.

entry

public entry: string;

SearchEntriesResult entry.

entryType

public entryType: string;

SearchEntriesResult entryType.

fullyQualifiedName

public fullyQualifiedName: string;

SearchEntriesResult fullyQualifiedName.

linkedResource

public linkedResource: string;

SearchEntriesResult linkedResource.

modifyTime

public modifyTime?: (google.protobuf.ITimestamp|null);

SearchEntriesResult modifyTime.

relativeResource

public relativeResource: string;

SearchEntriesResult relativeResource.

snippets

public snippets?: (google.cloud.dataplex.v1.SearchEntriesResult.ISnippets|null);

SearchEntriesResult snippets.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.ISearchEntriesResult): google.cloud.dataplex.v1.SearchEntriesResult;

Creates a new SearchEntriesResult instance using the specified properties.

Parameter
NameDescription
properties ISearchEntriesResult

Properties to set

Returns
TypeDescription
SearchEntriesResult

SearchEntriesResult instance

decode(reader, length)

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

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

SearchEntriesResult

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
SearchEntriesResult

SearchEntriesResult

encode(message, writer)

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

Encodes the specified SearchEntriesResult message. Does not implicitly messages.

Parameters
NameDescription
message ISearchEntriesResult

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

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

Parameters
NameDescription
message ISearchEntriesResult

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

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

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

Plain object

Returns
TypeDescription
SearchEntriesResult

SearchEntriesResult

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SearchEntriesResult

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message SearchEntriesResult

SearchEntriesResult

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