Class ConnectionSettings (2.35.0)

public abstract class ConnectionSettings

ConnectionSettings for setting up a BigQuery query connection.

Inheritance

java.lang.Object > ConnectionSettings

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static ConnectionSettings.Builder newBuilder()

Returns a builder for a ConnectionSettings object.

Returns
Type	Description
`ConnectionSettings.Builder`

Methods

getAllowLargeResults()

public abstract Boolean getAllowLargeResults()

Returns 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. the query is allowed to create large results at a slight cost in performance. See Also: Returning Large Query Results

Returns
Type	Description
`Boolean`

getClustering()

public abstract Clustering getClustering()

Returns the clustering specification for the destination table.

Returns
Type	Description
`Clustering`

getConnectionProperties()

public abstract List<ConnectionProperty> getConnectionProperties()

Returns the connection properties for connection string with this query

Returns
Type	Description
`List<ConnectionProperty>`

getCreateDisposition()

public abstract JobInfo.CreateDisposition getCreateDisposition()

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

Returns
Type	Description
`JobInfo.CreateDisposition`

getCreateSession()

public abstract Boolean getCreateSession()

Returns whether to create a new session. See Also: Create Sessions

Returns
Type	Description
`Boolean`

getDefaultDataset()

public abstract DatasetId getDefaultDataset()

Returns the default dataset

Returns
Type	Description
`DatasetId`

getDestinationEncryptionConfiguration()

public abstract EncryptionConfiguration getDestinationEncryptionConfiguration()

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

Returns
Type	Description
`EncryptionConfiguration`

getDestinationTable()

public abstract TableId getDestinationTable()

Returns the table where to put query results. If not provided a new table is created. This value is required if #getAllowLargeResults() is true.

Returns
Type	Description
`TableId`

getFlattenResults()

public abstract Boolean getFlattenResults()

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

Returns
Type	Description
`Boolean`

getJobTimeoutMs()

public abstract Long getJobTimeoutMs()

Returns the timeout associated with this job

Returns
Type	Description
`Long`

getMaxResultPerPage()

public abstract Integer getMaxResultPerPage()

Returns
Type	Description
`Integer`

getMaxResults()

public abstract Long getMaxResults()

Returns the maximum number of rows of data

Returns
Type	Description
`Long`

getMaximumBillingTier()

public abstract Integer getMaximumBillingTier()

Returns the optional billing tier limit for this job.

Returns
Type	Description
`Integer`

getMaximumBytesBilled()

public abstract Long getMaximumBytesBilled()

Returns the limits the bytes billed for this job

Returns
Type	Description
`Long`

getMinResultSize()

public abstract Integer getMinResultSize()

Returns
Type	Description
`Integer`

getNumBufferedRows()

public abstract Integer getNumBufferedRows()

Returns the number of rows of data to pre-fetch

Returns
Type	Description
`Integer`

getPriority()

public abstract QueryJobConfiguration.Priority getPriority()

Returns the query priority.

Returns
Type	Description
`QueryJobConfiguration.Priority`

getRangePartitioning()

public abstract RangePartitioning getRangePartitioning()

Returns the range partitioning specification for the table

Returns
Type	Description
`RangePartitioning`

getRequestTimeout()

public abstract Long getRequestTimeout()

Returns the synchronous response timeoutMs associated with this query

Returns
Type	Description
`Long`

getSchemaUpdateOptions()

public abstract List<JobInfo.SchemaUpdateOption> 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.

Returns
Type	Description
`List<SchemaUpdateOption>`

getTableDefinitions()

public abstract Map<String,ExternalTableDefinition> 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.

Returns
Type	Description
`Map<String,ExternalTableDefinition>`

getTimePartitioning()

public abstract TimePartitioning getTimePartitioning()

Returns the time partitioning specification for the destination table.

Returns
Type	Description
`TimePartitioning`

getTotalToPageRowCountRatio()

public abstract Integer getTotalToPageRowCountRatio()

Returns
Type	Description
`Integer`

getUseQueryCache()

public abstract Boolean getUseQueryCache()

Returns whether to look for the result in the query cache

Returns
Type	Description
`Boolean`

getUseReadAPI()

public abstract Boolean getUseReadAPI()

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

Returns
Type	Description
`Boolean`

getUserDefinedFunctions()

public abstract List<UserDefinedFunction> 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.

Returns
Type	Description
`List<UserDefinedFunction>`

getWriteDisposition()

public abstract JobInfo.WriteDisposition getWriteDisposition()

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

Returns
Type	Description
`JobInfo.WriteDisposition`

toBuilder()

public abstract ConnectionSettings.Builder toBuilder()

Returns a builder pre-populated using the current values of this field.

Returns
Type	Description
`ConnectionSettings.Builder`