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

Represents a Webhook.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

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

Constructs a new Webhook.

Parameter
NameDescription
properties IWebhook

Properties to set

Properties

disabled

public disabled: boolean;

Webhook disabled.

displayName

public displayName: string;

Webhook displayName.

genericWebService

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

Webhook genericWebService.

name

public name: string;

Webhook name.

serviceDirectory

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

Webhook serviceDirectory.

timeout

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

Webhook timeout.

webhook

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

Webhook webhook.

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
NameDescription
properties IWebhook

Properties to set

Returns
TypeDescription
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
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.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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message IWebhook

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

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

Parameters
NameDescription
message IWebhook

Webhook 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.Webhook;

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

Webhook

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Webhook

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

Returns
TypeDescription
{ [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
NameDescription
message google.cloud.dialogflow.cx.v3.Webhook

Webhook

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