public final class Environment extends com.google.protobuf.GeneratedMessageV3 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| Modifier and Type | Class and Description |
|---|---|
static class |
Environment.Builder
Represents an environment for an agent.
|
static class |
Environment.TestCasesConfig
The configuration for continuous tests.
|
static interface |
Environment.TestCasesConfigOrBuilder |
static class |
Environment.VersionConfig
Configuration for the version.
|
static interface |
Environment.VersionConfigOrBuilder |
static class |
Environment.WebhookConfig
Configuration for webhooks.
|
static interface |
Environment.WebhookConfigOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
TEST_CASES_CONFIG_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
static int |
VERSION_CONFIGS_FIELD_NUMBER |
static int |
WEBHOOK_CONFIG_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static Environment |
getDefaultInstance() |
Environment |
getDefaultInstanceForType() |
String |
getDescription()
The human-readable description of the environment.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The human-readable description of the environment.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
String |
getName()
The name of the environment.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the environment.
|
com.google.protobuf.Parser<Environment> |
getParserForType() |
int |
getSerializedSize() |
Environment.TestCasesConfig |
getTestCasesConfig()
The test cases config for continuous tests of this environment.
|
Environment.TestCasesConfigOrBuilder |
getTestCasesConfigOrBuilder()
The test cases config for continuous tests of this environment.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
Environment.VersionConfig |
getVersionConfigs(int index)
A list of configurations for flow versions.
|
int |
getVersionConfigsCount()
A list of configurations for flow versions.
|
List<Environment.VersionConfig> |
getVersionConfigsList()
A list of configurations for flow versions.
|
Environment.VersionConfigOrBuilder |
getVersionConfigsOrBuilder(int index)
A list of configurations for flow versions.
|
List<? extends Environment.VersionConfigOrBuilder> |
getVersionConfigsOrBuilderList()
A list of configurations for flow versions.
|
Environment.WebhookConfig |
getWebhookConfig()
The webhook configuration for this environment.
|
Environment.WebhookConfigOrBuilder |
getWebhookConfigOrBuilder()
The webhook configuration for this environment.
|
int |
hashCode() |
boolean |
hasTestCasesConfig()
The test cases config for continuous tests of this environment.
|
boolean |
hasUpdateTime()
Output only.
|
boolean |
hasWebhookConfig()
The webhook configuration for this environment.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Environment.Builder |
newBuilder() |
static Environment.Builder |
newBuilder(Environment prototype) |
Environment.Builder |
newBuilderForType() |
protected Environment.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Environment |
parseDelimitedFrom(InputStream input) |
static Environment |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Environment |
parseFrom(byte[] data) |
static Environment |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Environment |
parseFrom(ByteBuffer data) |
static Environment |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Environment |
parseFrom(com.google.protobuf.ByteString data) |
static Environment |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Environment |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Environment |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Environment |
parseFrom(InputStream input) |
static Environment |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Environment> |
parser() |
Environment.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int VERSION_CONFIGS_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int TEST_CASES_CONFIG_FIELD_NUMBER
public static final int WEBHOOK_CONFIG_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
The name of the environment. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
string name = 1;getName in interface EnvironmentOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The name of the environment. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
string name = 1;getNameBytes in interface EnvironmentOrBuilderpublic 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];getDisplayName in interface EnvironmentOrBuilderpublic com.google.protobuf.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];getDisplayNameBytes in interface EnvironmentOrBuilderpublic String getDescription()
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;getDescription in interface EnvironmentOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
The human-readable description of the environment. The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 3;getDescriptionBytes in interface EnvironmentOrBuilderpublic List<Environment.VersionConfig> getVersionConfigsList()
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [`Start Flow`][Agent.start_flow] in the agent. Otherwise, an error will be returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigsList in interface EnvironmentOrBuilderpublic List<? extends Environment.VersionConfigOrBuilder> getVersionConfigsOrBuilderList()
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [`Start Flow`][Agent.start_flow] in the agent. Otherwise, an error will be returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigsOrBuilderList in interface EnvironmentOrBuilderpublic int getVersionConfigsCount()
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [`Start Flow`][Agent.start_flow] in the agent. Otherwise, an error will be returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigsCount in interface EnvironmentOrBuilderpublic Environment.VersionConfig getVersionConfigs(int index)
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [`Start Flow`][Agent.start_flow] in the agent. Otherwise, an error will be returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigs in interface EnvironmentOrBuilderpublic Environment.VersionConfigOrBuilder getVersionConfigsOrBuilder(int index)
A list of configurations for flow versions. You should include version configs for all flows that are reachable from [`Start Flow`][Agent.start_flow] in the agent. Otherwise, an error will be returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigsOrBuilder in interface EnvironmentOrBuilderpublic boolean hasUpdateTime()
Output only. Update time of this environment.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface EnvironmentOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Update time of this environment.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface EnvironmentOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time of this environment.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface EnvironmentOrBuilderpublic boolean hasTestCasesConfig()
The test cases config for continuous tests of this environment.
.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;hasTestCasesConfig in interface EnvironmentOrBuilderpublic Environment.TestCasesConfig getTestCasesConfig()
The test cases config for continuous tests of this environment.
.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;getTestCasesConfig in interface EnvironmentOrBuilderpublic Environment.TestCasesConfigOrBuilder getTestCasesConfigOrBuilder()
The test cases config for continuous tests of this environment.
.google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;getTestCasesConfigOrBuilder in interface EnvironmentOrBuilderpublic boolean hasWebhookConfig()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;hasWebhookConfig in interface EnvironmentOrBuilderpublic Environment.WebhookConfig getWebhookConfig()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;getWebhookConfig in interface EnvironmentOrBuilderpublic Environment.WebhookConfigOrBuilder getWebhookConfigOrBuilder()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;getWebhookConfigOrBuilder in interface EnvironmentOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Environment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Environment parseFrom(InputStream input) throws IOException
IOExceptionpublic static Environment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Environment parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Environment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Environment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Environment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Environment.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Environment.Builder newBuilder()
public static Environment.Builder newBuilder(Environment prototype)
public Environment.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Environment.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Environment getDefaultInstance()
public static com.google.protobuf.Parser<Environment> parser()
public com.google.protobuf.Parser<Environment> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Environment getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.