Class protos.google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals (4.9.0)

Represents a DataStoreConnectionSignals.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

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

Constructs a new DataStoreConnectionSignals.

Parameter
Name Description
properties IDataStoreConnectionSignals

Properties to set

Properties

answer

public answer: string;

DataStoreConnectionSignals answer.

answerGenerationModelCallSignals

public answerGenerationModelCallSignals?: (google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.IAnswerGenerationModelCallSignals|null);

DataStoreConnectionSignals answerGenerationModelCallSignals.

answerParts

public answerParts: google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.IAnswerPart[];

DataStoreConnectionSignals answerParts.

citedSnippets

public citedSnippets: google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.ICitedSnippet[];

DataStoreConnectionSignals citedSnippets.

groundingSignals

public groundingSignals?: (google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.IGroundingSignals|null);

DataStoreConnectionSignals groundingSignals.

rewriterModelCallSignals

public rewriterModelCallSignals?: (google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.IRewriterModelCallSignals|null);

DataStoreConnectionSignals rewriterModelCallSignals.

rewrittenQuery

public rewrittenQuery: string;

DataStoreConnectionSignals rewrittenQuery.

safetySignals

public safetySignals?: (google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.ISafetySignals|null);

DataStoreConnectionSignals safetySignals.

searchSnippets

public searchSnippets: google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals.ISearchSnippet[];

DataStoreConnectionSignals searchSnippets.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IDataStoreConnectionSignals): google.cloud.dialogflow.cx.v3.DataStoreConnectionSignals;

Creates a new DataStoreConnectionSignals instance using the specified properties.

Parameter
Name Description
properties IDataStoreConnectionSignals

Properties to set

Returns
Type Description
DataStoreConnectionSignals

DataStoreConnectionSignals instance

decode(reader, length)

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

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

DataStoreConnectionSignals

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DataStoreConnectionSignals

DataStoreConnectionSignals

encode(message, writer)

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

Encodes the specified DataStoreConnectionSignals message. Does not implicitly messages.

Parameters
Name Description
message IDataStoreConnectionSignals

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

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

Parameters
Name Description
message IDataStoreConnectionSignals

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

Creates a DataStoreConnectionSignals 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
DataStoreConnectionSignals

DataStoreConnectionSignals

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DataStoreConnectionSignals

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DataStoreConnectionSignals

DataStoreConnectionSignals

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 a DataStoreConnectionSignals 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