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

Interface AgentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Agent, Agent.Builder
    public interface AgentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        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;
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Required. The human-readable name of the agent, unique within the location.
        string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The displayName.

      • getDisplayNameBytes

        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];
        Returns:
        The bytes for displayName.

      • getDefaultLanguageCode

        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];
        Returns:
        The defaultLanguageCode.

      • getDefaultLanguageCodeBytes

        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];
        Returns:
        The bytes for defaultLanguageCode.

      • getSupportedLanguageCodesList

        List<String> getSupportedLanguageCodesList()
         The list of all languages supported by the agent (except for the
 `default_language_code`).
        repeated string supported_language_codes = 4;
        Returns:
        A list containing the supportedLanguageCodes.

      • getSupportedLanguageCodesCount

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

      • getSupportedLanguageCodes

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The supportedLanguageCodes at the given index.

      • getSupportedLanguageCodesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the supportedLanguageCodes at the given index.

      • getTimeZone

        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];
        Returns:
        The timeZone.

      • getTimeZoneBytes

        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];
        Returns:
        The bytes for timeZone.

      • getDescription

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

      • getDescriptionBytes

        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;
        Returns:
        The bytes for description.

      • getAvatarUri

        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;
        Returns:
        The avatarUri.

      • getAvatarUriBytes

        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;
        Returns:
        The bytes for avatarUri.

      • hasSpeechToTextSettings

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

      • getSpeechToTextSettings

        SpeechToTextSettings getSpeechToTextSettings()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;
        Returns:
        The speechToTextSettings.

      • getSpeechToTextSettingsOrBuilder

        SpeechToTextSettingsOrBuilder getSpeechToTextSettingsOrBuilder()
         Speech recognition related settings.
        .google.cloud.dialogflow.cx.v3.SpeechToTextSettings speech_to_text_settings = 13;

      • getStartFlow

        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) = { ... }
        Returns:
        The startFlow.

      • getStartFlowBytes

        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) = { ... }
        Returns:
        The bytes for startFlow.

      • getSecuritySettings

        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) = { ... }
        Returns:
        The securitySettings.

      • getSecuritySettingsBytes

        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) = { ... }
        Returns:
        The bytes for securitySettings.

      • getEnableStackdriverLogging

        @Deprecated
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];
        Returns:
        The enableStackdriverLogging.

      • getEnableSpellCorrection

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

      • getLocked

        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;
        Returns:
        The locked.

      • hasAdvancedSettings

        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;
        Returns:
        Whether the advancedSettings field is set.

      • getAdvancedSettings

        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;
        Returns:
        The advancedSettings.

      • getAdvancedSettingsOrBuilder

        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;

      • hasGitIntegrationSettings

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

      • getGitIntegrationSettings

        Agent.GitIntegrationSettings getGitIntegrationSettings()
         Git integration settings for this agent.
        .google.cloud.dialogflow.cx.v3.Agent.GitIntegrationSettings git_integration_settings = 30;
        Returns:
        The gitIntegrationSettings.

      • getGitIntegrationSettingsOrBuilder

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

      • hasTextToSpeechSettings

        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;
        Returns:
        Whether the textToSpeechSettings field is set.

      • getTextToSpeechSettings

        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;
        Returns:
        The textToSpeechSettings.

      • getTextToSpeechSettingsOrBuilder

        TextToSpeechSettingsOrBuilder getTextToSpeechSettingsOrBuilder()
         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

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

      • getGenAppBuilderSettings

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

      • getGenAppBuilderSettingsOrBuilder

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