Class ScalarQueryParameterType (2.29.0)

Version 2.29.0

• 3.21.0 (latest)
• 3.20.1
• 3.19.0
• 3.18.0
• 3.17.2
• 3.16.0
• 3.15.0
• 3.14.1
• 3.13.0
• 3.12.0
• 3.11.4
• 3.4.0
• 3.3.6
• 3.2.0
• 3.1.0
• 3.0.1
• 2.34.4
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.1
• 2.29.0
• 2.28.1
• 2.27.1
• 2.26.0
• 2.25.2
• 2.24.1
• 2.23.3
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.1.0
• 2.0.0
• 1.28.2
• 1.27.2
• 1.26.1
• 1.25.0
• 1.24.0
• 1.23.1
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.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.

Inheritance

builtins.object > google.cloud.bigquery.query._AbstractQueryParameterType > ScalarQueryParameterType

Methods

from_api_repr

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

to_api_repr()

Construct JSON API representation for the parameter type.

Returns

Type	Description
Dict	JSON mapping

with_name

with_name(new_name: 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.