Example

google.cloud.dialogflow.cx.v3beta1. Example

Represents an Example.

Constructor

new Example(propertiesopt)

Constructs a new Example.

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

Properties to set

Implements:
  • IExample

Members

actions

Example actions.

conversationState

Example conversationState.

createTime

Example createTime.

description

Example description.

displayName

Example displayName.

languageCode

Example languageCode.

name

Example name.

playbookInput

Example playbookInput.

playbookOutput

Example playbookOutput.

tokenCount

Example tokenCount.

updateTime

Example updateTime.

Methods

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

Converts this Example to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Example instance using the specified properties.

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

Properties to set

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

Example instance

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

Decodes an Example 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.Example

Example

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.Example}

Decodes an Example 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.Example

Example

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

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

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

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

Example 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.Example}

Creates an Example 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.Example

Example

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Example

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

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

Example

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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