Class protos.google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument (1.5.0)

Represents a MatchingDocument.

Package

@google-cloud/contentwarehouse

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.contentwarehouse.v1.SearchDocumentsResponse.IMatchingDocument);

Constructs a new MatchingDocument.

Parameter
NameDescription
properties IMatchingDocument

Properties to set

Properties

document

public document?: (google.cloud.contentwarehouse.v1.IDocument|null);

MatchingDocument document.

matchedTokenPageIndices

public matchedTokenPageIndices: (number|Long|string)[];

MatchingDocument matchedTokenPageIndices.

qaResult

public qaResult?: (google.cloud.contentwarehouse.v1.IQAResult|null);

MatchingDocument qaResult.

searchTextSnippet

public searchTextSnippet: string;

MatchingDocument searchTextSnippet.

Methods

create(properties)

public static create(properties?: google.cloud.contentwarehouse.v1.SearchDocumentsResponse.IMatchingDocument): google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument;

Creates a new MatchingDocument instance using the specified properties.

Parameter
NameDescription
properties IMatchingDocument

Properties to set

Returns
TypeDescription
MatchingDocument

MatchingDocument instance

decode(reader, length)

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

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

MatchingDocument

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
MatchingDocument

MatchingDocument

encode(message, writer)

public static encode(message: google.cloud.contentwarehouse.v1.SearchDocumentsResponse.IMatchingDocument, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MatchingDocument message. Does not implicitly messages.

Parameters
NameDescription
message IMatchingDocument

MatchingDocument 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.contentwarehouse.v1.SearchDocumentsResponse.IMatchingDocument, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMatchingDocument

MatchingDocument 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.contentwarehouse.v1.SearchDocumentsResponse.MatchingDocument;

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

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

Plain object

Returns
TypeDescription
MatchingDocument

MatchingDocument

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MatchingDocument

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message MatchingDocument

MatchingDocument

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