BigQuery Data Transfer V1 Client - Class DataSourceParameter (2.0.0-RC1)

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 \ V1

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.

Returns
Type Description
string

setParamId

Parameter identifier.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Parameter display name in the user interface.

Returns
Type Description
string

setDisplayName

Parameter display name in the user interface.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Parameter description.

Returns
Type Description
string

setDescription

Parameter description.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Parameter type.

Returns
Type Description
int

setType

Parameter type.

Parameter
Name Description
var int
Returns
Type Description
$this

getRequired

Is parameter required.

Returns
Type Description
bool

setRequired

Is parameter required.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRepeated

Deprecated. This field has no effect.

Returns
Type Description
bool

setRepeated

Deprecated. This field has no effect.

Parameter
Name Description
var bool
Returns
Type Description
$this

getValidationRegex

Regular expression which can be used for parameter validation.

Returns
Type Description
string

setValidationRegex

Regular expression which can be used for parameter validation.

Parameter
Name Description
var string
Returns
Type Description
$this

getAllowedValues

All possible values for the parameter.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAllowedValues

All possible values for the parameter.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getMinValue

For integer and double values specifies minimum allowed value.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasMinValue

clearMinValue

getMinValueUnwrapped

Returns the unboxed value from getMinValue()

For integer and double values specifies minimum allowed value.

Returns
Type Description
float|null

setMinValue

For integer and double values specifies minimum allowed value.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$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.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getMaxValue

For integer and double values specifies maximum allowed value.

Returns
Type Description
Google\Protobuf\DoubleValue|null

hasMaxValue

clearMaxValue

getMaxValueUnwrapped

Returns the unboxed value from getMaxValue()

For integer and double values specifies maximum allowed value.

Returns
Type Description
float|null

setMaxValue

For integer and double values specifies maximum allowed value.

Parameter
Name Description
var Google\Protobuf\DoubleValue
Returns
Type Description
$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.

Parameter
Name Description
var float|null
Returns
Type Description
$this

getFields

Deprecated. This field has no effect.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFields

Deprecated. This field has no effect.

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.

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidationHelpUrl

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

Returns
Type Description
string

setValidationHelpUrl

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

Parameter
Name Description
var string
Returns
Type Description
$this

getImmutable

Cannot be changed after initial creation.

Returns
Type Description
bool

setImmutable

Cannot be changed after initial creation.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRecurse

Deprecated. This field has no effect.

Returns
Type Description
bool

setRecurse

Deprecated. This field has no effect.

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.

Returns
Type Description
bool

setDeprecated

If true, it should not be used in new transfers, and it should not be visible to users.

Parameter
Name Description
var bool
Returns
Type Description
$this