public final class Environment extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TEST_CASES_CONFIG_FIELD_NUMBER
public static final int TEST_CASES_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
VERSION_CONFIGS_FIELD_NUMBER
public static final int VERSION_CONFIGS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
WEBHOOK_CONFIG_FIELD_NUMBER
public static final int WEBHOOK_CONFIG_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Environment getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Environment.Builder newBuilder()
newBuilder(Environment prototype)
public static Environment.Builder newBuilder(Environment prototype)
public static Environment parseDelimitedFrom(InputStream input)
public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Environment parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Environment parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(CodedInputStream input)
public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(InputStream input)
public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Environment parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Environment> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()
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.
|
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()
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.
|
getParserForType()
public Parser<Environment> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
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;
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;
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.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Update time of this environment.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionConfigs(int index)
public 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
in the agent. Otherwise, an error will be
returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
Parameter |
Name |
Description |
index |
int
|
getVersionConfigsCount()
public int getVersionConfigsCount()
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;
Returns |
Type |
Description |
int |
|
getVersionConfigsList()
public 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
in the agent. Otherwise, an error will be
returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
getVersionConfigsOrBuilder(int index)
public 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
in the agent. Otherwise, an error will be
returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
Parameter |
Name |
Description |
index |
int
|
getVersionConfigsOrBuilderList()
public 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
in the agent. Otherwise, an error will be
returned.
repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
Returns |
Type |
Description |
List<? extends com.google.cloud.dialogflow.cx.v3.Environment.VersionConfigOrBuilder> |
|
getWebhookConfig()
public Environment.WebhookConfig getWebhookConfig()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;
getWebhookConfigOrBuilder()
public Environment.WebhookConfigOrBuilder getWebhookConfigOrBuilder()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;
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.
|
hasWebhookConfig()
public boolean hasWebhookConfig()
The webhook configuration for this environment.
.google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;
Returns |
Type |
Description |
boolean |
Whether the webhookConfig field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Environment.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public Environment.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides