Class protos.google.cloud.dataqna.v1alpha.SuggestionInfo (1.0.8)

Represents a SuggestionInfo.

Package

@google-cloud/data-qna!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataqna.v1alpha.ISuggestionInfo);

Constructs a new SuggestionInfo.

Parameter
NameDescription
properties ISuggestionInfo

Properties to set

Properties

annotatedSuggestion

public annotatedSuggestion?: (google.cloud.dataqna.v1alpha.IAnnotatedString|null);

SuggestionInfo annotatedSuggestion.

Property Value
TypeDescription
(google.cloud.dataqna.v1alpha.IAnnotatedString|null)

queryMatches

public queryMatches: google.cloud.dataqna.v1alpha.SuggestionInfo.IMatchInfo[];

SuggestionInfo queryMatches.

Property Value
TypeDescription
google.cloud.dataqna.v1alpha.SuggestionInfo.IMatchInfo[]

Methods

create(properties)

public static create(properties?: google.cloud.dataqna.v1alpha.ISuggestionInfo): google.cloud.dataqna.v1alpha.SuggestionInfo;

Creates a new SuggestionInfo instance using the specified properties.

Parameter
NameDescription
properties ISuggestionInfo

Properties to set

Returns
TypeDescription
google.cloud.dataqna.v1alpha.SuggestionInfo

SuggestionInfo instance

decode(reader, length)

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

Decodes a SuggestionInfo message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dataqna.v1alpha.SuggestionInfo

SuggestionInfo

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dataqna.v1alpha.SuggestionInfo

SuggestionInfo

encode(message, writer)

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

Encodes the specified SuggestionInfo message. Does not implicitly messages.

Parameters
NameDescription
message ISuggestionInfo

SuggestionInfo 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.dataqna.v1alpha.ISuggestionInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ISuggestionInfo

SuggestionInfo 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.dataqna.v1alpha.SuggestionInfo;

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

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

Plain object

Returns
TypeDescription
google.cloud.dataqna.v1alpha.SuggestionInfo

SuggestionInfo

toJSON()

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

Converts this SuggestionInfo to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dataqna.v1alpha.SuggestionInfo

SuggestionInfo

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