Class ScalarQueryParameterType (2.27.1)

Stay organized with collections Save and categorize content based on your preferences.
ScalarQueryParameterType(type_, *, name=None, description=None)

Type representation for scalar query parameters.

Parameters

NameDescription
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
NameDescription
resource Dict

JSON mapping of parameter

Returns
TypeDescription
google.cloud.bigquery.query.ScalarQueryParameterTypeInstance

to_api_repr

to_api_repr()

Construct JSON API representation for the parameter type.

Returns
TypeDescription
DictJSON mapping

with_name

with_name(new_name: Optional[str])

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

Parameter
NameDescription
name Union[str, None]

The new name of the query parameter type. If None, the existing name is cleared.

Returns
TypeDescription
google.cloud.bigquery.query.ScalarQueryParameterTypeA new instance with updated name.

__init__

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

Initialize self. See help(type(self)) for accurate signature.

ScalarQueryParameterType

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

Type representation for scalar query parameters.

Parameters
NameDescription
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.