As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

google.cloud.bigquery.query.StructQueryParameter

class google.cloud.bigquery.query.StructQueryParameter(name, *sub_params)[source]

Named / positional query parameters for struct values.

Parameters
  • name (Optional[str]) – Parameter name, used via @foo syntax. If None, the parameter can only be addressed via position (?).

  • (Union[Tuple[ (sub_params) – google.cloud.bigquery.query.ScalarQueryParameter, google.cloud.bigquery.query.ArrayQueryParameter, google.cloud.bigquery.query.StructQueryParameter

  • ]]) – The sub-parameters for the struct

__init__(name, *sub_params)[source]

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

Methods

__init__(name, *sub_params)

Initialize self.

from_api_repr(resource)

Factory: construct parameter from JSON resource.

positional(*sub_params)

Factory for positional parameters.

to_api_repr()

Construct JSON API representation for the parameter.

classmethod from_api_repr(resource: dict)google.cloud.bigquery.query.StructQueryParameter[source]

Factory: construct parameter from JSON resource.

Parameters

resource (Dict) – JSON mapping of parameter

Returns

Instance

Return type

google.cloud.bigquery.query.StructQueryParameter

classmethod positional(*sub_params)[source]

Factory for positional parameters.

Parameters
  • (Union[Tuple[ (sub_params) – google.cloud.bigquery.query.ScalarQueryParameter, google.cloud.bigquery.query.ArrayQueryParameter, google.cloud.bigquery.query.StructQueryParameter

  • ]]) – The sub-parameters for the struct

Returns

Instance without name

Return type

google.cloud.bigquery.query.StructQueryParameter

to_api_repr()dict[source]

Construct JSON API representation for the parameter.

Returns

JSON mapping

Return type

Dict