Package com.google.cloud.bigquery
Class ConnectionSettings
java.lang.Object
com.google.cloud.bigquery.ConnectionSettings
ConnectionSettings for setting up a BigQuery query connection.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract Boolean
Returns whether the job is enabled to create arbitrarily large results.abstract Clustering
Returns the clustering specification for the destination table.abstract List<ConnectionProperty>
Returns the connection properties for connection string with this queryabstract JobInfo.CreateDisposition
Returns whether the job is allowed to create new tables.abstract Boolean
Returns whether to create a new session.abstract DatasetId
Returns the default datasetabstract EncryptionConfiguration
Returns the custom encryption configuration (e.g., Cloud KMS keys)abstract TableId
Returns the table where to put query results.abstract Boolean
Returns whether nested and repeated fields should be flattened.abstract Long
Returns the timeout associated with this jobabstract Integer
Returns the optional billing tier limit for this job.abstract Long
Returns the limits the bytes billed for this jobabstract Integer
abstract Long
Returns the maximum number of rows of dataabstract Integer
abstract Integer
Returns the number of rows of data to pre-fetchabstract QueryJobConfiguration.Priority
Returns the query priority.abstract RangePartitioning
Returns the range partitioning specification for the tableabstract Long
Returns the synchronous response timeoutMs associated with this queryabstract List<JobInfo.SchemaUpdateOption>
[Experimental] Returns options allowing the schema of the destination table to be updated as a side effect of the query job.abstract Map<String,
ExternalTableDefinition> Returns the external tables definitions.abstract TimePartitioning
Returns the time partitioning specification for the destination table.abstract Integer
abstract Boolean
Returns whether to look for the result in the query cacheabstract List<UserDefinedFunction>
Returns user defined function resources that can be used by this query.abstract Boolean
Returns useReadAPI flag, enabled by default.abstract JobInfo.WriteDisposition
Returns the action that should occur if the destination table already exists.static ConnectionSettings.Builder
Returns a builder for aConnectionSettings
object.abstract ConnectionSettings.Builder
Returns a builder pre-populated using the current values of this field.
-
Method Details
-
getUseReadAPI
Returns useReadAPI flag, enabled by default. Read API will be used if the underlying conditions are satisfied and this flag is enabled -
getRequestTimeout
Returns the synchronous response timeoutMs associated with this query -
getConnectionProperties
Returns the connection properties for connection string with this query -
getDefaultDataset
Returns the default dataset -
getMaximumBytesBilled
Returns the limits the bytes billed for this job -
getMaxResults
Returns the maximum number of rows of data -
getNumBufferedRows
Returns the number of rows of data to pre-fetch -
getTotalToPageRowCountRatio
-
getMinResultSize
-
getMaxResultPerPage
-
getUseQueryCache
Returns whether to look for the result in the query cache -
getFlattenResults
Returns whether nested and repeated fields should be flattened. If set tofalse
ConnectionSettings.Builder.setAllowLargeResults(Boolean)
must betrue
.- See Also:
-
getClustering
Returns the clustering specification for the destination table. -
getCreateDisposition
Returns whether the job is allowed to create new tables.- See Also:
-
getDestinationEncryptionConfiguration
Returns the custom encryption configuration (e.g., Cloud KMS keys) -
getDestinationTable
Returns the table where to put query results. If not provided a new table is created. This value is required ifgetAllowLargeResults()
istrue
. -
getJobTimeoutMs
Returns the timeout associated with this job -
getMaximumBillingTier
Returns the optional billing tier limit for this job. -
getPriority
Returns the query priority. -
getAllowLargeResults
Returns whether the job is enabled to create arbitrarily large results. Iftrue
the query is allowed to create large results at a slight cost in performance. the query is allowed to create large results at a slight cost in performance.- See Also:
-
getCreateSession
Returns whether to create a new session.- See Also:
-
getRangePartitioning
Returns the range partitioning specification for the table -
getSchemaUpdateOptions
[Experimental] Returns 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. -
getTableDefinitions
Returns 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. -
getTimePartitioning
Returns the time partitioning specification for the destination table. -
getUserDefinedFunctions
Returns user defined function resources that can be used by this query. Function resources can either be defined inline (UserDefinedFunction.Type.INLINE
) or loaded from a Google Cloud Storage URI (UserDefinedFunction.Type.FROM_URI
. -
getWriteDisposition
Returns the action that should occur if the destination table already exists.- See Also:
-
toBuilder
Returns a builder pre-populated using the current values of this field. -
newBuilder
Returns a builder for aConnectionSettings
object.
-