Package com.hashicorp.cdktf.providers.google.dialogflow_cx_agent

Class DialogflowCxAgent.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static DialogflowCxAgent.Builder create​(software.constructs.Construct scope,
                                               String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of DialogflowCxAgent.Builder.

      • connection

        @Stability(Experimental)
public DialogflowCxAgent.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public DialogflowCxAgent.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public DialogflowCxAgent.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public DialogflowCxAgent.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public DialogflowCxAgent.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public DialogflowCxAgent.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public DialogflowCxAgent.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • provisioners

        @Stability(Experimental)
public DialogflowCxAgent.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • defaultLanguageCode

        @Stability(Stable)
public DialogflowCxAgent.Builder defaultLanguageCode​(String defaultLanguageCode)
        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 updated after creation. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#default_language_code DialogflowCxAgent#default_language_code}

        Parameters:
        defaultLanguageCode - The default language of the agent as a language tag. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public DialogflowCxAgent.Builder displayName​(String displayName)
        The human-readable name of the agent, unique within the location.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#display_name DialogflowCxAgent#display_name}

        Parameters:
        displayName - The human-readable name of the agent, unique within the location. This parameter is required.
        Returns:
        this

      • location

        @Stability(Stable)
public DialogflowCxAgent.Builder location​(String location)
        The name of the location this agent is located in.

        ~> **Note:** The first time you are deploying an Agent in your project you must configure location settings. This is a one time step but at the moment you can only [configure location settings](https://cloud.google.com/dialogflow/cx/docs/concept/region#location-settings) via the Dialogflow CX console. Another options is to use global location so you don't need to manually configure location settings. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#location DialogflowCxAgent#location}

        Parameters:
        location - The name of the location this agent is located in. This parameter is required.
        Returns:
        this

      • timeZone

        @Stability(Stable)
public DialogflowCxAgent.Builder timeZone​(String timeZone)
        The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#time_zone DialogflowCxAgent#time_zone}

        Parameters:
        timeZone - The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris. This parameter is required.
        Returns:
        this

      • advancedSettings

        @Stability(Stable)
public DialogflowCxAgent.Builder advancedSettings​(DialogflowCxAgentAdvancedSettings advancedSettings)
        advanced_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#advanced_settings DialogflowCxAgent#advanced_settings}

        Parameters:
        advancedSettings - advanced_settings block. This parameter is required.
        Returns:
        this

      • avatarUri

        @Stability(Stable)
public DialogflowCxAgent.Builder avatarUri​(String avatarUri)
        The URI of the agent's avatar.

        Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#avatar_uri DialogflowCxAgent#avatar_uri}

        Parameters:
        avatarUri - The URI of the agent's avatar. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public DialogflowCxAgent.Builder description​(String description)
        The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#description DialogflowCxAgent#description}

        Parameters:
        description - The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. This parameter is required.
        Returns:
        this

      • enableSpellCorrection

        @Stability(Stable)
public DialogflowCxAgent.Builder enableSpellCorrection​(Boolean enableSpellCorrection)
        Indicates if automatic spell correction is enabled in detect intent requests.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#enable_spell_correction DialogflowCxAgent#enable_spell_correction}

        Parameters:
        enableSpellCorrection - Indicates if automatic spell correction is enabled in detect intent requests. This parameter is required.
        Returns:
        this

      • enableSpellCorrection

        @Stability(Stable)
public DialogflowCxAgent.Builder enableSpellCorrection​(com.hashicorp.cdktf.IResolvable enableSpellCorrection)
        Indicates if automatic spell correction is enabled in detect intent requests.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#enable_spell_correction DialogflowCxAgent#enable_spell_correction}

        Parameters:
        enableSpellCorrection - Indicates if automatic spell correction is enabled in detect intent requests. This parameter is required.
        Returns:
        this

      • enableStackdriverLogging

        @Stability(Stable)
public DialogflowCxAgent.Builder enableStackdriverLogging​(Boolean enableStackdriverLogging)
        Determines whether this agent should log conversation queries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#enable_stackdriver_logging DialogflowCxAgent#enable_stackdriver_logging}

        Parameters:
        enableStackdriverLogging - Determines whether this agent should log conversation queries. This parameter is required.
        Returns:
        this

      • enableStackdriverLogging

        @Stability(Stable)
public DialogflowCxAgent.Builder enableStackdriverLogging​(com.hashicorp.cdktf.IResolvable enableStackdriverLogging)
        Determines whether this agent should log conversation queries.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#enable_stackdriver_logging DialogflowCxAgent#enable_stackdriver_logging}

        Parameters:
        enableStackdriverLogging - Determines whether this agent should log conversation queries. This parameter is required.
        Returns:
        this

      • gitIntegrationSettings

        @Stability(Stable)
public DialogflowCxAgent.Builder gitIntegrationSettings​(DialogflowCxAgentGitIntegrationSettings gitIntegrationSettings)
        git_integration_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#git_integration_settings DialogflowCxAgent#git_integration_settings}

        Parameters:
        gitIntegrationSettings - git_integration_settings block. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public DialogflowCxAgent.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#id DialogflowCxAgent#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#id DialogflowCxAgent#id}. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public DialogflowCxAgent.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#project DialogflowCxAgent#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#project DialogflowCxAgent#project}. This parameter is required.
        Returns:
        this

      • securitySettings

        @Stability(Stable)
public DialogflowCxAgent.Builder securitySettings​(String securitySettings)
        Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#security_settings DialogflowCxAgent#security_settings}

        Parameters:
        securitySettings - Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/. This parameter is required.
        Returns:
        this

      • speechToTextSettings

        @Stability(Stable)
public DialogflowCxAgent.Builder speechToTextSettings​(DialogflowCxAgentSpeechToTextSettings speechToTextSettings)
        speech_to_text_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#speech_to_text_settings DialogflowCxAgent#speech_to_text_settings}

        Parameters:
        speechToTextSettings - speech_to_text_settings block. This parameter is required.
        Returns:
        this

      • supportedLanguageCodes

        @Stability(Stable)
public DialogflowCxAgent.Builder supportedLanguageCodes​(List<String> supportedLanguageCodes)
        The list of all languages supported by this agent (except for the default_language_code).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#supported_language_codes DialogflowCxAgent#supported_language_codes}

        Parameters:
        supportedLanguageCodes - The list of all languages supported by this agent (except for the default_language_code). This parameter is required.
        Returns:
        this

      • textToSpeechSettings

        @Stability(Stable)
public DialogflowCxAgent.Builder textToSpeechSettings​(DialogflowCxAgentTextToSpeechSettings textToSpeechSettings)
        text_to_speech_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#text_to_speech_settings DialogflowCxAgent#text_to_speech_settings}

        Parameters:
        textToSpeechSettings - text_to_speech_settings block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public DialogflowCxAgent.Builder timeouts​(DialogflowCxAgentTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_agent#timeouts DialogflowCxAgent#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this