Experiment

google.cloud.dialogflow.cx.v3. Experiment

Represents an Experiment.

Constructor

new Experiment(propertiesopt)

Constructs a new Experiment.

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

Properties to set

Implements:
  • IExperiment

Classes

Definition
Result

Members

createTime

Experiment createTime.

definition

Experiment definition.

description

Experiment description.

displayName

Experiment displayName.

endTime

Experiment endTime.

experimentLength

Experiment experimentLength.

lastUpdateTime

Experiment lastUpdateTime.

name

Experiment name.

result

Experiment result.

rolloutConfig

Experiment rolloutConfig.

rolloutFailureReason

Experiment rolloutFailureReason.

rolloutState

Experiment rolloutState.

startTime

Experiment startTime.

state

Experiment state.

variantsHistory

Experiment variantsHistory.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

DRAFT number

DRAFT value

RUNNING number

RUNNING value

DONE number

DONE value

ROLLOUT_FAILED number

ROLLOUT_FAILED value

Methods

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

Converts this Experiment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Experiment instance using the specified properties.

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

Properties to set

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

Experiment instance

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

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

Experiment

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

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

Experiment

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

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

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

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

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

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

Experiment

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Experiment

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

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

Experiment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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