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

Class Agent

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

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_LANGUAGE_CODE_FIELD_NUMBER

        public static final int DEFAULT_LANGUAGE_CODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER

        public static final int SUPPORTED_LANGUAGE_CODES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AVATAR_URI_FIELD_NUMBER

        public static final int AVATAR_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER

        public static final int SPEECH_TO_TEXT_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_FLOW_FIELD_NUMBER

        public static final int START_FLOW_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SECURITY_SETTINGS_FIELD_NUMBER

        public static final int SECURITY_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER

        public static final int ENABLE_STACKDRIVER_LOGGING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_SPELL_CORRECTION_FIELD_NUMBER

        public static final int ENABLE_SPELL_CORRECTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADVANCED_SETTINGS_FIELD_NUMBER

        public static final int ADVANCED_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GIT_INTEGRATION_SETTINGS_FIELD_NUMBER

        public static final int GIT_INTEGRATION_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER

        public static final int TEXT_TO_SPEECH_SETTINGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GEN_APP_BUILDER_SETTINGS_FIELD_NUMBER

        public static final int GEN_APP_BUILDER_SETTINGS_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 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      • 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 Agent parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Agent.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Agent getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Agent> 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 Agent getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder