Represents an Experiment.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3.IExperiment);Constructs a new Experiment.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExperiment
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Experiment createTime.
definition
public definition?: (google.cloud.dialogflow.cx.v3.Experiment.IDefinition|null);Experiment definition.
description
public description: string;Experiment description.
displayName
public displayName: string;Experiment displayName.
endTime
public endTime?: (google.protobuf.ITimestamp|null);Experiment endTime.
experimentLength
public experimentLength?: (google.protobuf.IDuration|null);Experiment experimentLength.
lastUpdateTime
public lastUpdateTime?: (google.protobuf.ITimestamp|null);Experiment lastUpdateTime.
name
public name: string;Experiment name.
result
public result?: (google.cloud.dialogflow.cx.v3.Experiment.IResult|null);Experiment result.
rolloutConfig
public rolloutConfig?: (google.cloud.dialogflow.cx.v3.IRolloutConfig|null);Experiment rolloutConfig.
rolloutFailureReason
public rolloutFailureReason: string;Experiment rolloutFailureReason.
rolloutState
public rolloutState?: (google.cloud.dialogflow.cx.v3.IRolloutState|null);Experiment rolloutState.
startTime
public startTime?: (google.protobuf.ITimestamp|null);Experiment startTime.
state
public state: (google.cloud.dialogflow.cx.v3.Experiment.State|keyof typeof google.cloud.dialogflow.cx.v3.Experiment.State);Experiment state.
variantsHistory
public variantsHistory: google.cloud.dialogflow.cx.v3.IVariantsHistory[];Experiment variantsHistory.
Methods
create(properties)
public static create(properties?: google.cloud.dialogflow.cx.v3.IExperiment): google.cloud.dialogflow.cx.v3.Experiment;Creates a new Experiment instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IExperiment
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow.cx.v3.Experiment | Experiment instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.Experiment;Decodes an Experiment message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow.cx.v3.Experiment | Experiment |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.Experiment;Decodes an Experiment message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow.cx.v3.Experiment | Experiment |
encode(message, writer)
public static encode(message: google.cloud.dialogflow.cx.v3.IExperiment, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Experiment message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExperiment
Experiment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.dialogflow.cx.v3.IExperiment, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Experiment message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IExperiment
Experiment message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3.Experiment;Creates an Experiment message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.cloud.dialogflow.cx.v3.Experiment | Experiment |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Experiment
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Experiment to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dialogflow.cx.v3.Experiment, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Experiment message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.dialogflow.cx.v3.Experiment
Experiment |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Experiment message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|