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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
Google\Protobuf\DoubleValue
For integer and double values specifies minimum allowed value. |
↳ max_value |
Google\Protobuf\DoubleValue
For integer and double values specifies maximum allowed value. |
↳ fields |
array<Google\Cloud\BigQuery\DataTransfer\V1\DataSourceParameter>
Deprecated. This field has no effect. |
↳ 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.
Generated from protobuf field string param_id = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setParamId
Parameter identifier.
Generated from protobuf field string param_id = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Parameter display name in the user interface.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Parameter display name in the user interface.
Generated from protobuf field string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Parameter description.
Generated from protobuf field string description = 3;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Parameter description.
Generated from protobuf field string description = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Parameter type.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
setType
Parameter type.
Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequired
Is parameter required.
Generated from protobuf field bool required = 5;
| Returns | |
|---|---|
| Type | Description |
bool | |
setRequired
Is parameter required.
Generated from protobuf field bool required = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRepeated
Deprecated. This field has no effect.
Generated from protobuf field bool repeated = 6;
| Returns | |
|---|---|
| Type | Description |
bool | |
setRepeated
Deprecated. This field has no effect.
Generated from protobuf field bool repeated = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidationRegex
Regular expression which can be used for parameter validation.
Generated from protobuf field string validation_regex = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setValidationRegex
Regular expression which can be used for parameter validation.
Generated from protobuf field string validation_regex = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowedValues
All possible values for the parameter.
Generated from protobuf field repeated string allowed_values = 8;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAllowedValues
All possible values for the parameter.
Generated from protobuf field repeated string allowed_values = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinValue
For integer and double values specifies minimum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue min_value = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\DoubleValue|null | |
hasMinValue
clearMinValue
getMinValueValue
Returns the unboxed value from getMinValue()
For integer and double values specifies minimum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue min_value = 9;
| Returns | |
|---|---|
| Type | Description |
float|null | |
setMinValue
For integer and double values specifies minimum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue min_value = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\DoubleValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setMinValueValue
Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.
For integer and double values specifies minimum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue min_value = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
float|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxValue
For integer and double values specifies maximum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue max_value = 10;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\DoubleValue|null | |
hasMaxValue
clearMaxValue
getMaxValueValue
Returns the unboxed value from getMaxValue()
For integer and double values specifies maximum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue max_value = 10;
| Returns | |
|---|---|
| Type | Description |
float|null | |
setMaxValue
For integer and double values specifies maximum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue max_value = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\DoubleValue
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setMaxValueValue
Sets the field by wrapping a primitive type in a Google\Protobuf\DoubleValue object.
For integer and double values specifies maximum allowed value.
Generated from protobuf field .google.protobuf.DoubleValue max_value = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
float|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFields
Deprecated. This field has no effect.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setFields
Deprecated. This field has no effect.
Generated from protobuf field repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BigQuery\DataTransfer\V1\DataSourceParameter>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidationDescription
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
Generated from protobuf field string validation_description = 12;
| Returns | |
|---|---|
| Type | Description |
string | |
setValidationDescription
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
Generated from protobuf field string validation_description = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getValidationHelpUrl
URL to a help document to further explain the naming requirements.
Generated from protobuf field string validation_help_url = 13;
| Returns | |
|---|---|
| Type | Description |
string | |
setValidationHelpUrl
URL to a help document to further explain the naming requirements.
Generated from protobuf field string validation_help_url = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getImmutable
Cannot be changed after initial creation.
Generated from protobuf field bool immutable = 14;
| Returns | |
|---|---|
| Type | Description |
bool | |
setImmutable
Cannot be changed after initial creation.
Generated from protobuf field bool immutable = 14;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRecurse
Deprecated. This field has no effect.
Generated from protobuf field bool recurse = 15;
| Returns | |
|---|---|
| Type | Description |
bool | |
setRecurse
Deprecated. This field has no effect.
Generated from protobuf field bool recurse = 15;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeprecated
If true, it should not be used in new transfers, and it should not be visible to users.
Generated from protobuf field bool deprecated = 20;
| Returns | |
|---|---|
| Type | Description |
bool | |
setDeprecated
If true, it should not be used in new transfers, and it should not be visible to users.
Generated from protobuf field bool deprecated = 20;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |