Flow

google.cloud.dialogflow.cx.v3. Flow

Represents a Flow.

Constructor

new Flow(propertiesopt)

Constructs a new Flow.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.cx.v3.IFlow <optional>

Properties to set

Implements:
  • IFlow

Members

advancedSettings

Flow advancedSettings.

description

Flow description.

displayName

Flow displayName.

eventHandlers

Flow eventHandlers.

knowledgeConnectorSettings

Flow knowledgeConnectorSettings.

name

Flow name.

nluSettings

Flow nluSettings.

transitionRouteGroups

Flow transitionRouteGroups.

transitionRoutes

Flow transitionRoutes.

Methods

toJSON() → {Object.<string, *>}

Converts this Flow to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.dialogflow.cx.v3.Flow}

Creates a new Flow instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.cx.v3.IFlow <optional>

Properties to set

Returns:
Type Description
google.cloud.dialogflow.cx.v3.Flow

Flow instance

(static) decode(reader, lengthopt) → {google.cloud.dialogflow.cx.v3.Flow}

Decodes a Flow message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.dialogflow.cx.v3.Flow

Flow

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.dialogflow.cx.v3.Flow}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.dialogflow.cx.v3.Flow

Flow

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Flow message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3.IFlow

Flow message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3.IFlow

Flow message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.dialogflow.cx.v3.Flow}

Creates a Flow message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.dialogflow.cx.v3.Flow

Flow

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Flow

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3.Flow

Flow

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Flow message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not