Package com.google.cloud.dialogflow.cx.v3

Class Environment

  • All Implemented Interfaces:
    EnvironmentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Environment
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERSION_CONFIGS_FIELD_NUMBER

        public static final int VERSION_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEST_CASES_CONFIG_FIELD_NUMBER

        public static final int TEST_CASES_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WEBHOOK_CONFIG_FIELD_NUMBER

        public static final int WEBHOOK_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getName

        public String getName()
         The name of the environment.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/environments/<Environment ID>`.
        string name = 1;
        Specified by:
        getName in interface EnvironmentOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the environment.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/environments/<Environment ID>`.
        string name = 1;
        Specified by:
        getNameBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for name.

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

      • getDisplayNameBytes

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

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

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The human-readable description of the environment. The maximum length is
 500 characters. If exceeded, the request is rejected.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface EnvironmentOrBuilder
        Returns:
        The bytes for description.

      • getVersionConfigsList

        public List<Environment.VersionConfig> getVersionConfigsList()
         A list of configurations for flow versions. You should include version
 configs for all flows that are reachable from [`Start
 Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
 returned.
        repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
        Specified by:
        getVersionConfigsList in interface EnvironmentOrBuilder

      • getVersionConfigsOrBuilderList

        public List<? extends Environment.VersionConfigOrBuilder> getVersionConfigsOrBuilderList()
         A list of configurations for flow versions. You should include version
 configs for all flows that are reachable from [`Start
 Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
 returned.
        repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
        Specified by:
        getVersionConfigsOrBuilderList in interface EnvironmentOrBuilder

      • getVersionConfigsCount

        public int getVersionConfigsCount()
         A list of configurations for flow versions. You should include version
 configs for all flows that are reachable from [`Start
 Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
 returned.
        repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
        Specified by:
        getVersionConfigsCount in interface EnvironmentOrBuilder

      • getVersionConfigs

        public Environment.VersionConfig getVersionConfigs​(int index)
         A list of configurations for flow versions. You should include version
 configs for all flows that are reachable from [`Start
 Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
 returned.
        repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
        Specified by:
        getVersionConfigs in interface EnvironmentOrBuilder

      • getVersionConfigsOrBuilder

        public Environment.VersionConfigOrBuilder getVersionConfigsOrBuilder​(int index)
         A list of configurations for flow versions. You should include version
 configs for all flows that are reachable from [`Start
 Flow`][Agent.start_flow] in the agent. Otherwise, an error will be
 returned.
        repeated .google.cloud.dialogflow.cx.v3.Environment.VersionConfig version_configs = 6;
        Specified by:
        getVersionConfigsOrBuilder in interface EnvironmentOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Update time of this environment.
        .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. Update time of this environment.
        .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. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface EnvironmentOrBuilder

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

      • hasWebhookConfig

        public boolean hasWebhookConfig()
         The webhook configuration for this environment.
        .google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;
        Specified by:
        hasWebhookConfig in interface EnvironmentOrBuilder
        Returns:
        Whether the webhookConfig field is set.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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