Reference documentation and code samples for the BigQuery Data Transfer V1 Client class DataSourceParameter.
A parameter used to define custom fields in a data source definition.
Generated from protobuf message google.cloud.bigquery.datatransfer.v1.DataSourceParameter
Namespace
Google \ Cloud \ BigQuery \ DataTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ param_id
string
Parameter identifier.
↳ display_name
string
Parameter display name in the user interface.
↳ description
string
Parameter description.
↳ type
int
Parameter type.
↳ required
bool
Is parameter required.
↳ repeated
bool
Deprecated. This field has no effect.
↳ validation_regex
string
Regular expression which can be used for parameter validation.
↳ allowed_values
array
All possible values for the parameter.
↳ min_value
↳ max_value
↳ fields
↳ validation_description
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
string
URL to a help document to further explain the naming requirements.
↳ immutable
bool
Cannot be changed after initial creation.
↳ recurse
bool
Deprecated. This field has no effect.
↳ deprecated
bool
If true, it should not be used in new transfers, and it should not be visible to users.
getParamId
Parameter identifier.
string
setParamId
Parameter identifier.
var
string
$this
getDisplayName
Parameter display name in the user interface.
string
setDisplayName
Parameter display name in the user interface.
var
string
$this
getDescription
Parameter description.
string
setDescription
Parameter description.
var
string
$this
getType
Parameter type.
int
setType
Parameter type.
var
int
$this
getRequired
Is parameter required.
bool
setRequired
Is parameter required.
var
bool
$this
getRepeated
Deprecated. This field has no effect.
bool
setRepeated
Deprecated. This field has no effect.
var
bool
$this
getValidationRegex
Regular expression which can be used for parameter validation.
string
setValidationRegex
Regular expression which can be used for parameter validation.
var
string
$this
getAllowedValues
All possible values for the parameter.
setAllowedValues
All possible values for the parameter.
var
string[]
$this
getMinValue
For integer and double values specifies minimum allowed value.
hasMinValue
clearMinValue
getMinValueUnwrapped
Returns the unboxed value from getMinValue()
For integer and double values specifies minimum allowed value.
float|null
setMinValue
For integer and double values specifies minimum allowed value.
$this
setMinValueUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.
For integer and double values specifies minimum allowed value.
var
float|null
$this
getMaxValue
For integer and double values specifies maximum allowed value.
hasMaxValue
clearMaxValue
getMaxValueUnwrapped
Returns the unboxed value from getMaxValue()
For integer and double values specifies maximum allowed value.
float|null
setMaxValue
For integer and double values specifies maximum allowed value.
$this
setMaxValueUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.
For integer and double values specifies maximum allowed value.
var
float|null
$this
getFields
Deprecated. This field has no effect.
setFields
Deprecated. This field has no effect.
$this
getValidationDescription
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
string
setValidationDescription
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
var
string
$this
getValidationHelpUrl
URL to a help document to further explain the naming requirements.
string
setValidationHelpUrl
URL to a help document to further explain the naming requirements.
var
string
$this
getImmutable
Cannot be changed after initial creation.
bool
setImmutable
Cannot be changed after initial creation.
var
bool
$this
getRecurse
Deprecated. This field has no effect.
bool
setRecurse
Deprecated. This field has no effect.
var
bool
$this
getDeprecated
If true, it should not be used in new transfers, and it should not be visible to users.
bool
setDeprecated
If true, it should not be used in new transfers, and it should not be visible to users.
var
bool
$this
