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
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
TEST_CASES_CONFIG_FIELD_NUMBER
public static final int TEST_CASES_CONFIG_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
VERSION_CONFIGS_FIELD_NUMBER
public static final int VERSION_CONFIGS_FIELD_NUMBER
Field Value
WEBHOOK_CONFIG_FIELD_NUMBER
public static final int WEBHOOK_CONFIG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Environment getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Environment.Builder newBuilder()
Returns
newBuilder(Environment prototype)
public static Environment.Builder newBuilder(Environment prototype)
Parameter
Returns
public static Environment parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Environment parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Environment parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Environment parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Environment parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Environment parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Environment> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()
Returns
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;
| 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;
| 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];
| 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];
| 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;
| 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;
getParserForType()
public Parser<Environment> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Update time of this environment.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
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)
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];
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];
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];
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];
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];
| 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;
| 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];
| 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;
| Type | Description |
| boolean | Whether the webhookConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Environment.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Environment.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
