Google is committed to advancing racial equity for Black communities. See how.

Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder

The builder for BigQueryDataSourceSpecBuilder.

Methods

MethodReturn typeBrief description
build()DataSourceSpecBuilds a data source specification from the settings in this builder.
copy()DataSourceSpecBuilderCreates a DataSourceSpecBuilder based on this data source's settings.
getDatasetId()StringGets the BigQuery dataset ID.
getParameters()DataSourceParameter[]Gets the parameters of the data source.
getProjectId()StringGets the billing project ID.
getRawQuery()StringGets the raw query string.
getTableId()StringGets the BigQuery table ID.
getTableProjectId()StringGets the BigQuery project ID for the table.
getType()DataSourceTypeGets the type of the data source.
removeAllParameters()BigQueryDataSourceSpecBuilderRemoves all the parameters.
removeParameter(parameterName)BigQueryDataSourceSpecBuilderRemoves the specified parameter.
setDatasetId(datasetId)BigQueryDataSourceSpecBuilderSets the BigQuery dataset ID.
setParameterFromCell(parameterName, sourceCell)BigQueryDataSourceSpecBuilderAdds a parameter, or if the parameter with the name exists, updates its source cell.
setProjectId(projectId)BigQueryDataSourceSpecBuilderSets the billing BigQuery project ID.
setRawQuery(rawQuery)BigQueryDataSourceSpecBuilderSets the raw query string.
setTableId(tableId)BigQueryDataSourceSpecBuilderSets the BigQuery table ID.
setTableProjectId(projectId)BigQueryDataSourceSpecBuilderSets the BigQuery project ID for the table.

Detailed documentation

build()

Builds a data source specification from the settings in this builder. Must use as...() to specify a data source type before building.

Return

DataSourceSpec — The data source specification.


copy()

Creates a DataSourceSpecBuilder based on this data source's settings.

Return

DataSourceSpecBuilder — The builder.


getDatasetId()

Gets the BigQuery dataset ID.

Return

String — The dataset ID, or an empty string if the data source spec is defined by a raw query.


getParameters()

Gets the parameters of the data source.

Return

DataSourceParameter[] — The parameter list.


getProjectId()

Gets the billing project ID.

Return

String — The project ID.


getRawQuery()

Gets the raw query string.

Return

String — The raw query string.


getTableId()

Gets the BigQuery table ID.

Return

String — The table ID, or an empty string if the data source spec is defined by a raw query.


getTableProjectId()

Gets the BigQuery project ID for the table.

Return

String — The table project ID, or an empty string if the data source spec is defined by a raw query.


getType()

Gets the type of the data source.

Return

DataSourceType — The data source type.


removeAllParameters()

Removes all the parameters.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.


removeParameter(parameterName)

Removes the specified parameter.

Parameters

NameTypeDescription
parameterNameStringThe name of the parameter to remove.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.


setDatasetId(datasetId)

Sets the BigQuery dataset ID.

Parameters

NameTypeDescription
datasetIdStringThe ID of the dataset.

Return

BigQueryDataSourceSpecBuilder — This builder, for chaining.


setParameterFromCell(parameterName, sourceCell)

Adds a parameter, or if the parameter with the name exists, updates its source cell.

Parameters

NameTypeDescription
parameterNameStringThe parameter name.
sourceCellStringThe source cell, as specified in A1 notation.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.


setProjectId(projectId)

Sets the billing BigQuery project ID.

Parameters

NameTypeDescription
projectIdStringThe ID of the billing project.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.


setRawQuery(rawQuery)

Sets the raw query string.

Parameters

NameTypeDescription
rawQueryStringThe raw query string.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.


setTableId(tableId)

Sets the BigQuery table ID.

Parameters

NameTypeDescription
tableIdStringThe ID of the table.

Return

BigQueryDataSourceSpecBuilder — This builder, for chaining.


setTableProjectId(projectId)

Sets the BigQuery project ID for the table.

Parameters

NameTypeDescription
projectIdStringThe project ID of the BigQuery table.

Return

BigQueryDataSourceSpecBuilder — The builder, for chaining.