Class protos.google.cloud.dialogflow.cx.v3.Webhook (2.12.1)

Represents a Webhook.

Package

@google-cloud/dialogflow-cx!

Constructors

(constructor)(properties)

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

Constructs a new Webhook.

Parameter

Name	Description
properties	`IWebhook` Properties to set

Properties

disabled

public disabled: boolean;

Webhook disabled.

Property Value

Type	Description
boolean

displayName

public displayName: string;

Webhook displayName.

Property Value

Type	Description
string

genericWebService

public genericWebService?: (google.cloud.dialogflow.cx.v3.Webhook.IGenericWebService|null);

Webhook genericWebService.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.Webhook.IGenericWebService\|null)

name

public name: string;

Webhook name.

Property Value

Type	Description
string

serviceDirectory

public serviceDirectory?: (google.cloud.dialogflow.cx.v3.Webhook.IServiceDirectoryConfig|null);

Webhook serviceDirectory.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.Webhook.IServiceDirectoryConfig\|null)

timeout

public timeout?: (google.protobuf.IDuration|null);

Webhook timeout.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

webhook

public webhook?: ("genericWebService"|"serviceDirectory");

Webhook webhook.

Property Value

Type	Description
("genericWebService"\|"serviceDirectory")

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IWebhook): google.cloud.dialogflow.cx.v3.Webhook;

Creates a new Webhook instance using the specified properties.

Parameter

Name	Description
properties	`IWebhook` Properties to set

Returns

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

decode(reader, length)

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

Decodes a Webhook 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.Webhook	Webhook

decodeDelimited(reader)

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

Decodes a Webhook 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.Webhook	Webhook

encode(message, writer)

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

Encodes the specified Webhook message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IWebhook` Webhook 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.Webhook;

Creates a Webhook 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.Webhook	Webhook

toJSON()

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

Converts this Webhook to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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