Package com.google.cloud.dialogflow.v2

Class Environment

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.v2.Environment
All Implemented Interfaces:
EnvironmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Environment extends com.google.protobuf.GeneratedMessage 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:

 - testing
 - development
 - production
 - etc.

 For more information, see the [versions and environments
 guide](https://cloud.google.com/dialogflow/docs/agents-versions).
Protobuf type google.cloud.dialogflow.v2.Environment
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • AGENT_VERSION_FIELD_NUMBER

      public static final int AGENT_VERSION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER

      public static final int TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
      See Also:

    • FULFILLMENT_FIELD_NUMBER

      public static final int FULFILLMENT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface EnvironmentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      getDescription in interface EnvironmentOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.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];
      Specified by:
      getDescriptionBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for description.

    • 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) = { ... }
      Specified by:
      getAgentVersion in interface EnvironmentOrBuilder
      Returns:
      The agentVersion.

    • getAgentVersionBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getAgentVersionBytes in interface EnvironmentOrBuilder
      Returns:
      The bytes for agentVersion.

    • 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];
      Specified by:
      getStateValue in interface EnvironmentOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface EnvironmentOrBuilder
      Returns:
      The state.

    • 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];
      Specified by:
      hasUpdateTime in interface EnvironmentOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.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];
      Specified by:
      getUpdateTime in interface EnvironmentOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getUpdateTimeOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasTextToSpeechSettings in interface EnvironmentOrBuilder
      Returns:
      Whether the textToSpeechSettings field is set.

    • 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];
      Specified by:
      getTextToSpeechSettings in interface EnvironmentOrBuilder
      Returns:
      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];
      Specified by:
      getTextToSpeechSettingsOrBuilder in interface EnvironmentOrBuilder

    • 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];
      Specified by:
      hasFulfillment in interface EnvironmentOrBuilder
      Returns:
      Whether the fulfillment field is set.

    • 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];
      Specified by:
      getFulfillment in interface EnvironmentOrBuilder
      Returns:
      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];
      Specified by:
      getFulfillmentOrBuilder in interface EnvironmentOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Environment parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Environment parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Environment parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Environment parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Environment parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Environment.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Environment.Builder newBuilder()

    • newBuilder

      public static Environment.Builder newBuilder(Environment prototype)

    • toBuilder

      public Environment.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Environment.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Environment getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Environment> parser()

    • getParserForType

      public com.google.protobuf.Parser<Environment> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Environment getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder