Class ScalarQueryParameterType (3.26.0)

ScalarQueryParameterType(type_, *, name=None, description=None)

Type representation for scalar query parameters.

Parameters
Name	Description
`type_`	`str` One of 'STRING', 'INT64', 'FLOAT64', 'NUMERIC', 'BOOL', 'TIMESTAMP', 'DATETIME', or 'DATE'.
`name`	`Optional[str]` The name of the query parameter. Primarily used if the type is one of the subfields in `StructQueryParameterType` instance.
`description`	`Optional[str]` The query parameter description. Primarily used if the type is one of the subfields in `StructQueryParameterType` instance.

Methods

from_api_repr(resource)

Factory: construct parameter type from JSON resource.

Parameter
Name	Description
`resource`	`Dict` JSON mapping of parameter

Returns
Type	Description
`google.cloud.bigquery.query.ScalarQueryParameterType`	Instance

to_api_repr()

Construct JSON API representation for the parameter type.

Returns
Type	Description
`Dict`	JSON mapping

with_name(new_name: typing.Optional[str])

Return a copy of the instance with name set to new_name.

Parameter
Name	Description
`name`	`Union[str, None]` The new name of the query parameter type. If `None`, the existing name is cleared.

Returns
Type	Description
`google.cloud.bigquery.query.ScalarQueryParameterType`	A new instance with updated name.