Class Environment (4.4.0)

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

Fields

AGENT_VERSION_FIELD_NUMBER

public static final int AGENT_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

FULFILLMENT_FIELD_NUMBER

public static final int FULFILLMENT_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER

public static final int TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for agentVersion.

getDefaultInstance()

public static Environment getDefaultInstance()
Returns
TypeDescription
Environment

getDefaultInstanceForType()

public Environment getDefaultInstanceForType()
Returns
TypeDescription
Environment

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
TypeDescription
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
TypeDescription
ByteString

The bytes for description.

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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];

Returns
TypeDescription
Fulfillment

The fulfillment.

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];

Returns
TypeDescription
FulfillmentOrBuilder

getName()

public String 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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Environment> getParserForType()
Returns
TypeDescription
Parser<Environment>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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];

Returns
TypeDescription
Environment.State

The state.

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
TypeDescription
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];

Returns
TypeDescription
TextToSpeechSettings

The textToSpeechSettings.

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];

Returns
TypeDescription
TextToSpeechSettingsOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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];

Returns
TypeDescription
TimestampOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static Environment.Builder newBuilder()
Returns
TypeDescription
Environment.Builder

newBuilder(Environment prototype)

public static Environment.Builder newBuilder(Environment prototype)
Parameter
NameDescription
prototypeEnvironment
Returns
TypeDescription
Environment.Builder

newBuilderForType()

public Environment.Builder newBuilderForType()
Returns
TypeDescription
Environment.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Environment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Environment.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static Environment parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Environment parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Environment parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Environment parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Environment parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Environment parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Environment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Environment
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Environment> parser()
Returns
TypeDescription
Parser<Environment>

toBuilder()

public Environment.Builder toBuilder()
Returns
TypeDescription
Environment.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException