Agent

google.cloud.dialogflow.cx.v3beta1. Agent

Represents an Agent.

Constructor

new Agent(propertiesopt)

Constructs a new Agent.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.cx.v3beta1.IAgent <optional>

Properties to set

Implements:
  • IAgent

Classes

AnswerFeedbackSettings
GenAppBuilderSettings
GitIntegrationSettings

Members

_genAppBuilderSettings

Agent _genAppBuilderSettings.

advancedSettings

Agent advancedSettings.

answerFeedbackSettings

Agent answerFeedbackSettings.

avatarUri

Agent avatarUri.

defaultLanguageCode

Agent defaultLanguageCode.

description

Agent description.

displayName

Agent displayName.

enableSpellCorrection

Agent enableSpellCorrection.

enableStackdriverLogging

Agent enableStackdriverLogging.

genAppBuilderSettings

Agent genAppBuilderSettings.

gitIntegrationSettings

Agent gitIntegrationSettings.

locked

Agent locked.

name

Agent name.

securitySettings

Agent securitySettings.

speechToTextSettings

Agent speechToTextSettings.

startFlow

Agent startFlow.

startPlaybook

Agent startPlaybook.

supportedLanguageCodes

Agent supportedLanguageCodes.

textToSpeechSettings

Agent textToSpeechSettings.

timeZone

Agent timeZone.

Methods

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

Converts this Agent to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.dialogflow.cx.v3beta1.Agent}

Creates a new Agent instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.dialogflow.cx.v3beta1.IAgent <optional>

Properties to set

Returns:
Type Description
google.cloud.dialogflow.cx.v3beta1.Agent

Agent instance

(static) decode(reader, lengthopt) → {google.cloud.dialogflow.cx.v3beta1.Agent}

Decodes an Agent 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.v3beta1.Agent

Agent

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.v3beta1.Agent}

Decodes an Agent 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.v3beta1.Agent

Agent

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 Agent message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3beta1.IAgent

Agent 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 Agent message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3beta1.IAgent

Agent 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.v3beta1.Agent}

Creates an Agent 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.v3beta1.Agent

Agent

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Agent

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 an Agent message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.dialogflow.cx.v3beta1.Agent

Agent

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an Agent 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