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

Class Environment.Builder

  • All Implemented Interfaces:
    EnvironmentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Environment
    public static final class Environment.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>
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

    • Method Detail

      • 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.Builder<Environment.Builder>

      • clear

        public Environment.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Environment.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • setField

        public Environment.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • clearField

        public Environment.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • clearOneof

        public Environment.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • setRepeatedField

        public Environment.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • addRepeatedField

        public Environment.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • mergeFrom

        public Environment.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Environment.Builder>

      • isInitialized

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

      • mergeFrom

        public Environment.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Environment.Builder>
        Throws:
        IOException

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

      • setName

        public Environment.Builder setName​(String value)
         The name of the environment.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/environments/<Environment ID>`.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Environment.Builder clearName()
         The name of the environment.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/environments/<Environment ID>`.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Environment.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The name of the environment.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
 ID>/environments/<Environment ID>`.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

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

      • setDisplayName

        public Environment.Builder setDisplayName​(String value)
         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];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Environment.Builder clearDisplayName()
         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];
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Environment.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

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

      • setDescription

        public Environment.Builder setDescription​(String value)
         The human-readable description of the environment. The maximum length is
 500 characters. If exceeded, the request is rejected.
        string description = 3;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Environment.Builder clearDescription()
         The human-readable description of the environment. The maximum length is
 500 characters. If exceeded, the request is rejected.
        string description = 3;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Environment.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         The human-readable description of the environment. The maximum length is
 500 characters. If exceeded, the request is rejected.
        string description = 3;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • 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

      • 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

      • setVersionConfigs

        public Environment.Builder setVersionConfigs​(int index,
                                             Environment.VersionConfig value)
         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;

      • setVersionConfigs

        public Environment.Builder setVersionConfigs​(int index,
                                             Environment.VersionConfig.Builder builderForValue)
         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;

      • addVersionConfigs

        public Environment.Builder addVersionConfigs​(Environment.VersionConfig value)
         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;

      • addVersionConfigs

        public Environment.Builder addVersionConfigs​(int index,
                                             Environment.VersionConfig value)
         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;

      • addVersionConfigs

        public Environment.Builder addVersionConfigs​(Environment.VersionConfig.Builder builderForValue)
         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;

      • addVersionConfigs

        public Environment.Builder addVersionConfigs​(int index,
                                             Environment.VersionConfig.Builder builderForValue)
         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;

      • addAllVersionConfigs

        public Environment.Builder addAllVersionConfigs​(Iterable<? extends Environment.VersionConfig> values)
         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;

      • clearVersionConfigs

        public Environment.Builder clearVersionConfigs()
         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;

      • removeVersionConfigs

        public Environment.Builder removeVersionConfigs​(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;

      • getVersionConfigsBuilder

        public Environment.VersionConfig.Builder getVersionConfigsBuilder​(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;

      • 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

      • 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

      • addVersionConfigsBuilder

        public Environment.VersionConfig.Builder addVersionConfigsBuilder()
         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;

      • addVersionConfigsBuilder

        public Environment.VersionConfig.Builder addVersionConfigsBuilder​(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;

      • getVersionConfigsBuilderList

        public List<Environment.VersionConfig.Builder> getVersionConfigsBuilderList()
         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;

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

      • setUpdateTime

        public Environment.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setUpdateTime

        public Environment.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeUpdateTime

        public Environment.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearUpdateTime

        public Environment.Builder clearUpdateTime()
         Output only. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. Update time of this environment.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

      • setTestCasesConfig

        public Environment.Builder setTestCasesConfig​(Environment.TestCasesConfig value)
         The test cases config for continuous tests of this environment.
        .google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

      • setTestCasesConfig

        public Environment.Builder setTestCasesConfig​(Environment.TestCasesConfig.Builder builderForValue)
         The test cases config for continuous tests of this environment.
        .google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

      • mergeTestCasesConfig

        public Environment.Builder mergeTestCasesConfig​(Environment.TestCasesConfig value)
         The test cases config for continuous tests of this environment.
        .google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

      • clearTestCasesConfig

        public Environment.Builder clearTestCasesConfig()
         The test cases config for continuous tests of this environment.
        .google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

      • getTestCasesConfigBuilder

        public Environment.TestCasesConfig.Builder getTestCasesConfigBuilder()
         The test cases config for continuous tests of this environment.
        .google.cloud.dialogflow.cx.v3.Environment.TestCasesConfig test_cases_config = 7;

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

      • setWebhookConfig

        public Environment.Builder setWebhookConfig​(Environment.WebhookConfig value)
         The webhook configuration for this environment.
        .google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;

      • mergeWebhookConfig

        public Environment.Builder mergeWebhookConfig​(Environment.WebhookConfig value)
         The webhook configuration for this environment.
        .google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;

      • clearWebhookConfig

        public Environment.Builder clearWebhookConfig()
         The webhook configuration for this environment.
        .google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;

      • getWebhookConfigBuilder

        public Environment.WebhookConfig.Builder getWebhookConfigBuilder()
         The webhook configuration for this environment.
        .google.cloud.dialogflow.cx.v3.Environment.WebhookConfig webhook_config = 10;

      • setUnknownFields

        public final Environment.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>

      • mergeUnknownFields

        public final Environment.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Environment.Builder>