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.v2beta1.Environment
Static Fields
AGENT_VERSION_FIELD_NUMBER
public static final int AGENT_VERSION_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
FULFILLMENT_FIELD_NUMBER
public static final int FULFILLMENT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
public static final int TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_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
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()
Returns
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.v2beta1.Fulfillment fulfillment = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
getFulfillmentOrBuilder()
public FulfillmentOrBuilder getFulfillmentOrBuilder()
Optional. The fulfillment settings to use for this environment.
.google.cloud.dialogflow.v2beta1.Fulfillment fulfillment = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
getName()
Output only. The unique identifier of this agent environment.
Supported formats:
projects/<Project Number / ID>/agent/environments/<Environment ID>
projects/<Project Number / ID>/locations/<Location
ID>/agent/environments/<Environment ID>
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 Number / ID>/agent/environments/<Environment ID>
projects/<Project Number / ID>/locations/<Location
ID>/agent/environments/<Environment ID>
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getParserForType()
public Parser<Environment> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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.v2beta1.Environment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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.v2beta1.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.v2beta1.TextToSpeechSettings text_to_speech_settings = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
getTextToSpeechSettingsOrBuilder()
public TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()
Optional. Text to speech settings for this environment.
.google.cloud.dialogflow.v2beta1.TextToSpeechSettings text_to_speech_settings = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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
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];
Returns
hasFulfillment()
public boolean hasFulfillment()
Optional. The fulfillment settings to use for this environment.
.google.cloud.dialogflow.v2beta1.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.v2beta1.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
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