Class StructQueryParameterType (3.3.0)

StructQueryParameterType(*fields, name=None, description=None)

Type representation for struct query parameters.

Parameters

NameDescription
fields Iterable[Union[ ArrayQueryParameterType, ScalarQueryParameterType, StructQueryParameterType ]]

An non-empty iterable describing the struct's field types.

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 > StructQueryParameterType

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.StructQueryParameterTypeInstance

to_api_repr

to_api_repr()

Construct JSON API representation for the parameter type.

Returns
TypeDescription
DictJSON mapping