Package com.hashicorp.cdktf.providers.google.dialogflow_cx_intent

Interface DialogflowCxIntentConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    DialogflowCxIntentConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:20.955Z")
@Stability(Stable)
public interface DialogflowCxIntentConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        The human-readable name of the intent, unique within the agent.

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

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters.

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

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#id DialogflowCxIntent#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.

      • getIsDefaultNegativeIntent

        @Stability(Stable)
@Nullable
default Object getIsDefaultNegativeIntent()
        Marks this as the Default Negative Intent for an agent. When you create an agent, a Default Negative Intent is created automatically. The Default Negative Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources.

        ~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_negative_intent = true' because they will compete to control a single Default Negative Intent resource in GCP. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#is_default_negative_intent DialogflowCxIntent#is_default_negative_intent}

      • getIsDefaultWelcomeIntent

        @Stability(Stable)
@Nullable
default Object getIsDefaultWelcomeIntent()
        Marks this as the Default Welcome Intent for an agent. When you create an agent, a Default Welcome Intent is created automatically. The Default Welcome Intent cannot be deleted; deleting the 'google_dialogflow_cx_intent' resource does nothing to the underlying GCP resources.

        ~> Avoid having multiple 'google_dialogflow_cx_intent' resources linked to the same agent with 'is_default_welcome_intent = true' because they will compete to control a single Default Welcome Intent resource in GCP. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#is_default_welcome_intent DialogflowCxIntent#is_default_welcome_intent}

      • getIsFallback

        @Stability(Stable)
@Nullable
default Object getIsFallback()
        Indicates whether this is a fallback intent.

        Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. To manage the fallback intent, set 'is_default_negative_intent = true' Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#is_fallback DialogflowCxIntent#is_fallback}

      • getLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getLabels()
        The key/value metadata to label an intent.

        Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#labels DialogflowCxIntent#labels}

      • getLanguageCode

        @Stability(Stable)
@Nullable
default String getLanguageCode()
        The language of the following fields in intent: Intent.training_phrases.parts.text If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#language_code DialogflowCxIntent#language_code}

      • getParameters

        @Stability(Stable)
@Nullable
default Object getParameters()
        parameters block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#parameters DialogflowCxIntent#parameters}

      • getParent

        @Stability(Stable)
@Nullable
default String getParent()
        The agent to create an intent for. Format: projects//locations//agents/.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#parent DialogflowCxIntent#parent}

      • getPriority

        @Stability(Stable)
@Nullable
default Number getPriority()
        The priority of this intent.

        Higher numbers represent higher priorities. If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the Normal priority in the console. If the supplied value is negative, the intent is ignored in runtime detect intent requests. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#priority DialogflowCxIntent#priority}

      • getTimeouts

        @Stability(Stable)
@Nullable
default DialogflowCxIntentTimeouts getTimeouts()
        timeouts block.

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

      • getTrainingPhrases

        @Stability(Stable)
@Nullable
default Object getTrainingPhrases()
        training_phrases block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_intent#training_phrases DialogflowCxIntent#training_phrases}