google_api_big_query_data_transfer v0.8.0 GoogleApi.BigQueryDataTransfer.V1.Model.DataSourceParameter View Source

Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.

Attributes

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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.