Reference documentation and code samples for the BigQuery Data Transfer Service V1 API class Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter.
A parameter used to define custom fields in a data source definition.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allowed_values
def allowed_values() -> ::Array<::String>
Returns
- (::Array<::String>) — All possible values for the parameter.
#allowed_values=
def allowed_values=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — All possible values for the parameter.
Returns
- (::Array<::String>) — All possible values for the parameter.
#deprecated
def deprecated() -> ::Boolean
Returns
- (::Boolean) — If true, it should not be used in new transfers, and it should not be visible to users.
#deprecated=
def deprecated=(value) -> ::Boolean
Parameter
- value (::Boolean) — If true, it should not be used in new transfers, and it should not be visible to users.
Returns
- (::Boolean) — If true, it should not be used in new transfers, and it should not be visible to users.
#description
def description() -> ::String
Returns
- (::String) — Parameter description.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Parameter description.
Returns
- (::String) — Parameter description.
#display_name
def display_name() -> ::String
Returns
- (::String) — Parameter display name in the user interface.
#display_name=
def display_name=(value) -> ::String
Parameter
- value (::String) — Parameter display name in the user interface.
Returns
- (::String) — Parameter display name in the user interface.
#fields
def fields() -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>
Returns
- (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>) — Deprecated. This field has no effect.
#fields=
def fields=(value) -> ::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>
Parameter
- value (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>) — Deprecated. This field has no effect.
Returns
- (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter>) — Deprecated. This field has no effect.
#immutable
def immutable() -> ::Boolean
Returns
- (::Boolean) — Cannot be changed after initial creation.
#immutable=
def immutable=(value) -> ::Boolean
Parameter
- value (::Boolean) — Cannot be changed after initial creation.
Returns
- (::Boolean) — Cannot be changed after initial creation.
#max_value
def max_value() -> ::Google::Protobuf::DoubleValue
Returns
- (::Google::Protobuf::DoubleValue) — For integer and double values specifies maximum allowed value.
#max_value=
def max_value=(value) -> ::Google::Protobuf::DoubleValue
Parameter
- value (::Google::Protobuf::DoubleValue) — For integer and double values specifies maximum allowed value.
Returns
- (::Google::Protobuf::DoubleValue) — For integer and double values specifies maximum allowed value.
#min_value
def min_value() -> ::Google::Protobuf::DoubleValue
Returns
- (::Google::Protobuf::DoubleValue) — For integer and double values specifies minimum allowed value.
#min_value=
def min_value=(value) -> ::Google::Protobuf::DoubleValue
Parameter
- value (::Google::Protobuf::DoubleValue) — For integer and double values specifies minimum allowed value.
Returns
- (::Google::Protobuf::DoubleValue) — For integer and double values specifies minimum allowed value.
#param_id
def param_id() -> ::String
Returns
- (::String) — Parameter identifier.
#param_id=
def param_id=(value) -> ::String
Parameter
- value (::String) — Parameter identifier.
Returns
- (::String) — Parameter identifier.
#recurse
def recurse() -> ::Boolean
Returns
- (::Boolean) — Deprecated. This field has no effect.
#recurse=
def recurse=(value) -> ::Boolean
Parameter
- value (::Boolean) — Deprecated. This field has no effect.
Returns
- (::Boolean) — Deprecated. This field has no effect.
#repeated
def repeated() -> ::Boolean
Returns
- (::Boolean) — Deprecated. This field has no effect.
#repeated=
def repeated=(value) -> ::Boolean
Parameter
- value (::Boolean) — Deprecated. This field has no effect.
Returns
- (::Boolean) — Deprecated. This field has no effect.
#required
def required() -> ::Boolean
Returns
- (::Boolean) — Is parameter required.
#required=
def required=(value) -> ::Boolean
Parameter
- value (::Boolean) — Is parameter required.
Returns
- (::Boolean) — Is parameter required.
#type
def type() -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type) — Parameter type.
#type=
def type=(value) -> ::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type
Parameter
- value (::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type) — Parameter type.
Returns
- (::Google::Cloud::Bigquery::DataTransfer::V1::DataSourceParameter::Type) — Parameter type.
#validation_description
def validation_description() -> ::String
Returns
- (::String) — Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
#validation_description=
def validation_description=(value) -> ::String
Parameter
- value (::String) — 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.
#validation_help_url
def validation_help_url() -> ::String
Returns
- (::String) — URL to a help document to further explain the naming requirements.
#validation_help_url=
def validation_help_url=(value) -> ::String
Parameter
- value (::String) — URL to a help document to further explain the naming requirements.
Returns
- (::String) — URL to a help document to further explain the naming requirements.
#validation_regex
def validation_regex() -> ::String
Returns
- (::String) — Regular expression which can be used for parameter validation.
#validation_regex=
def validation_regex=(value) -> ::String
Parameter
- value (::String) — Regular expression which can be used for parameter validation.
Returns
- (::String) — Regular expression which can be used for parameter validation.