Class ConnectionSettings.Builder (2.46.0)

Creates a ConnectionSettings object.

Sets whether the job is enabled to create arbitrarily large results. If true the query is allowed to create large results at a slight cost in performance. If true ConnectionSettings.Builder#setDestinationTable(TableId) must be provided. See Also: Returning Large Query Results

Sets the clustering specification for the destination table.

Sets a connection-level property to customize query behavior.

Sets whether the job is allowed to create tables. See Also: Create Disposition

Sets whether to create a new session. If true a random session id will be generated by BigQuery. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode."

Sets the default dataset. This dataset is used for all unqualified table names used in the query.

Sets the custom encryption configuration (e.g., Cloud KMS keys).

Sets the table where to put query results. If not provided a new table is created. This value is required if ConnectionSettings.Builder#setAllowLargeResults(Boolean) is set to true.

Sets whether nested and repeated fields should be flattened. If set to false ConnectionSettings.Builder#setAllowLargeResults(Boolean) must be true. By default results are flattened. See Also: Flatten

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

Sets the maximum records per page to be used for pagination. This is used as an input for the tabledata.list and jobs.getQueryResults RPC calls

Sets the maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.

Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

Sets the minimum result size for which the Read API will be enabled

Sets the number of rows in the buffer (a blocking queue) that query results are consumed from.

Sets a priority for the query. If not specified the priority is assumed to be Priority#INTERACTIVE.

Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

Sets how long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).

[Experimental] Sets options allowing the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema.

Sets the external tables definitions. If querying external data sources outside of BigQuery, this value describes the data format, location and other properties of the data sources. By defining these properties, the data sources can be queried as if they were standard BigQuery tables.

Sets the time partitioning specification for the destination table.

Sets a ratio of the total number of records and the records returned in the current page. This value is checked before calling the Read API

Sets whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when ConnectionSettings.Builder#setDestinationTable(TableId) is not set. See Also: Query Caching

Sets useReadAPI flag, enabled by default. Read API will be used if the underlying conditions are satisfied and this flag is enabled

Sets user defined function resources that can be used by this query. Function resources can either be defined inline (UserDefinedFunction#inline(String)) or loaded from a Google Cloud Storage URI (UserDefinedFunction#fromUri(String).

Sets the action that should occur if the destination table already exists. See Also: Write Disposition