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

Class Agent.Builder

  • All Implemented Interfaces:
    AgentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Agent
    public static final class Agent.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Agent.Builder>
implements AgentOrBuilder
     Agents are best described as Natural Language Understanding (NLU) modules
 that transform user requests into actionable data. You can include agents
 in your app, product, or service to determine user intent and respond to the
 user in a natural way.

 After you create an agent, you can add
 [Intents][google.cloud.dialogflow.cx.v3.Intent], [Entity
 Types][google.cloud.dialogflow.cx.v3.EntityType],
 [Flows][google.cloud.dialogflow.cx.v3.Flow],
 [Fulfillments][google.cloud.dialogflow.cx.v3.Fulfillment],
 [Webhooks][google.cloud.dialogflow.cx.v3.Webhook],
 [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup]
 and so on to manage the conversation flows.
    Protobuf type google.cloud.dialogflow.cx.v3.Agent

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

      • clear

        public Agent.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<Agent.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<Agent.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Agent.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<Agent.Builder>

      • setField

        public Agent.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<Agent.Builder>

      • clearField

        public Agent.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<Agent.Builder>

      • clearOneof

        public Agent.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<Agent.Builder>

      • setRepeatedField

        public Agent.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<Agent.Builder>

      • addRepeatedField

        public Agent.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<Agent.Builder>

      • mergeFrom

        public Agent.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<Agent.Builder>

      • isInitialized

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

      • mergeFrom

        public Agent.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<Agent.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         The unique identifier of the agent.
 Required for the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
 [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
        string name = 1;
        Specified by:
        getName in interface AgentOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique identifier of the agent.
 Required for the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
 [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
        string name = 1;
        Specified by:
        getNameBytes in interface AgentOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Agent.Builder setName​(String value)
         The unique identifier of the agent.
 Required for the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
 [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Agent.Builder clearName()
         The unique identifier of the agent.
 Required for the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
 [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Agent.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The unique identifier of the agent.
 Required for the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
 [Agents.CreateAgent][google.cloud.dialogflow.cx.v3.Agents.CreateAgent]
 populates the name automatically.
 Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent 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 agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayName in interface AgentOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Required. The human-readable name of the agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getDisplayNameBytes in interface AgentOrBuilder
        Returns:
        The bytes for displayName.

      • setDisplayName

        public Agent.Builder setDisplayName​(String value)
         Required. The human-readable name of the agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Agent.Builder clearDisplayName()
         Required. The human-readable name of the agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Agent.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         Required. The human-readable name of the agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • getDefaultLanguageCode

        public String getDefaultLanguageCode()
         Required. Immutable. The default language of the agent as a language tag.
 See [Language
 Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 for a list of the currently supported language codes.
 This field cannot be set by the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
        string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDefaultLanguageCode in interface AgentOrBuilder
        Returns:
        The defaultLanguageCode.

      • getDefaultLanguageCodeBytes

        public com.google.protobuf.ByteString getDefaultLanguageCodeBytes()
         Required. Immutable. The default language of the agent as a language tag.
 See [Language
 Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 for a list of the currently supported language codes.
 This field cannot be set by the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
        string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getDefaultLanguageCodeBytes in interface AgentOrBuilder
        Returns:
        The bytes for defaultLanguageCode.

      • setDefaultLanguageCode

        public Agent.Builder setDefaultLanguageCode​(String value)
         Required. Immutable. The default language of the agent as a language tag.
 See [Language
 Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 for a list of the currently supported language codes.
 This field cannot be set by the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
        string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The defaultLanguageCode to set.
        Returns:
        This builder for chaining.

      • clearDefaultLanguageCode

        public Agent.Builder clearDefaultLanguageCode()
         Required. Immutable. The default language of the agent as a language tag.
 See [Language
 Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 for a list of the currently supported language codes.
 This field cannot be set by the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
        string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setDefaultLanguageCodeBytes

        public Agent.Builder setDefaultLanguageCodeBytes​(com.google.protobuf.ByteString value)
         Required. Immutable. The default language of the agent as a language tag.
 See [Language
 Support](https://cloud.google.com/dialogflow/cx/docs/reference/language)
 for a list of the currently supported language codes.
 This field cannot be set by the
 [Agents.UpdateAgent][google.cloud.dialogflow.cx.v3.Agents.UpdateAgent]
 method.
        string default_language_code = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for defaultLanguageCode to set.
        Returns:
        This builder for chaining.

      • getSupportedLanguageCodesList

        public com.google.protobuf.ProtocolStringList getSupportedLanguageCodesList()
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Specified by:
        getSupportedLanguageCodesList in interface AgentOrBuilder
        Returns:
        A list containing the supportedLanguageCodes.

      • getSupportedLanguageCodesCount

        public int getSupportedLanguageCodesCount()
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Specified by:
        getSupportedLanguageCodesCount in interface AgentOrBuilder
        Returns:
        The count of supportedLanguageCodes.

      • getSupportedLanguageCodes

        public String getSupportedLanguageCodes​(int index)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Specified by:
        getSupportedLanguageCodes in interface AgentOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The supportedLanguageCodes at the given index.

      • getSupportedLanguageCodesBytes

        public com.google.protobuf.ByteString getSupportedLanguageCodesBytes​(int index)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Specified by:
        getSupportedLanguageCodesBytes in interface AgentOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the supportedLanguageCodes at the given index.

      • setSupportedLanguageCodes

        public Agent.Builder setSupportedLanguageCodes​(int index,
                                               String value)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Parameters:
        index - The index to set the value at.
        value - The supportedLanguageCodes to set.
        Returns:
        This builder for chaining.

      • addSupportedLanguageCodes

        public Agent.Builder addSupportedLanguageCodes​(String value)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Parameters:
        value - The supportedLanguageCodes to add.
        Returns:
        This builder for chaining.

      • addAllSupportedLanguageCodes

        public Agent.Builder addAllSupportedLanguageCodes​(Iterable<String> values)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Parameters:
        values - The supportedLanguageCodes to add.
        Returns:
        This builder for chaining.

      • clearSupportedLanguageCodes

        public Agent.Builder clearSupportedLanguageCodes()
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Returns:
        This builder for chaining.

      • addSupportedLanguageCodesBytes

        public Agent.Builder addSupportedLanguageCodesBytes​(com.google.protobuf.ByteString value)
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Parameters:
        value - The bytes of the supportedLanguageCodes to add.
        Returns:
        This builder for chaining.

      • getTimeZone

        public String getTimeZone()
         Required. The time zone of the agent from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris.
        string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeZone in interface AgentOrBuilder
        Returns:
        The timeZone.

      • getTimeZoneBytes

        public com.google.protobuf.ByteString getTimeZoneBytes()
         Required. The time zone of the agent from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris.
        string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTimeZoneBytes in interface AgentOrBuilder
        Returns:
        The bytes for timeZone.

      • setTimeZone

        public Agent.Builder setTimeZone​(String value)
         Required. The time zone of the agent from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris.
        string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The timeZone to set.
        Returns:
        This builder for chaining.

      • clearTimeZone

        public Agent.Builder clearTimeZone()
         Required. The time zone of the agent from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris.
        string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setTimeZoneBytes

        public Agent.Builder setTimeZoneBytes​(com.google.protobuf.ByteString value)
         Required. The time zone of the agent from the [time zone
 database](https://www.iana.org/time-zones), e.g., America/New_York,
 Europe/Paris.
        string time_zone = 5 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for timeZone to set.
        Returns:
        This builder for chaining.

      • getDescription

        public String getDescription()
         The description of the agent. The maximum length is 500 characters. If
 exceeded, the request is rejected.
        string description = 6;
        Specified by:
        getDescription in interface AgentOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the agent. The maximum length is 500 characters. If
 exceeded, the request is rejected.
        string description = 6;
        Specified by:
        getDescriptionBytes in interface AgentOrBuilder
        Returns:
        The bytes for description.

      • setDescription

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

      • clearDescription

        public Agent.Builder clearDescription()
         The description of the agent. The maximum length is 500 characters. If
 exceeded, the request is rejected.
        string description = 6;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

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

      • getAvatarUri

        public String getAvatarUri()
         The URI of the agent's avatar. Avatars are used throughout the Dialogflow
 console and in the self-hosted [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
        string avatar_uri = 7;
        Specified by:
        getAvatarUri in interface AgentOrBuilder
        Returns:
        The avatarUri.

      • getAvatarUriBytes

        public com.google.protobuf.ByteString getAvatarUriBytes()
         The URI of the agent's avatar. Avatars are used throughout the Dialogflow
 console and in the self-hosted [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
        string avatar_uri = 7;
        Specified by:
        getAvatarUriBytes in interface AgentOrBuilder
        Returns:
        The bytes for avatarUri.

      • setAvatarUri

        public Agent.Builder setAvatarUri​(String value)
         The URI of the agent's avatar. Avatars are used throughout the Dialogflow
 console and in the self-hosted [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
        string avatar_uri = 7;
        Parameters:
        value - The avatarUri to set.
        Returns:
        This builder for chaining.

      • clearAvatarUri

        public Agent.Builder clearAvatarUri()
         The URI of the agent's avatar. Avatars are used throughout the Dialogflow
 console and in the self-hosted [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
        string avatar_uri = 7;
        Returns:
        This builder for chaining.

      • setAvatarUriBytes

        public Agent.Builder setAvatarUriBytes​(com.google.protobuf.ByteString value)
         The URI of the agent's avatar. Avatars are used throughout the Dialogflow
 console and in the self-hosted [Web
 Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo)
 integration.
        string avatar_uri = 7;
        Parameters:
        value - The bytes for avatarUri to set.
        Returns:
        This builder for chaining.

      • hasSpeechToTextSettings

        public boolean hasSpeechToTextSettings()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;
        Specified by:
        hasSpeechToTextSettings in interface AgentOrBuilder
        Returns:
        Whether the speechToTextSettings field is set.

      • getSpeechToTextSettings

        public SpeechToTextSettings getSpeechToTextSettings()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;
        Specified by:
        getSpeechToTextSettings in interface AgentOrBuilder
        Returns:
        The speechToTextSettings.

      • setSpeechToTextSettings

        public Agent.Builder setSpeechToTextSettings​(SpeechToTextSettings value)
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • setSpeechToTextSettings

        public Agent.Builder setSpeechToTextSettings​(SpeechToTextSettings.Builder builderForValue)
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • mergeSpeechToTextSettings

        public Agent.Builder mergeSpeechToTextSettings​(SpeechToTextSettings value)
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • clearSpeechToTextSettings

        public Agent.Builder clearSpeechToTextSettings()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • getSpeechToTextSettingsBuilder

        public SpeechToTextSettings.Builder getSpeechToTextSettingsBuilder()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • getStartFlow

        public String getStartFlow()
         Immutable. Name of the start flow in this agent. A start flow will be
 automatically created when the agent is created, and can only be deleted by
 deleting the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/flows/<Flow ID>`.
        string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getStartFlow in interface AgentOrBuilder
        Returns:
        The startFlow.

      • getStartFlowBytes

        public com.google.protobuf.ByteString getStartFlowBytes()
         Immutable. Name of the start flow in this agent. A start flow will be
 automatically created when the agent is created, and can only be deleted by
 deleting the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/flows/<Flow ID>`.
        string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getStartFlowBytes in interface AgentOrBuilder
        Returns:
        The bytes for startFlow.

      • setStartFlow

        public Agent.Builder setStartFlow​(String value)
         Immutable. Name of the start flow in this agent. A start flow will be
 automatically created when the agent is created, and can only be deleted by
 deleting the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/flows/<Flow ID>`.
        string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The startFlow to set.
        Returns:
        This builder for chaining.

      • clearStartFlow

        public Agent.Builder clearStartFlow()
         Immutable. Name of the start flow in this agent. A start flow will be
 automatically created when the agent is created, and can only be deleted by
 deleting the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/flows/<Flow ID>`.
        string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setStartFlowBytes

        public Agent.Builder setStartFlowBytes​(com.google.protobuf.ByteString value)
         Immutable. Name of the start flow in this agent. A start flow will be
 automatically created when the agent is created, and can only be deleted by
 deleting the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/agents/<Agent ID>/flows/<Flow ID>`.
        string start_flow = 16 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for startFlow to set.
        Returns:
        This builder for chaining.

      • getSecuritySettings

        public String getSecuritySettings()
         Name of the
 [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
 reference for the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 17 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSecuritySettings in interface AgentOrBuilder
        Returns:
        The securitySettings.

      • getSecuritySettingsBytes

        public com.google.protobuf.ByteString getSecuritySettingsBytes()
         Name of the
 [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
 reference for the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 17 [(.google.api.resource_reference) = { ... }
        Specified by:
        getSecuritySettingsBytes in interface AgentOrBuilder
        Returns:
        The bytes for securitySettings.

      • setSecuritySettings

        public Agent.Builder setSecuritySettings​(String value)
         Name of the
 [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
 reference for the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 17 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The securitySettings to set.
        Returns:
        This builder for chaining.

      • clearSecuritySettings

        public Agent.Builder clearSecuritySettings()
         Name of the
 [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
 reference for the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 17 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setSecuritySettingsBytes

        public Agent.Builder setSecuritySettingsBytes​(com.google.protobuf.ByteString value)
         Name of the
 [SecuritySettings][google.cloud.dialogflow.cx.v3.SecuritySettings]
 reference for the agent. Format: `projects/<Project ID>/locations/<Location
 ID>/securitySettings/<Security Settings ID>`.
        string security_settings = 17 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for securitySettings to set.
        Returns:
        This builder for chaining.

      • getEnableStackdriverLogging

        @Deprecated
public boolean getEnableStackdriverLogging()
        Deprecated.
        google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=314
         Indicates if stackdriver logging is enabled for the agent.
 Please use
 [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
 instead.
        bool enable_stackdriver_logging = 18 [deprecated = true];
        Specified by:
        getEnableStackdriverLogging in interface AgentOrBuilder
        Returns:
        The enableStackdriverLogging.

      • setEnableStackdriverLogging

        @Deprecated
public Agent.Builder setEnableStackdriverLogging​(boolean value)
        Deprecated.
        google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=314
         Indicates if stackdriver logging is enabled for the agent.
 Please use
 [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
 instead.
        bool enable_stackdriver_logging = 18 [deprecated = true];
        Parameters:
        value - The enableStackdriverLogging to set.
        Returns:
        This builder for chaining.

      • clearEnableStackdriverLogging

        @Deprecated
public Agent.Builder clearEnableStackdriverLogging()
        Deprecated.
        google.cloud.dialogflow.cx.v3.Agent.enable_stackdriver_logging is deprecated. See google/cloud/dialogflow/cx/v3/agent.proto;l=314
         Indicates if stackdriver logging is enabled for the agent.
 Please use
 [agent.advanced_settings][google.cloud.dialogflow.cx.v3.AdvancedSettings.LoggingSettings]
 instead.
        bool enable_stackdriver_logging = 18 [deprecated = true];
        Returns:
        This builder for chaining.

      • getEnableSpellCorrection

        public boolean getEnableSpellCorrection()
         Indicates if automatic spell correction is enabled in detect intent
 requests.
        bool enable_spell_correction = 20;
        Specified by:
        getEnableSpellCorrection in interface AgentOrBuilder
        Returns:
        The enableSpellCorrection.

      • setEnableSpellCorrection

        public Agent.Builder setEnableSpellCorrection​(boolean value)
         Indicates if automatic spell correction is enabled in detect intent
 requests.
        bool enable_spell_correction = 20;
        Parameters:
        value - The enableSpellCorrection to set.
        Returns:
        This builder for chaining.

      • clearEnableSpellCorrection

        public Agent.Builder clearEnableSpellCorrection()
         Indicates if automatic spell correction is enabled in detect intent
 requests.
        bool enable_spell_correction = 20;
        Returns:
        This builder for chaining.

      • getLocked

        public boolean getLocked()
         Indicates whether the agent is locked for changes. If the agent is locked,
 modifications to the agent will be rejected except for [RestoreAgent][].
        bool locked = 27;
        Specified by:
        getLocked in interface AgentOrBuilder
        Returns:
        The locked.

      • setLocked

        public Agent.Builder setLocked​(boolean value)
         Indicates whether the agent is locked for changes. If the agent is locked,
 modifications to the agent will be rejected except for [RestoreAgent][].
        bool locked = 27;
        Parameters:
        value - The locked to set.
        Returns:
        This builder for chaining.

      • clearLocked

        public Agent.Builder clearLocked()
         Indicates whether the agent is locked for changes. If the agent is locked,
 modifications to the agent will be rejected except for [RestoreAgent][].
        bool locked = 27;
        Returns:
        This builder for chaining.

      • hasAdvancedSettings

        public boolean hasAdvancedSettings()
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;
        Specified by:
        hasAdvancedSettings in interface AgentOrBuilder
        Returns:
        Whether the advancedSettings field is set.

      • getAdvancedSettings

        public AdvancedSettings getAdvancedSettings()
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;
        Specified by:
        getAdvancedSettings in interface AgentOrBuilder
        Returns:
        The advancedSettings.

      • setAdvancedSettings

        public Agent.Builder setAdvancedSettings​(AdvancedSettings value)
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

      • setAdvancedSettings

        public Agent.Builder setAdvancedSettings​(AdvancedSettings.Builder builderForValue)
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

      • mergeAdvancedSettings

        public Agent.Builder mergeAdvancedSettings​(AdvancedSettings value)
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

      • clearAdvancedSettings

        public Agent.Builder clearAdvancedSettings()
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

      • getAdvancedSettingsBuilder

        public AdvancedSettings.Builder getAdvancedSettingsBuilder()
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;

      • getAdvancedSettingsOrBuilder

        public AdvancedSettingsOrBuilder getAdvancedSettingsOrBuilder()
         Hierarchical advanced settings for this agent. The settings exposed at the
 lower level overrides the settings exposed at the higher level.
        .google.cloud.dialogflow.cx.v3.AdvancedSettings advanced_settings = 22;
        Specified by:
        getAdvancedSettingsOrBuilder in interface AgentOrBuilder

      • hasGitIntegrationSettings

        public boolean hasGitIntegrationSettings()
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;
        Specified by:
        hasGitIntegrationSettings in interface AgentOrBuilder
        Returns:
        Whether the gitIntegrationSettings field is set.

      • setGitIntegrationSettings

        public Agent.Builder setGitIntegrationSettings​(Agent.GitIntegrationSettings value)
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

      • setGitIntegrationSettings

        public Agent.Builder setGitIntegrationSettings​(Agent.GitIntegrationSettings.Builder builderForValue)
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

      • mergeGitIntegrationSettings

        public Agent.Builder mergeGitIntegrationSettings​(Agent.GitIntegrationSettings value)
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

      • clearGitIntegrationSettings

        public Agent.Builder clearGitIntegrationSettings()
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

      • getGitIntegrationSettingsBuilder

        public Agent.GitIntegrationSettings.Builder getGitIntegrationSettingsBuilder()
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;

      • hasTextToSpeechSettings

        public boolean hasTextToSpeechSettings()
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;
        Specified by:
        hasTextToSpeechSettings in interface AgentOrBuilder
        Returns:
        Whether the textToSpeechSettings field is set.

      • getTextToSpeechSettings

        public TextToSpeechSettings getTextToSpeechSettings()
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;
        Specified by:
        getTextToSpeechSettings in interface AgentOrBuilder
        Returns:
        The textToSpeechSettings.

      • setTextToSpeechSettings

        public Agent.Builder setTextToSpeechSettings​(TextToSpeechSettings value)
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

      • setTextToSpeechSettings

        public Agent.Builder setTextToSpeechSettings​(TextToSpeechSettings.Builder builderForValue)
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

      • mergeTextToSpeechSettings

        public Agent.Builder mergeTextToSpeechSettings​(TextToSpeechSettings value)
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

      • clearTextToSpeechSettings

        public Agent.Builder clearTextToSpeechSettings()
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

      • getTextToSpeechSettingsBuilder

        public TextToSpeechSettings.Builder getTextToSpeechSettingsBuilder()
         Settings on instructing the speech synthesizer on how to generate the
 output audio content.
        .google.cloud.dialogflow.cx.v3.TextToSpeechSettings text_to_speech_settings = 31;

      • hasGenAppBuilderSettings

        public boolean hasGenAppBuilderSettings()
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
        Specified by:
        hasGenAppBuilderSettings in interface AgentOrBuilder
        Returns:
        Whether the genAppBuilderSettings field is set.

      • getGenAppBuilderSettings

        public Agent.GenAppBuilderSettings getGenAppBuilderSettings()
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;
        Specified by:
        getGenAppBuilderSettings in interface AgentOrBuilder
        Returns:
        The genAppBuilderSettings.

      • setGenAppBuilderSettings

        public Agent.Builder setGenAppBuilderSettings​(Agent.GenAppBuilderSettings value)
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

      • setGenAppBuilderSettings

        public Agent.Builder setGenAppBuilderSettings​(Agent.GenAppBuilderSettings.Builder builderForValue)
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

      • mergeGenAppBuilderSettings

        public Agent.Builder mergeGenAppBuilderSettings​(Agent.GenAppBuilderSettings value)
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

      • clearGenAppBuilderSettings

        public Agent.Builder clearGenAppBuilderSettings()
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

      • getGenAppBuilderSettingsBuilder

        public Agent.GenAppBuilderSettings.Builder getGenAppBuilderSettingsBuilder()
         Gen App Builder-related agent-level settings.
        optional .google.cloud.dialogflow.cx.v3.Agent.GenAppBuilderSettings gen_app_builder_settings = 33;

      • setUnknownFields

        public final Agent.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<Agent.Builder>

      • mergeUnknownFields

        public final Agent.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<Agent.Builder>