GoogleApi.Dataflow.V1b3.Model.ParameterMetadata (google_api_dataflow v0.53.0)

View Source

Metadata for a specific parameter.

Attributes

  • customMetadata (type: map(), default: nil) - Optional. Additional metadata for describing this parameter.
  • defaultValue (type: String.t, default: nil) - Optional. The default values will pre-populate the parameter with the given value from the proto. If default_value is left empty, the parameter will be populated with a default of the relevant type, e.g. false for a boolean.
  • enumOptions (type: list(GoogleApi.Dataflow.V1b3.Model.ParameterMetadataEnumOption.t), default: nil) - Optional. The options shown when ENUM ParameterType is specified.
  • groupName (type: String.t, default: nil) - Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.
  • helpText (type: String.t, default: nil) - Required. The help text to display for the parameter.
  • hiddenUi (type: boolean(), default: nil) - Optional. Whether the parameter should be hidden in the UI.
  • isOptional (type: boolean(), default: nil) - Optional. Whether the parameter is optional. Defaults to false.
  • label (type: String.t, default: nil) - Required. The label to display for the parameter.
  • name (type: String.t, default: nil) - Required. The name of the parameter.
  • paramType (type: String.t, default: nil) - Optional. The type of the parameter. Used for selecting input picker.
  • parentName (type: String.t, default: nil) - Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.
  • parentTriggerValues (type: list(String.t), default: nil) - Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).
  • regexes (type: list(String.t), default: nil) - Optional. Regexes that the parameter must match.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Dataflow.V1b3.Model.ParameterMetadata{
  customMetadata: map() | nil,
  defaultValue: String.t() | nil,
  enumOptions:
    [GoogleApi.Dataflow.V1b3.Model.ParameterMetadataEnumOption.t()] | nil,
  groupName: String.t() | nil,
  helpText: String.t() | nil,
  hiddenUi: boolean() | nil,
  isOptional: boolean() | nil,
  label: String.t() | nil,
  name: String.t() | nil,
  paramType: String.t() | nil,
  parentName: String.t() | nil,
  parentTriggerValues: [String.t()] | nil,
  regexes: [String.t()] | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.