Class: Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb

Overview

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.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_values ⇒ Array<String>

Returns All possible values for the parameter.

Returns:

  • (Array<String>) —

    All possible values for the parameter.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#description ⇒ String

Returns Parameter description.

Returns:

  • (String) —

    Parameter description.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#display_name ⇒ String

Returns Parameter display name in the user interface.

Returns:

  • (String) —

    Parameter display name in the user interface.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#fields ⇒ Array<Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter>

Returns When parameter is a record, describes child fields.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#immutable ⇒ true, false

Returns Cannot be changed after initial creation.

Returns:

  • (true, false) —

    Cannot be changed after initial creation.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#max_value ⇒ Google::Protobuf::DoubleValue

Returns For integer and double values specifies maxminum allowed value.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#min_value ⇒ Google::Protobuf::DoubleValue

Returns For integer and double values specifies minimum allowed value.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#param_id ⇒ String

Returns Parameter identifier.

Returns:

  • (String) —

    Parameter identifier.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#recurse ⇒ true, false

Returns If set to true, schema should be taken from the parent with the same parameter_id. Only applicable when parameter type is RECORD.

Returns:

  • (true, false) —

    If set to true, schema should be taken from the parent with the same parameter_id. Only applicable when parameter type is RECORD.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#repeated ⇒ true, false

Returns Can parameter have multiple values.

Returns:

  • (true, false) —

    Can parameter have multiple values.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#required ⇒ true, false

Returns Is parameter required.

Returns:

  • (true, false) —

    Is parameter required.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#type ⇒ Google::Cloud::Bigquery::Datatransfer::V1::DataSourceParameter::Type

Returns Parameter type.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#validation_description ⇒ String

Returns Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

Returns:

  • (String) —

    Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#validation_help_url ⇒ String

Returns URL to a help document to further explain the naming requirements.

Returns:

  • (String) —

    URL to a help document to further explain the naming requirements.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end

#validation_regex ⇒ String

Returns Regular expression which can be used for parameter validation.

Returns:

  • (String) —

    Regular expression which can be used for parameter validation.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/doc/google/cloud/bigquery/datatransfer/v1/datatransfer.rb', line 74

class DataSourceParameter
  # Parameter type.
  module Type
    # Type unspecified.
    TYPE_UNSPECIFIED = 0

    # String parameter.
    STRING = 1

    # Integer parameter (64-bits).
    # Will be serialized to json as string.
    INTEGER = 2

    # Double precision floating point parameter.
    DOUBLE = 3

    # Boolean parameter.
    BOOLEAN = 4

    # Record parameter.
    RECORD = 5

    # Page ID for a Google+ Page.
    PLUS_PAGE = 6
  end
end