ConnectionSettings (BigQuery Parent 2.29.0 API)

java.lang.Object
- com.google.cloud.bigquery.ConnectionSettings

```
public abstract class ConnectionSettings
extends Object
```
ConnectionSettings for setting up a BigQuery query connection.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConnectionSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnectionSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Boolean`	`getAllowLargeResults()` Returns whether the job is enabled to create arbitrarily large results.
`abstract Clustering`	`getClustering()` Returns the clustering specification for the destination table.
`abstract List<ConnectionProperty>`	`getConnectionProperties()` Returns the connection properties for connection string with this query
`abstract JobInfo.CreateDisposition`	`getCreateDisposition()` Returns whether the job is allowed to create new tables.
`abstract Boolean`	`getCreateSession()` Returns whether to create a new session.
`abstract DatasetId`	`getDefaultDataset()` Returns the default dataset
`abstract EncryptionConfiguration`	`getDestinationEncryptionConfiguration()` Returns the custom encryption configuration (e.g., Cloud KMS keys)
`abstract TableId`	`getDestinationTable()` Returns the table where to put query results.
`abstract Boolean`	`getFlattenResults()` Returns whether nested and repeated fields should be flattened.
`abstract Long`	`getJobTimeoutMs()` Returns the timeout associated with this job
`abstract Integer`	`getMaximumBillingTier()` Returns the optional billing tier limit for this job.
`abstract Long`	`getMaximumBytesBilled()` Returns the limits the bytes billed for this job
`abstract Integer`	`getMaxResultPerPage()`
`abstract Long`	`getMaxResults()` Returns the maximum number of rows of data
`abstract Integer`	`getMinResultSize()`
`abstract Integer`	`getNumBufferedRows()` Returns the number of rows of data to pre-fetch
`abstract QueryJobConfiguration.Priority`	`getPriority()` Returns the query priority.
`abstract RangePartitioning`	`getRangePartitioning()` Returns the range partitioning specification for the table
`abstract Long`	`getRequestTimeout()` Returns the synchronous response timeoutMs associated with this query
`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.
`abstract Map<String,ExternalTableDefinition>`	`getTableDefinitions()` Returns the external tables definitions.
`abstract TimePartitioning`	`getTimePartitioning()` Returns the time partitioning specification for the destination table.
`abstract Integer`	`getTotalToPageRowCountRatio()`
`abstract Boolean`	`getUseQueryCache()` Returns whether to look for the result in the query cache
`abstract List<UserDefinedFunction>`	`getUserDefinedFunctions()` Returns user defined function resources that can be used by this query.
`abstract Boolean`	`getUseReadAPI()` Returns useReadAPI flag, enabled by default.
`abstract JobInfo.WriteDisposition`	`getWriteDisposition()` Returns the action that should occur if the destination table already exists.
`static ConnectionSettings.Builder`	`newBuilder()` Returns a builder for a `ConnectionSettings` object.
`abstract ConnectionSettings.Builder`	`toBuilder()` Returns a builder pre-populated using the current values of this field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getUseReadAPI
```
@Nullable
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
  - getRequestTimeout
```
@Nullable
public abstract Long getRequestTimeout()
```
    Returns the synchronous response timeoutMs associated with this query
  - getConnectionProperties
```
@Nullable
public abstract List<ConnectionProperty> getConnectionProperties()
```
    Returns the connection properties for connection string with this query
  - getDefaultDataset
```
@Nullable
public abstract DatasetId getDefaultDataset()
```
    Returns the default dataset
  - getMaximumBytesBilled
```
@Nullable
public abstract Long getMaximumBytesBilled()
```
    Returns the limits the bytes billed for this job
  - getMaxResults
```
@Nullable
public abstract Long getMaxResults()
```
    Returns the maximum number of rows of data
  - getNumBufferedRows
```
@Nullable
public abstract Integer getNumBufferedRows()
```
    Returns the number of rows of data to pre-fetch
  - getTotalToPageRowCountRatio
```
@Nullable
public abstract Integer getTotalToPageRowCountRatio()
```
  - getMinResultSize
```
@Nullable
public abstract Integer getMinResultSize()
```
  - getMaxResultPerPage
```
@Nullable
public abstract Integer getMaxResultPerPage()
```
  - getUseQueryCache
```
@Nullable
public abstract Boolean getUseQueryCache()
```
    Returns whether to look for the result in the query cache
  - getFlattenResults
```
@Nullable
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
  - getClustering
```
@Nullable
public abstract Clustering getClustering()
```
    Returns the clustering specification for the destination table.
  - getCreateDisposition
```
@Nullable
public abstract JobInfo.CreateDisposition getCreateDisposition()
```
    Returns whether the job is allowed to create new tables.
    
    See Also:
    
    Create Disposition
  - getDestinationEncryptionConfiguration
```
@Nullable
public abstract EncryptionConfiguration getDestinationEncryptionConfiguration()
```
    Returns the custom encryption configuration (e.g., Cloud KMS keys)
  - getDestinationTable
```
@Nullable
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 allowLargeResults() is true.
  - getJobTimeoutMs
```
@Nullable
public abstract Long getJobTimeoutMs()
```
    Returns the timeout associated with this job
  - getMaximumBillingTier
```
@Nullable
public abstract Integer getMaximumBillingTier()
```
    Returns the optional billing tier limit for this job.
  - getPriority
```
@Nullable
public abstract QueryJobConfiguration.Priority getPriority()
```
    Returns the query priority.
  - getAllowLargeResults
```
@Nullable
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
  - getCreateSession
```
@Nullable
public abstract Boolean getCreateSession()
```
    Returns whether to create a new session.
    
    See Also:
    
    Create Sessions
  - getRangePartitioning
```
@Nullable
public abstract RangePartitioning getRangePartitioning()
```
    Returns the range partitioning specification for the table
  - getSchemaUpdateOptions
```
@Nullable
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.
  - getTableDefinitions
```
@Nullable
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.
  - getTimePartitioning
```
@Nullable
public abstract TimePartitioning getTimePartitioning()
```
    Returns the time partitioning specification for the destination table.
  - getUserDefinedFunctions
```
@Nullable
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.
  - getWriteDisposition
```
@Nullable
public abstract JobInfo.WriteDisposition getWriteDisposition()
```
    Returns the action that should occur if the destination table already exists.
    
    See Also:
    
    Write Disposition
  - toBuilder
```
public abstract ConnectionSettings.Builder toBuilder()
```
    Returns a builder pre-populated using the current values of this field.
  - newBuilder
```
public static ConnectionSettings.Builder newBuilder()
```
    Returns a builder for a ConnectionSettings object.

Class ConnectionSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUseReadAPI

getRequestTimeout

getConnectionProperties

getDefaultDataset

getMaximumBytesBilled

getMaxResults

getNumBufferedRows

getTotalToPageRowCountRatio

getMinResultSize

getMaxResultPerPage

getUseQueryCache

getFlattenResults

getClustering

getCreateDisposition

getDestinationEncryptionConfiguration

getDestinationTable

getJobTimeoutMs

getMaximumBillingTier

getPriority

getAllowLargeResults

getCreateSession

getRangePartitioning

getSchemaUpdateOptions

getTableDefinitions

getTimePartitioning

getUserDefinedFunctions

getWriteDisposition

toBuilder

newBuilder