View Source GoogleApi.BigQueryDataTransfer.V1.Model.DataSourceParameter (google_api_big_query_data_transfer v0.28.0)

A parameter used to define custom fields in a data source definition.

Attributes

  • allowedValues (type: list(String.t), default: nil) - All possible values for the parameter.
  • deprecated (type: boolean(), default: nil) - If true, it should not be used in new transfers, and it should not be visible to users.
  • description (type: String.t, default: nil) - Parameter description.
  • displayName (type: String.t, default: nil) - Parameter display name in the user interface.
  • fields (type: list(GoogleApi.BigQueryDataTransfer.V1.Model.DataSourceParameter.t), default: nil) - Deprecated. This field has no effect.
  • immutable (type: boolean(), default: nil) - Cannot be changed after initial creation.
  • maxValue (type: float(), default: nil) - For integer and double values specifies maximum allowed value.
  • minValue (type: float(), default: nil) - For integer and double values specifies minimum allowed value.
  • paramId (type: String.t, default: nil) - Parameter identifier.
  • recurse (type: boolean(), default: nil) - Deprecated. This field has no effect.
  • repeated (type: boolean(), default: nil) - Deprecated. This field has no effect.
  • required (type: boolean(), default: nil) - Is parameter required.
  • type (type: String.t, default: nil) - Parameter type.
  • validationDescription (type: String.t, default: nil) - Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
  • validationHelpUrl (type: String.t, default: nil) - URL to a help document to further explain the naming requirements.
  • validationRegex (type: String.t, default: nil) - Regular expression which can be used for parameter validation.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.BigQueryDataTransfer.V1.Model.DataSourceParameter{
  allowedValues: [String.t()] | nil,
  deprecated: boolean() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  fields: [t()] | nil,
  immutable: boolean() | nil,
  maxValue: float() | nil,
  minValue: float() | nil,
  paramId: String.t() | nil,
  recurse: boolean() | nil,
  repeated: boolean() | nil,
  required: boolean() | nil,
  type: String.t() | nil,
  validationDescription: String.t() | nil,
  validationHelpUrl: String.t() | nil,
  validationRegex: String.t() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.