View Source GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1FormParameter (google_api_dialogflow v0.88.3)

Represents a form parameter.

Attributes

  • advancedSettings (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1AdvancedSettings.t, default: nil) - Hierarchical advanced settings for this parameter. The settings exposed at the lower level overrides the settings exposed at the higher level.
  • defaultValue (type: any(), default: nil) - The default value of an optional parameter. If the parameter is required, the default value will be ignored.
  • displayName (type: String.t, default: nil) - Required. The human-readable name of the parameter, unique within the form.
  • entityType (type: String.t, default: nil) - Required. The entity type of the parameter. Format: projects/-/locations/-/agents/-/entityTypes/ for system entity types (for example, projects/-/locations/-/agents/-/entityTypes/sys.date), or projects//locations//agents//entityTypes/ for developer entity types.
  • fillBehavior (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior.t, default: nil) - Required. Defines fill behavior for the parameter.
  • isList (type: boolean(), default: nil) - Indicates whether the parameter represents a list of values.
  • redact (type: boolean(), default: nil) - Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
  • required (type: boolean(), default: nil) - Indicates whether the parameter is required. Optional parameters will not trigger prompts; however, they are filled if the user specifies them. Required parameters must be filled before form filling concludes.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1FormParameter{
    advancedSettings:
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1AdvancedSettings.t()
      | nil,
    defaultValue: any() | nil,
    displayName: String.t() | nil,
    entityType: String.t() | nil,
    fillBehavior:
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3beta1FormParameterFillBehavior.t()
      | nil,
    isList: boolean() | nil,
    redact: boolean() | nil,
    required: boolean() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.