Package com.hashicorp.cdktf.providers.google.dialogflow_agent

Class DialogflowAgent.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static DialogflowAgent.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 DialogflowAgent.Builder.

      • connection

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

      • connection

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

      • count

        @Stability(Experimental)
public DialogflowAgent.Builder count​(Number count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

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

      • defaultLanguageCode

        @Stability(Stable)
public DialogflowAgent.Builder defaultLanguageCode​(String defaultLanguageCode)
        The default language of the agent as a language tag.

        [See Language Support](https://cloud.google.com/dialogflow/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_agent#default_language_code DialogflowAgent#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 DialogflowAgent.Builder displayName​(String displayName)
        The name of this agent.

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

        Parameters:
        displayName - The name of this agent. This parameter is required.
        Returns:
        this

      • timeZone

        @Stability(Stable)
public DialogflowAgent.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_agent#time_zone DialogflowAgent#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

      • apiVersion

        @Stability(Stable)
public DialogflowAgent.Builder apiVersion​(String apiVersion)
        API version displayed in Dialogflow console.

        If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version. * API_VERSION_V1: Legacy V1 API. * API_VERSION_V2: V2 API. * API_VERSION_V2_BETA_1: V2beta1 API. Possible values: ["API_VERSION_V1", "API_VERSION_V2", "API_VERSION_V2_BETA_1"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#api_version DialogflowAgent#api_version}

        Parameters:
        apiVersion - API version displayed in Dialogflow console. This parameter is required.
        Returns:
        this

      • avatarUri

        @Stability(Stable)
public DialogflowAgent.Builder avatarUri​(String avatarUri)
        The URI of the agent's avatar, which are used throughout the Dialogflow console.

        When an image URL is entered into this field, the Dialogflow will save the image in the backend. The address of the backend image returned from the API will be shown in the [avatarUriBackend] field. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#avatar_uri DialogflowAgent#avatar_uri}

        Parameters:
        avatarUri - The URI of the agent's avatar, which are used throughout the Dialogflow console. This parameter is required.
        Returns:
        this

      • classificationThreshold

        @Stability(Stable)
public DialogflowAgent.Builder classificationThreshold​(Number classificationThreshold)
        To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold.

        If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#classification_threshold DialogflowAgent#classification_threshold}

        Parameters:
        classificationThreshold - To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public DialogflowAgent.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_agent#description DialogflowAgent#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

      • enableLogging

        @Stability(Stable)
public DialogflowAgent.Builder enableLogging​(Boolean enableLogging)
        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_agent#enable_logging DialogflowAgent#enable_logging}

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

      • enableLogging

        @Stability(Stable)
public DialogflowAgent.Builder enableLogging​(com.hashicorp.cdktf.IResolvable enableLogging)
        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_agent#enable_logging DialogflowAgent#enable_logging}

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

      • id

        @Stability(Stable)
public DialogflowAgent.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#id DialogflowAgent#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_agent#id DialogflowAgent#id}. This parameter is required.
        Returns:
        this

      • matchMode

        @Stability(Stable)
public DialogflowAgent.Builder matchMode​(String matchMode)
        Determines how intents are detected from user queries.

        • MATCH_MODE_HYBRID: Best for agents with a small number of examples in intents and/or wide use of templates syntax and composite entities.
        • MATCH_MODE_ML_ONLY: Can be used for agents with a large number of examples in intents, especially the ones using

        Parameters:
        matchMode - Determines how intents are detected from user queries. This parameter is required.
        Returns:
        this

      • project

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

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

      • supportedLanguageCodes

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

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

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

      • tier

        @Stability(Stable)
public DialogflowAgent.Builder tier​(String tier)
        The agent tier.

        If not specified, TIER_STANDARD is assumed. * TIER_STANDARD: Standard tier. * TIER_ENTERPRISE: Enterprise tier (Essentials). * TIER_ENTERPRISE_PLUS: Enterprise tier (Plus). NOTE: Due to consistency issues, the provider will not read this field from the API. Drift is possible between the Terraform state and Dialogflow if the agent tier is changed outside of Terraform. Possible values: ["TIER_STANDARD", "TIER_ENTERPRISE", "TIER_ENTERPRISE_PLUS"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_agent#tier DialogflowAgent#tier}

        Parameters:
        tier - The agent tier. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public DialogflowAgent.Builder timeouts​(DialogflowAgentTimeouts timeouts)
        timeouts block.

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

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