Class protos.google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput (3.4.2)

Represents a VirtualAgentOutput.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3.ConversationTurn.IVirtualAgentOutput);

Constructs a new VirtualAgentOutput.

Parameter
NameDescription
properties IVirtualAgentOutput

Properties to set

Properties

currentPage

public currentPage?: (google.cloud.dialogflow.cx.v3.IPage|null);

VirtualAgentOutput currentPage.

diagnosticInfo

public diagnosticInfo?: (google.protobuf.IStruct|null);

VirtualAgentOutput diagnosticInfo.

differences

public differences: google.cloud.dialogflow.cx.v3.ITestRunDifference[];

VirtualAgentOutput differences.

sessionParameters

public sessionParameters?: (google.protobuf.IStruct|null);

VirtualAgentOutput sessionParameters.

status

public status?: (google.rpc.IStatus|null);

VirtualAgentOutput status.

textResponses

public textResponses: google.cloud.dialogflow.cx.v3.ResponseMessage.IText[];

VirtualAgentOutput textResponses.

triggeredIntent

public triggeredIntent?: (google.cloud.dialogflow.cx.v3.IIntent|null);

VirtualAgentOutput triggeredIntent.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.ConversationTurn.IVirtualAgentOutput): google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput;

Creates a new VirtualAgentOutput instance using the specified properties.

Parameter
NameDescription
properties IVirtualAgentOutput

Properties to set

Returns
TypeDescription
google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

VirtualAgentOutput instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput;

Decodes a VirtualAgentOutput 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.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

VirtualAgentOutput

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput;

Decodes a VirtualAgentOutput 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.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

VirtualAgentOutput

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3.ConversationTurn.IVirtualAgentOutput, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VirtualAgentOutput message. Does not implicitly messages.

Parameters
NameDescription
message IVirtualAgentOutput

VirtualAgentOutput 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.dialogflow.cx.v3.ConversationTurn.IVirtualAgentOutput, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IVirtualAgentOutput

VirtualAgentOutput 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.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput;

Creates a VirtualAgentOutput 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.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

VirtualAgentOutput

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for VirtualAgentOutput

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.dialogflow.cx.v3.ConversationTurn.VirtualAgentOutput

VirtualAgentOutput

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