Class Environment.Builder (0.13.1) 

public static final class Environment.Builder extends GeneratedMessageV3.Builder<Environment.Builder> implements EnvironmentOrBuilder

Represents an environment for an agent. You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for testing, development, production, etc.

Protobuf type google.cloud.dialogflow.cx.v3.Environment

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Environment.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllVersionConfigs(Iterable<? extends Environment.VersionConfig> values)

public Environment.Builder addAllVersionConfigs(Iterable<? extends Environment.VersionConfig> values)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.dialogflow.cx.v3.Environment.VersionConfig>
Returns
Type Description
Environment.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Environment.Builder
Overrides

addVersionConfigs(Environment.VersionConfig value)

public Environment.Builder addVersionConfigs(Environment.VersionConfig value)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Environment.VersionConfig
Returns
Type Description
Environment.Builder

addVersionConfigs(Environment.VersionConfig.Builder builderForValue)

public Environment.Builder addVersionConfigs(Environment.VersionConfig.Builder builderForValue)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Environment.VersionConfig.Builder
Returns
Type Description
Environment.Builder

addVersionConfigs(int index, Environment.VersionConfig value)

public Environment.Builder addVersionConfigs(int index, Environment.VersionConfig value)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Environment.VersionConfig
Returns
Type Description
Environment.Builder

addVersionConfigs(int index, Environment.VersionConfig.Builder builderForValue)

public Environment.Builder addVersionConfigs(int index, Environment.VersionConfig.Builder builderForValue)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Environment.VersionConfig.Builder
Returns
Type Description
Environment.Builder

addVersionConfigsBuilder()

public Environment.VersionConfig.Builder addVersionConfigsBuilder()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Environment.VersionConfig.Builder

addVersionConfigsBuilder(int index)

public Environment.VersionConfig.Builder addVersionConfigsBuilder(int index)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Environment.VersionConfig.Builder

build()

public Environment build()
Returns
Type Description
Environment

buildPartial()

public Environment buildPartial()
Returns
Type Description
Environment

clear()

public Environment.Builder clear()
Returns
Type Description
Environment.Builder
Overrides

clearDescription()

public Environment.Builder clearDescription()

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 3;

Returns
Type Description
Environment.Builder

This builder for chaining.

clearDisplayName()

public Environment.Builder clearDisplayName()

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Environment.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Environment.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Environment.Builder
Overrides

clearName()

public Environment.Builder clearName()

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string name = 1;

Returns
Type Description
Environment.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Environment.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Environment.Builder
Overrides

clearTestCasesConfig()

public Environment.Builder clearTestCasesConfig()

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Returns
Type Description
Environment.Builder

clearUpdateTime()

public Environment.Builder clearUpdateTime()

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Environment.Builder

clearVersionConfigs()

public Environment.Builder clearVersionConfigs()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Environment.Builder

clone()

public Environment.Builder clone()
Returns
Type Description
Environment.Builder
Overrides

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
Type Description
Environment

getDescription()

public String getDescription()

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getTestCasesConfig()

public Environment.TestCasesConfig getTestCasesConfig()

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Returns
Type Description
Environment.TestCasesConfig

The testCasesConfig.

getTestCasesConfigBuilder()

public Environment.TestCasesConfig.Builder getTestCasesConfigBuilder()

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Returns
Type Description
Environment.TestCasesConfig.Builder

getTestCasesConfigOrBuilder()

public Environment.TestCasesConfigOrBuilder getTestCasesConfigOrBuilder()

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Returns
Type Description
Environment.TestCasesConfigOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVersionConfigs(int index)

public Environment.VersionConfig getVersionConfigs(int index)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Environment.VersionConfig

getVersionConfigsBuilder(int index)

public Environment.VersionConfig.Builder getVersionConfigsBuilder(int index)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Environment.VersionConfig.Builder

getVersionConfigsBuilderList()

public List<Environment.VersionConfig.Builder> getVersionConfigsBuilderList()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getVersionConfigsCount()

public int getVersionConfigsCount()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getVersionConfigsList()

public List<Environment.VersionConfig> getVersionConfigsList()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<VersionConfig>

getVersionConfigsOrBuilder(int index)

public Environment.VersionConfigOrBuilder getVersionConfigsOrBuilder(int index)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Environment.VersionConfigOrBuilder

getVersionConfigsOrBuilderList()

public List<? extends Environment.VersionConfigOrBuilder> getVersionConfigsOrBuilderList()

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.cx.v3.Environment.VersionConfigOrBuilder>

hasTestCasesConfig()

public boolean hasTestCasesConfig()

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Returns
Type Description
boolean

Whether the testCasesConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Environment other)

public Environment.Builder mergeFrom(Environment other)
Parameter
Name Description
other Environment
Returns
Type Description
Environment.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Environment.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Environment.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

public Environment.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Environment.Builder
Overrides

mergeTestCasesConfig(Environment.TestCasesConfig value)

public Environment.Builder mergeTestCasesConfig(Environment.TestCasesConfig value)

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Parameter
Name Description
value Environment.TestCasesConfig
Returns
Type Description
Environment.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Environment.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Environment.Builder mergeUpdateTime(Timestamp value)

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Environment.Builder

removeVersionConfigs(int index)

public Environment.Builder removeVersionConfigs(int index)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Environment.Builder

setDescription(String value)

public Environment.Builder setDescription(String value)

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Environment.Builder setDescriptionBytes(ByteString value)

The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setDisplayName(String value)

public Environment.Builder setDisplayName(String value)

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Environment.Builder setDisplayNameBytes(ByteString value)

Required. The human-readable name of the environment (unique in an agent). Limit of 64 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Environment.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Environment.Builder
Overrides

setName(String value)

public Environment.Builder setName(String value)

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Environment.Builder setNameBytes(ByteString value)

The name of the environment. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment ID>.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Environment.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Environment.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Environment.Builder
Overrides

setTestCasesConfig(Environment.TestCasesConfig value)

public Environment.Builder setTestCasesConfig(Environment.TestCasesConfig value)

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Parameter
Name Description
value Environment.TestCasesConfig
Returns
Type Description
Environment.Builder

setTestCasesConfig(Environment.TestCasesConfig.Builder builderForValue)

public Environment.Builder setTestCasesConfig(Environment.TestCasesConfig.Builder builderForValue)

The test cases config for continuous tests of this environment.

.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

Parameter
Name Description
builderForValue Environment.TestCasesConfig.Builder
Returns
Type Description
Environment.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Environment.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Environment.Builder
Overrides

setUpdateTime(Timestamp value)

public Environment.Builder setUpdateTime(Timestamp value)

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Environment.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Environment.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Update time of this environment.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Environment.Builder

setVersionConfigs(int index, Environment.VersionConfig value)

public Environment.Builder setVersionConfigs(int index, Environment.VersionConfig value)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value Environment.VersionConfig
Returns
Type Description
Environment.Builder

setVersionConfigs(int index, Environment.VersionConfig.Builder builderForValue)

public Environment.Builder setVersionConfigs(int index, Environment.VersionConfig.Builder builderForValue)

Required. A list of configurations for flow versions. You should include version configs for all flows that are reachable from Start Flow in the agent. Otherwise, an error will be returned.

repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue Environment.VersionConfig.Builder
Returns
Type Description
Environment.Builder