Class protos.google.cloud.discoveryengine.v1.Answer (1.9.0)

Represents an Answer.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1.IAnswer);

Constructs a new Answer.

Parameter
Name Description
properties IAnswer

Properties to set

Properties

answerSkippedReasons

public answerSkippedReasons: google.cloud.discoveryengine.v1.Answer.AnswerSkippedReason[];

Answer answerSkippedReasons.

answerText

public answerText: string;

Answer answerText.

citations

public citations: google.cloud.discoveryengine.v1.Answer.ICitation[];

Answer citations.

completeTime

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

Answer completeTime.

createTime

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

Answer createTime.

name

public name: string;

Answer name.

queryUnderstandingInfo

public queryUnderstandingInfo?: (google.cloud.discoveryengine.v1.Answer.IQueryUnderstandingInfo|null);

Answer queryUnderstandingInfo.

references

public references: google.cloud.discoveryengine.v1.Answer.IReference[];

Answer references.

relatedQuestions

public relatedQuestions: string[];

Answer relatedQuestions.

state

public state: (google.cloud.discoveryengine.v1.Answer.State|keyof typeof google.cloud.discoveryengine.v1.Answer.State);

Answer state.

steps

public steps: google.cloud.discoveryengine.v1.Answer.IStep[];

Answer steps.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1.IAnswer): google.cloud.discoveryengine.v1.Answer;

Creates a new Answer instance using the specified properties.

Parameter
Name Description
properties IAnswer

Properties to set

Returns
Type Description
Answer

Answer instance

decode(reader, length)

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

Decodes an Answer 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
Answer

Answer

decodeDelimited(reader)

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

Decodes an Answer message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Answer

Answer

encode(message, writer)

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

Encodes the specified Answer message. Does not implicitly messages.

Parameters
Name Description
message IAnswer

Answer 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.v1.IAnswer, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IAnswer

Answer 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.v1.Answer;

Creates an Answer 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
Answer

Answer

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Answer

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Answer

Answer

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 an Answer 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