Package com.hashicorp.cdktf.providers.google.dialogflow_cx_flow

Interface DialogflowCxFlowConfig

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

    • Method Detail

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        The human-readable name of the flow.

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

      • getAdvancedSettings

        @Stability(Stable)
@Nullable
default DialogflowCxFlowAdvancedSettings getAdvancedSettings()
        advanced_settings block.

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

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        The description of the flow. 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_flow#description DialogflowCxFlow#description}

      • getEventHandlers

        @Stability(Stable)
@Nullable
default Object getEventHandlers()
        event_handlers block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_flow#event_handlers DialogflowCxFlow#event_handlers}

      • 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_flow#id DialogflowCxFlow#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.

      • getIsDefaultStartFlow

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

        ~> Avoid having multiple 'google_dialogflow_cx_flow' resources linked to the same agent with 'is_default_start_flow = true' because they will compete to control a single Default Start Flow resource in GCP. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_flow#is_default_start_flow DialogflowCxFlow#is_default_start_flow}

      • getLanguageCode

        @Stability(Stable)
@Nullable
default String getLanguageCode()
        The language of the following fields in flow: Flow.event_handlers.trigger_fulfillment.messages Flow.event_handlers.trigger_fulfillment.conditional_cases Flow.transition_routes.trigger_fulfillment.messages Flow.transition_routes.trigger_fulfillment.conditional_cases 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_flow#language_code DialogflowCxFlow#language_code}

      • getNluSettings

        @Stability(Stable)
@Nullable
default DialogflowCxFlowNluSettings getNluSettings()
        nlu_settings block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_flow#nlu_settings DialogflowCxFlow#nlu_settings}

      • getParent

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

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

      • getTimeouts

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

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

      • getTransitionRouteGroups

        @Stability(Stable)
@Nullable
default List<String> getTransitionRouteGroups()
        A flow's transition route group serve two purposes: They are responsible for matching the user's first utterances in the flow.

        They are inherited by every page's [transition route groups][Page.transition_route_groups]. Transition route groups defined in the page have higher priority than those defined in the flow. Format:projects//locations//agents//flows//transitionRouteGroups/. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_flow#transition_route_groups DialogflowCxFlow#transition_route_groups}

      • getTransitionRoutes

        @Stability(Stable)
@Nullable
default Object getTransitionRoutes()
        transition_routes block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dialogflow_cx_flow#transition_routes DialogflowCxFlow#transition_routes}