google_api_big_query_data_transfer v0.5.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 ([String.t]): All possible values for the parameter. Defaults to: null.
description (String.t): Parameter description. Defaults to: null.
displayName (String.t): Parameter display name in the user interface. Defaults to: null.
fields ([DataSourceParameter]): Deprecated. This field has no effect. Defaults to: null.
immutable (boolean()): Cannot be changed after initial creation. Defaults to: null.
maxValue (float()): For integer and double values specifies maxminum allowed value. Defaults to: null.
minValue (float()): For integer and double values specifies minimum allowed value. Defaults to: null.
paramId (String.t): Parameter identifier. Defaults to: null.
recurse (boolean()): Deprecated. This field has no effect. Defaults to: null.
repeated (boolean()): Deprecated. This field has no effect. Defaults to: null.
required (boolean()): Is parameter required. Defaults to: null.
type (String.t): Parameter type. Defaults to: null.
- Enum - one of [TYPE_UNSPECIFIED, STRING, INTEGER, DOUBLE, BOOLEAN, RECORD, PLUS_PAGE]
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: null.
validationHelpUrl (String.t): URL to a help document to further explain the naming requirements. Defaults to: null.
validationRegex (String.t): Regular expression which can be used for parameter validation. Defaults to: null.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

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

Link to this section Functions