Google Cloud Dataflow V1beta3 Client - Class ParameterMetadata (0.3.10)

Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class ParameterMetadata.

Metadata for a specific parameter.

Generated from protobuf message google.dataflow.v1beta3.ParameterMetadata

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the parameter.

↳ label string

Required. The label to display for the parameter.

↳ help_text string

Required. The help text to display for the parameter.

↳ is_optional bool

Optional. Whether the parameter is optional. Defaults to false.

↳ regexes array

Optional. Regexes that the parameter must match.

↳ param_type int

Optional. The type of the parameter. Used for selecting input picker.

↳ custom_metadata array|Google\Protobuf\Internal\MapField

Optional. Additional metadata for describing this parameter.

getName

Required. The name of the parameter.

Returns
TypeDescription
string

setName

Required. The name of the parameter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabel

Required. The label to display for the parameter.

Returns
TypeDescription
string

setLabel

Required. The label to display for the parameter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getHelpText

Required. The help text to display for the parameter.

Returns
TypeDescription
string

setHelpText

Required. The help text to display for the parameter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIsOptional

Optional. Whether the parameter is optional. Defaults to false.

Returns
TypeDescription
bool

setIsOptional

Optional. Whether the parameter is optional. Defaults to false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getRegexes

Optional. Regexes that the parameter must match.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setRegexes

Optional. Regexes that the parameter must match.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getParamType

Optional. The type of the parameter.

Used for selecting input picker.

Returns
TypeDescription
int

setParamType

Optional. The type of the parameter.

Used for selecting input picker.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCustomMetadata

Optional. Additional metadata for describing this parameter.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setCustomMetadata

Optional. Additional metadata for describing this parameter.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this