Class ScriptOptions (3.21.0)

Version latest

• 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

ScriptOptions(
    statement_timeout_ms: typing.Optional[int] = None,
    statement_byte_budget: typing.Optional[int] = None,
    key_result_statement: typing.Optional[
        google.cloud.bigquery.enums.KeyResultStatementKind
    ] = None,
)

Options controlling the execution of scripts.

https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#ScriptOptions

Properties

key_result_statement

Determines which statement in the script represents the "key result".

This is used to populate the schema and query results of the script job. Default is KeyResultStatementKind.LAST.

statement_byte_budget

Limit on the number of bytes billed per statement.

Exceeding this budget results in an error.

statement_timeout_ms

Timeout period for each statement in a script.

Methods

from_api_repr

from_api_repr(
    resource: typing.Dict[str, typing.Any]
) -> google.cloud.bigquery.job.query.ScriptOptions

Factory: construct instance from the JSON repr.

Returns
Type	Description
google.cloud.bigquery.ScriptOptions	ScriptOptions sample parsed from resource.

to_api_repr

to_api_repr() -> typing.Dict[str, typing.Any]

Construct the API resource representation.