public final class Environment extends GeneratedMessageV3 implements EnvironmentOrBuilder
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:
Protobuf type google.cloud.dialogflow.v2.Environment
Inherited Members
Static Fields
AGENT_VERSION_FIELD_NUMBER
public static final int AGENT_VERSION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
FULFILLMENT_FIELD_NUMBER
public static final int FULFILLMENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
public static final int TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_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
getAgentVersion()
public String getAgentVersion()
Optional. The agent version loaded into this environment.
Supported formats:
projects/<Project ID>/agent/versions/<Version ID>
projects/<Project ID>/locations/<Location ID>/agent/versions/<Version
ID>
string agent_version = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
String |
The agentVersion.
|
getAgentVersionBytes()
public ByteString getAgentVersionBytes()
Optional. The agent version loaded into this environment.
Supported formats:
projects/<Project ID>/agent/versions/<Version ID>
projects/<Project ID>/locations/<Location ID>/agent/versions/<Version
ID>
string agent_version = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
Returns |
Type |
Description |
ByteString |
The bytes for agentVersion.
|
getDefaultInstanceForType()
public Environment getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. The developer-provided description for this environment.
The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The developer-provided description for this environment.
The maximum length is 500 characters. If exceeded, the request is rejected.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
ByteString |
The bytes for description.
|
getFulfillment()
public Fulfillment getFulfillment()
Optional. The fulfillment settings to use for this environment.
.google.cloud.dialogflow.v2.Fulfillment fulfillment = 8 [(.google.api.field_behavior) = OPTIONAL];
getFulfillmentOrBuilder()
public FulfillmentOrBuilder getFulfillmentOrBuilder()
Optional. The fulfillment settings to use for this environment.
.google.cloud.dialogflow.v2.Fulfillment fulfillment = 8 [(.google.api.field_behavior) = OPTIONAL];
getName()
Output only. The unique identifier of this agent environment.
Supported formats:
projects/<Project ID>/agent/environments/<Environment ID>
projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID>
The environment ID for the default environment is -
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The unique identifier of this agent environment.
Supported formats:
projects/<Project ID>/agent/environments/<Environment ID>
projects/<Project ID>/locations/<Location
ID>/agent/environments/<Environment ID>
The environment ID for the default environment is -
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Environment> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getState()
public Environment.State getState()
Output only. The state of this environment. This field is read-only, i.e.,
it cannot be set by create and update methods.
.google.cloud.dialogflow.v2.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The state of this environment. This field is read-only, i.e.,
it cannot be set by create and update methods.
.google.cloud.dialogflow.v2.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
int |
The enum numeric value on the wire for state.
|
getTextToSpeechSettings()
public TextToSpeechSettings getTextToSpeechSettings()
Optional. Text to speech settings for this environment.
.google.cloud.dialogflow.v2.TextToSpeechSettings text_to_speech_settings = 7 [(.google.api.field_behavior) = OPTIONAL];
getTextToSpeechSettingsOrBuilder()
public TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()
Optional. Text to speech settings for this environment.
.google.cloud.dialogflow.v2.TextToSpeechSettings text_to_speech_settings = 7 [(.google.api.field_behavior) = OPTIONAL];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update time of this environment. This field is
read-only, i.e., it cannot be set by create and update methods.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update time of this environment. This field is
read-only, i.e., it cannot be set by create and update methods.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasFulfillment()
public boolean hasFulfillment()
Optional. The fulfillment settings to use for this environment.
.google.cloud.dialogflow.v2.Fulfillment fulfillment = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the fulfillment field is set.
|
hasTextToSpeechSettings()
public boolean hasTextToSpeechSettings()
Optional. Text to speech settings for this environment.
.google.cloud.dialogflow.v2.TextToSpeechSettings text_to_speech_settings = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns |
Type |
Description |
boolean |
Whether the textToSpeechSettings field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update time of this environment. This field is
read-only, i.e., it cannot be set by create and update methods.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns |
Type |
Description |
boolean |
Whether the updateTime 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