Class protos.google.cloud.dialogflow.cx.v3.QueryParameters (2.14.0)

Represents a QueryParameters.

Package

Constructors

(constructor)(properties)

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

Constructs a new QueryParameters.

Parameter

Name	Description
properties	`IQueryParameters` Properties to set

Properties

analyzeQueryTextSentiment

public analyzeQueryTextSentiment: boolean;

QueryParameters analyzeQueryTextSentiment.

currentPage

public currentPage: string;

QueryParameters currentPage.

disableWebhook

public disableWebhook: boolean;

QueryParameters disableWebhook.

flowVersions

public flowVersions: string[];

QueryParameters flowVersions.

geoLocation

public geoLocation?: (google.type.ILatLng|null);

QueryParameters geoLocation.

parameters

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

QueryParameters parameters.

payload

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

QueryParameters payload.

sessionEntityTypes

public sessionEntityTypes: google.cloud.dialogflow.cx.v3.ISessionEntityType[];

QueryParameters sessionEntityTypes.

timeZone

public timeZone: string;

QueryParameters timeZone.

webhookHeaders

public webhookHeaders: { [k: string]: string };

QueryParameters webhookHeaders.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IQueryParameters): google.cloud.dialogflow.cx.v3.QueryParameters;

Creates a new QueryParameters instance using the specified properties.

Parameter

Name	Description
properties	`IQueryParameters` Properties to set

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryParameters	QueryParameters instance

decode(reader, length)

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

Decodes a QueryParameters message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryParameters	QueryParameters

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryParameters	QueryParameters

encode(message, writer)

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

Encodes the specified QueryParameters message. Does not implicitly messages.

Parameters

Name	Description
message	`IQueryParameters` QueryParameters 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.IQueryParameters, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IQueryParameters` QueryParameters 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.QueryParameters;

Creates a QueryParameters 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
google.cloud.dialogflow.cx.v3.QueryParameters	QueryParameters

toJSON()

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

Converts this QueryParameters to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dialogflow.cx.v3.QueryParameters` QueryParameters
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 QueryParameters 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