Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- bigquery.datasets.delete
- bigquery.datasets.get
- bigquery.datasets.insert
- bigquery.datasets.list
- bigquery.datasets.patch
- bigquery.datasets.update
- bigquery.jobs.cancel
- bigquery.jobs.get
- bigquery.jobs.getQueryResults
- bigquery.jobs.insert
- bigquery.jobs.list
- bigquery.jobs.query
- bigquery.projects.getServiceAccount
- bigquery.projects.list
- bigquery.tabledata.insertAll
- bigquery.tabledata.list
- bigquery.tables.delete
- bigquery.tables.get
- bigquery.tables.insert
- bigquery.tables.list
- bigquery.tables.patch
- bigquery.tables.update
- Types
- JobReference
- TableList
- DataSetListDataSetsItem
- TableDataList
- JobConfigurationTableCopy
- TableListTablesItem
- TableSchema
- ProjectList
- ExplainQueryStep
- QueryTimelineSample
- QueryParameterTypeStructTypesItem
- BigtableColumnFamily
- JobStatistics
- JobConfigurationLabels
- DataSet
- RangePartitioningRange
- JobStatisticsReservationUsageItem
- BigtableOptions
- Clustering
- ExternalDataConfiguration
- TableReference
- ModelDefinitionModelOptions
- RangePartitioning
- TableFieldSchema
- GetQueryResultsResponse
- DataSetList
- QueryRequest
- JobsListProjection
- QueryParameter
- IterationResult
- JobStatistics4
- ProjectReference
- ExplainQueryStage
- TrainingRunTrainingOptions
- BigQueryModelTraining
- JobConfigurationLoad
- JobsListStateFilter
- DataSetReference
- MaterializedViewDefinition
- TableDataInsertAllRequest
- GetServiceAccountResponse
- ProjectListProjectsItem
- BigtableColumn
- Streamingbuffer
- TableRow
- JobListJobsItem
- TimePartitioning
- QueryParameterValueStructValues
- DataSetLabels
- JobConfiguration
- Job
- EncryptionConfiguration
- TableDataInsertAllResponseInsertErrorsItem
- JobConfigurationExtract
- ModelDefinition
- JobCancelResponse
- JSONObject
- JobConfigurationQuery
- GoogleSheetsOptions
- TableDataInsertAllRequestRowsItem
- JobList
- JobConfigurationQueryTableDefinitions
- TableCell
- JobStatistics2ReservationUsageItem
- QueryParameterValue
- ViewDefinition
- UserDefinedFunctionResource
- JobStatistics2
- JobStatus
- TableLabels
- DestinationTableProperties
- DataSetAccessItem
- TableDataInsertAllResponse
- QueryParameterType
- Table
- ErrorProto
- CSVOptions
- JobStatistics3
- QueryResponse
- DataSetListDataSetsItemLabels
- TrainingRun
- TableListTablesItemView
- TableListTablesItemLabels
A data platform for customers to create, manage, share and query data.
Synopsis
- bigQueryService :: ServiceConfig
- cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- storageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_only"]
- bigQueryInsertDataScope :: Proxy '["https://www.googleapis.com/auth/bigquery.insertdata"]
- storageReadWriteScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_write"]
- bigQueryScope :: Proxy '["https://www.googleapis.com/auth/bigquery"]
- storageFullControlScope :: Proxy '["https://www.googleapis.com/auth/devstorage.full_control"]
- type BigQueryAPI = JobsInsertResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsQueryResource :<|> (JobsCancelResource :<|> (JobsGetQueryResultsResource :<|> (TablesInsertResource :<|> (TablesListResource :<|> (TablesPatchResource :<|> (TablesGetResource :<|> (TablesDeleteResource :<|> (TablesUpdateResource :<|> (TableDataListResource :<|> (TableDataInsertAllResource :<|> (ProjectsGetServiceAccountResource :<|> (ProjectsListResource :<|> (DataSetsInsertResource :<|> (DataSetsListResource :<|> (DataSetsPatchResource :<|> (DataSetsGetResource :<|> (DataSetsDeleteResource :<|> DataSetsUpdateResource))))))))))))))))))))
- module Network.Google.Resource.BigQuery.DataSets.Delete
- module Network.Google.Resource.BigQuery.DataSets.Get
- module Network.Google.Resource.BigQuery.DataSets.Insert
- module Network.Google.Resource.BigQuery.DataSets.List
- module Network.Google.Resource.BigQuery.DataSets.Patch
- module Network.Google.Resource.BigQuery.DataSets.Update
- module Network.Google.Resource.BigQuery.Jobs.Cancel
- module Network.Google.Resource.BigQuery.Jobs.Get
- module Network.Google.Resource.BigQuery.Jobs.GetQueryResults
- module Network.Google.Resource.BigQuery.Jobs.Insert
- module Network.Google.Resource.BigQuery.Jobs.List
- module Network.Google.Resource.BigQuery.Jobs.Query
- module Network.Google.Resource.BigQuery.Projects.GetServiceAccount
- module Network.Google.Resource.BigQuery.Projects.List
- module Network.Google.Resource.BigQuery.TableData.InsertAll
- module Network.Google.Resource.BigQuery.TableData.List
- module Network.Google.Resource.BigQuery.Tables.Delete
- module Network.Google.Resource.BigQuery.Tables.Get
- module Network.Google.Resource.BigQuery.Tables.Insert
- module Network.Google.Resource.BigQuery.Tables.List
- module Network.Google.Resource.BigQuery.Tables.Patch
- module Network.Google.Resource.BigQuery.Tables.Update
- data JobReference
- jobReference :: JobReference
- jrJobId :: Lens' JobReference (Maybe Text)
- jrLocation :: Lens' JobReference (Maybe Text)
- jrProjectId :: Lens' JobReference (Maybe Text)
- data TableList
- tableList :: TableList
- tlTotalItems :: Lens' TableList (Maybe Int32)
- tlEtag :: Lens' TableList (Maybe Text)
- tlNextPageToken :: Lens' TableList (Maybe Text)
- tlKind :: Lens' TableList Text
- tlTables :: Lens' TableList [TableListTablesItem]
- data DataSetListDataSetsItem
- dataSetListDataSetsItem :: DataSetListDataSetsItem
- dsldsiLocation :: Lens' DataSetListDataSetsItem (Maybe Text)
- dsldsiFriendlyName :: Lens' DataSetListDataSetsItem (Maybe Text)
- dsldsiKind :: Lens' DataSetListDataSetsItem Text
- dsldsiDataSetReference :: Lens' DataSetListDataSetsItem (Maybe DataSetReference)
- dsldsiId :: Lens' DataSetListDataSetsItem (Maybe Text)
- dsldsiLabels :: Lens' DataSetListDataSetsItem (Maybe DataSetListDataSetsItemLabels)
- data TableDataList
- tableDataList :: TableDataList
- tdlEtag :: Lens' TableDataList (Maybe Text)
- tdlKind :: Lens' TableDataList Text
- tdlRows :: Lens' TableDataList [TableRow]
- tdlPageToken :: Lens' TableDataList (Maybe Text)
- tdlTotalRows :: Lens' TableDataList (Maybe Int64)
- data JobConfigurationTableCopy
- jobConfigurationTableCopy :: JobConfigurationTableCopy
- jctcDestinationTable :: Lens' JobConfigurationTableCopy (Maybe TableReference)
- jctcWriteDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text)
- jctcSourceTables :: Lens' JobConfigurationTableCopy [TableReference]
- jctcCreateDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text)
- jctcSourceTable :: Lens' JobConfigurationTableCopy (Maybe TableReference)
- jctcDestinationEncryptionConfiguration :: Lens' JobConfigurationTableCopy (Maybe EncryptionConfiguration)
- data TableListTablesItem
- tableListTablesItem :: TableListTablesItem
- tltiCreationTime :: Lens' TableListTablesItem (Maybe Int64)
- tltiClustering :: Lens' TableListTablesItem (Maybe Clustering)
- tltiTableReference :: Lens' TableListTablesItem (Maybe TableReference)
- tltiFriendlyName :: Lens' TableListTablesItem (Maybe Text)
- tltiKind :: Lens' TableListTablesItem Text
- tltiTimePartitioning :: Lens' TableListTablesItem (Maybe TimePartitioning)
- tltiView :: Lens' TableListTablesItem (Maybe TableListTablesItemView)
- tltiId :: Lens' TableListTablesItem (Maybe Text)
- tltiLabels :: Lens' TableListTablesItem (Maybe TableListTablesItemLabels)
- tltiType :: Lens' TableListTablesItem (Maybe Text)
- tltiExpirationTime :: Lens' TableListTablesItem (Maybe Int64)
- data TableSchema
- tableSchema :: TableSchema
- tsFields :: Lens' TableSchema [TableFieldSchema]
- data ProjectList
- projectList :: ProjectList
- plTotalItems :: Lens' ProjectList (Maybe Int32)
- plEtag :: Lens' ProjectList (Maybe Text)
- plNextPageToken :: Lens' ProjectList (Maybe Text)
- plKind :: Lens' ProjectList Text
- plProjects :: Lens' ProjectList [ProjectListProjectsItem]
- data ExplainQueryStep
- explainQueryStep :: ExplainQueryStep
- eqsSubsteps :: Lens' ExplainQueryStep [Text]
- eqsKind :: Lens' ExplainQueryStep (Maybe Text)
- data QueryTimelineSample
- queryTimelineSample :: QueryTimelineSample
- qtsPendingUnits :: Lens' QueryTimelineSample (Maybe Int64)
- qtsTotalSlotMs :: Lens' QueryTimelineSample (Maybe Int64)
- qtsActiveUnits :: Lens' QueryTimelineSample (Maybe Int64)
- qtsElapsedMs :: Lens' QueryTimelineSample (Maybe Int64)
- qtsCompletedUnits :: Lens' QueryTimelineSample (Maybe Int64)
- data QueryParameterTypeStructTypesItem
- queryParameterTypeStructTypesItem :: QueryParameterTypeStructTypesItem
- qptstiName :: Lens' QueryParameterTypeStructTypesItem (Maybe Text)
- qptstiType :: Lens' QueryParameterTypeStructTypesItem (Maybe QueryParameterType)
- qptstiDescription :: Lens' QueryParameterTypeStructTypesItem (Maybe Text)
- data BigtableColumnFamily
- bigtableColumnFamily :: BigtableColumnFamily
- bcfFamilyId :: Lens' BigtableColumnFamily (Maybe Text)
- bcfColumns :: Lens' BigtableColumnFamily [BigtableColumn]
- bcfOnlyReadLatest :: Lens' BigtableColumnFamily (Maybe Bool)
- bcfType :: Lens' BigtableColumnFamily (Maybe Text)
- bcfEncoding :: Lens' BigtableColumnFamily (Maybe Text)
- data JobStatistics
- jobStatistics :: JobStatistics
- jsCreationTime :: Lens' JobStatistics (Maybe Int64)
- jsStartTime :: Lens' JobStatistics (Maybe Int64)
- jsCompletionRatio :: Lens' JobStatistics (Maybe Double)
- jsTotalSlotMs :: Lens' JobStatistics (Maybe Int64)
- jsLoad :: Lens' JobStatistics (Maybe JobStatistics3)
- jsTotalBytesProcessed :: Lens' JobStatistics (Maybe Int64)
- jsQuotaDeferments :: Lens' JobStatistics [Text]
- jsEndTime :: Lens' JobStatistics (Maybe Int64)
- jsQuery :: Lens' JobStatistics (Maybe JobStatistics2)
- jsExtract :: Lens' JobStatistics (Maybe JobStatistics4)
- jsReservationUsage :: Lens' JobStatistics [JobStatisticsReservationUsageItem]
- data JobConfigurationLabels
- jobConfigurationLabels :: HashMap Text Text -> JobConfigurationLabels
- jclAddtional :: Lens' JobConfigurationLabels (HashMap Text Text)
- data DataSet
- dataSet :: DataSet
- dsCreationTime :: Lens' DataSet (Maybe Int64)
- dsDefaultPartitionExpirationMs :: Lens' DataSet (Maybe Int64)
- dsAccess :: Lens' DataSet [DataSetAccessItem]
- dsEtag :: Lens' DataSet (Maybe Text)
- dsLocation :: Lens' DataSet (Maybe Text)
- dsFriendlyName :: Lens' DataSet (Maybe Text)
- dsKind :: Lens' DataSet Text
- dsLastModifiedTime :: Lens' DataSet (Maybe Int64)
- dsDataSetReference :: Lens' DataSet (Maybe DataSetReference)
- dsSelfLink :: Lens' DataSet (Maybe Text)
- dsId :: Lens' DataSet (Maybe Text)
- dsLabels :: Lens' DataSet (Maybe DataSetLabels)
- dsDefaultTableExpirationMs :: Lens' DataSet (Maybe Int64)
- dsDescription :: Lens' DataSet (Maybe Text)
- data RangePartitioningRange
- rangePartitioningRange :: RangePartitioningRange
- rprStart :: Lens' RangePartitioningRange (Maybe Int64)
- rprInterval :: Lens' RangePartitioningRange (Maybe Int64)
- rprEnd :: Lens' RangePartitioningRange (Maybe Int64)
- data JobStatisticsReservationUsageItem
- jobStatisticsReservationUsageItem :: JobStatisticsReservationUsageItem
- jsruiName :: Lens' JobStatisticsReservationUsageItem (Maybe Text)
- jsruiSlotMs :: Lens' JobStatisticsReservationUsageItem (Maybe Int64)
- data BigtableOptions
- bigtableOptions :: BigtableOptions
- boReadRowkeyAsString :: Lens' BigtableOptions (Maybe Bool)
- boIgnoreUnspecifiedColumnFamilies :: Lens' BigtableOptions (Maybe Bool)
- boColumnFamilies :: Lens' BigtableOptions [BigtableColumnFamily]
- data Clustering
- clustering :: Clustering
- cFields :: Lens' Clustering [Text]
- data ExternalDataConfiguration
- externalDataConfiguration :: ExternalDataConfiguration
- edcBigtableOptions :: Lens' ExternalDataConfiguration (Maybe BigtableOptions)
- edcIgnoreUnknownValues :: Lens' ExternalDataConfiguration (Maybe Bool)
- edcCompression :: Lens' ExternalDataConfiguration (Maybe Text)
- edcSourceFormat :: Lens' ExternalDataConfiguration (Maybe Text)
- edcSchema :: Lens' ExternalDataConfiguration (Maybe TableSchema)
- edcMaxBadRecords :: Lens' ExternalDataConfiguration (Maybe Int32)
- edcGoogleSheetsOptions :: Lens' ExternalDataConfiguration (Maybe GoogleSheetsOptions)
- edcAutodetect :: Lens' ExternalDataConfiguration (Maybe Bool)
- edcSourceURIs :: Lens' ExternalDataConfiguration [Text]
- edcCSVOptions :: Lens' ExternalDataConfiguration (Maybe CSVOptions)
- data TableReference
- tableReference :: TableReference
- trDataSetId :: Lens' TableReference (Maybe Text)
- trProjectId :: Lens' TableReference (Maybe Text)
- trTableId :: Lens' TableReference (Maybe Text)
- data ModelDefinitionModelOptions
- modelDefinitionModelOptions :: ModelDefinitionModelOptions
- mdmoModelType :: Lens' ModelDefinitionModelOptions (Maybe Text)
- mdmoLabels :: Lens' ModelDefinitionModelOptions [Text]
- mdmoLossType :: Lens' ModelDefinitionModelOptions (Maybe Text)
- data RangePartitioning
- rangePartitioning :: RangePartitioning
- rpField :: Lens' RangePartitioning (Maybe Text)
- rpRange :: Lens' RangePartitioning (Maybe RangePartitioningRange)
- data TableFieldSchema
- tableFieldSchema :: TableFieldSchema
- tfsMode :: Lens' TableFieldSchema (Maybe Text)
- tfsName :: Lens' TableFieldSchema (Maybe Text)
- tfsType :: Lens' TableFieldSchema (Maybe Text)
- tfsDescription :: Lens' TableFieldSchema (Maybe Text)
- tfsFields :: Lens' TableFieldSchema [TableFieldSchema]
- data GetQueryResultsResponse
- getQueryResultsResponse :: GetQueryResultsResponse
- gqrrJobReference :: Lens' GetQueryResultsResponse (Maybe JobReference)
- gqrrEtag :: Lens' GetQueryResultsResponse (Maybe Text)
- gqrrKind :: Lens' GetQueryResultsResponse Text
- gqrrSchema :: Lens' GetQueryResultsResponse (Maybe TableSchema)
- gqrrTotalBytesProcessed :: Lens' GetQueryResultsResponse (Maybe Int64)
- gqrrRows :: Lens' GetQueryResultsResponse [TableRow]
- gqrrPageToken :: Lens' GetQueryResultsResponse (Maybe Text)
- gqrrNumDmlAffectedRows :: Lens' GetQueryResultsResponse (Maybe Int64)
- gqrrTotalRows :: Lens' GetQueryResultsResponse (Maybe Word64)
- gqrrErrors :: Lens' GetQueryResultsResponse [ErrorProto]
- gqrrJobComplete :: Lens' GetQueryResultsResponse (Maybe Bool)
- gqrrCacheHit :: Lens' GetQueryResultsResponse (Maybe Bool)
- data DataSetList
- dataSetList :: DataSetList
- dslEtag :: Lens' DataSetList (Maybe Text)
- dslNextPageToken :: Lens' DataSetList (Maybe Text)
- dslKind :: Lens' DataSetList Text
- dslDataSets :: Lens' DataSetList [DataSetListDataSetsItem]
- data QueryRequest
- queryRequest :: QueryRequest
- qrLocation :: Lens' QueryRequest (Maybe Text)
- qrUseQueryCache :: Lens' QueryRequest Bool
- qrPreserveNulls :: Lens' QueryRequest (Maybe Bool)
- qrKind :: Lens' QueryRequest Text
- qrQueryParameters :: Lens' QueryRequest [QueryParameter]
- qrQuery :: Lens' QueryRequest (Maybe Text)
- qrParameterMode :: Lens' QueryRequest (Maybe Text)
- qrTimeoutMs :: Lens' QueryRequest (Maybe Word32)
- qrUseLegacySQL :: Lens' QueryRequest Bool
- qrDryRun :: Lens' QueryRequest (Maybe Bool)
- qrMaxResults :: Lens' QueryRequest (Maybe Word32)
- qrDefaultDataSet :: Lens' QueryRequest (Maybe DataSetReference)
- data JobsListProjection
- data QueryParameter
- queryParameter :: QueryParameter
- qpParameterValue :: Lens' QueryParameter (Maybe QueryParameterValue)
- qpParameterType :: Lens' QueryParameter (Maybe QueryParameterType)
- qpName :: Lens' QueryParameter (Maybe Text)
- data IterationResult
- iterationResult :: IterationResult
- irDurationMs :: Lens' IterationResult (Maybe Int64)
- irLearnRate :: Lens' IterationResult (Maybe Double)
- irEvalLoss :: Lens' IterationResult (Maybe Double)
- irTrainingLoss :: Lens' IterationResult (Maybe Double)
- irIndex :: Lens' IterationResult (Maybe Int32)
- data JobStatistics4
- jobStatistics4 :: JobStatistics4
- jsDestinationURIFileCounts :: Lens' JobStatistics4 [Int64]
- data ProjectReference
- projectReference :: ProjectReference
- prProjectId :: Lens' ProjectReference (Maybe Text)
- data ExplainQueryStage
- explainQueryStage :: ExplainQueryStage
- eqsReadMsAvg :: Lens' ExplainQueryStage (Maybe Int64)
- eqsStatus :: Lens' ExplainQueryStage (Maybe Text)
- eqsShuffleOutputBytesSpilled :: Lens' ExplainQueryStage (Maybe Int64)
- eqsReadMsMax :: Lens' ExplainQueryStage (Maybe Int64)
- eqsCompletedParallelInputs :: Lens' ExplainQueryStage (Maybe Int64)
- eqsWaitRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsParallelInputs :: Lens' ExplainQueryStage (Maybe Int64)
- eqsShuffleOutputBytes :: Lens' ExplainQueryStage (Maybe Int64)
- eqsRecordsWritten :: Lens' ExplainQueryStage (Maybe Int64)
- eqsSteps :: Lens' ExplainQueryStage [ExplainQueryStep]
- eqsInputStages :: Lens' ExplainQueryStage [Int64]
- eqsWriteRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsRecordsRead :: Lens' ExplainQueryStage (Maybe Int64)
- eqsComputeRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsName :: Lens' ExplainQueryStage (Maybe Text)
- eqsComputeMsMax :: Lens' ExplainQueryStage (Maybe Int64)
- eqsReadRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsWriteMsMax :: Lens' ExplainQueryStage (Maybe Int64)
- eqsWaitRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsWaitMsAvg :: Lens' ExplainQueryStage (Maybe Int64)
- eqsId :: Lens' ExplainQueryStage (Maybe Int64)
- eqsComputeRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsWriteRatioMax :: Lens' ExplainQueryStage (Maybe Double)
- eqsComputeMsAvg :: Lens' ExplainQueryStage (Maybe Int64)
- eqsReadRatioAvg :: Lens' ExplainQueryStage (Maybe Double)
- eqsWriteMsAvg :: Lens' ExplainQueryStage (Maybe Int64)
- eqsStartMs :: Lens' ExplainQueryStage (Maybe Int64)
- eqsEndMs :: Lens' ExplainQueryStage (Maybe Int64)
- eqsWaitMsMax :: Lens' ExplainQueryStage (Maybe Int64)
- data TrainingRunTrainingOptions
- trainingRunTrainingOptions :: TrainingRunTrainingOptions
- trtoLineSearchInitLearnRate :: Lens' TrainingRunTrainingOptions (Maybe Double)
- trtoMinRelProgress :: Lens' TrainingRunTrainingOptions (Maybe Double)
- trtoL1Reg :: Lens' TrainingRunTrainingOptions (Maybe Double)
- trtoLearnRate :: Lens' TrainingRunTrainingOptions (Maybe Double)
- trtoLearnRateStrategy :: Lens' TrainingRunTrainingOptions (Maybe Text)
- trtoMaxIteration :: Lens' TrainingRunTrainingOptions (Maybe Int64)
- trtoEarlyStop :: Lens' TrainingRunTrainingOptions (Maybe Bool)
- trtoL2Reg :: Lens' TrainingRunTrainingOptions (Maybe Double)
- trtoWarmStart :: Lens' TrainingRunTrainingOptions (Maybe Bool)
- data BigQueryModelTraining
- bigQueryModelTraining :: BigQueryModelTraining
- bqmtExpectedTotalIterations :: Lens' BigQueryModelTraining (Maybe Int64)
- bqmtCurrentIteration :: Lens' BigQueryModelTraining (Maybe Int32)
- data JobConfigurationLoad
- jobConfigurationLoad :: JobConfigurationLoad
- jclSkipLeadingRows :: Lens' JobConfigurationLoad (Maybe Int32)
- jclProjectionFields :: Lens' JobConfigurationLoad [Text]
- jclDestinationTable :: Lens' JobConfigurationLoad (Maybe TableReference)
- jclWriteDisPosition :: Lens' JobConfigurationLoad (Maybe Text)
- jclAllowJaggedRows :: Lens' JobConfigurationLoad (Maybe Bool)
- jclClustering :: Lens' JobConfigurationLoad (Maybe Clustering)
- jclRangePartitioning :: Lens' JobConfigurationLoad (Maybe RangePartitioning)
- jclSchemaInline :: Lens' JobConfigurationLoad (Maybe Text)
- jclIgnoreUnknownValues :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSchemaUpdateOptions :: Lens' JobConfigurationLoad [Text]
- jclCreateDisPosition :: Lens' JobConfigurationLoad (Maybe Text)
- jclSchemaInlineFormat :: Lens' JobConfigurationLoad (Maybe Text)
- jclAllowQuotedNewlines :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSourceFormat :: Lens' JobConfigurationLoad (Maybe Text)
- jclUseAvroLogicalTypes :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSchema :: Lens' JobConfigurationLoad (Maybe TableSchema)
- jclTimePartitioning :: Lens' JobConfigurationLoad (Maybe TimePartitioning)
- jclQuote :: Lens' JobConfigurationLoad (Maybe Text)
- jclMaxBadRecords :: Lens' JobConfigurationLoad (Maybe Int32)
- jclAutodetect :: Lens' JobConfigurationLoad (Maybe Bool)
- jclSourceURIs :: Lens' JobConfigurationLoad [Text]
- jclEncoding :: Lens' JobConfigurationLoad (Maybe Text)
- jclDestinationTableProperties :: Lens' JobConfigurationLoad (Maybe DestinationTableProperties)
- jclDestinationEncryptionConfiguration :: Lens' JobConfigurationLoad (Maybe EncryptionConfiguration)
- jclFieldDelimiter :: Lens' JobConfigurationLoad (Maybe Text)
- jclNullMarker :: Lens' JobConfigurationLoad (Maybe Text)
- data JobsListStateFilter
- data DataSetReference
- dataSetReference :: DataSetReference
- dsrDataSetId :: Lens' DataSetReference (Maybe Text)
- dsrProjectId :: Lens' DataSetReference (Maybe Text)
- data MaterializedViewDefinition
- materializedViewDefinition :: MaterializedViewDefinition
- mvdQuery :: Lens' MaterializedViewDefinition (Maybe Text)
- mvdLastRefreshTime :: Lens' MaterializedViewDefinition (Maybe Int64)
- data TableDataInsertAllRequest
- tableDataInsertAllRequest :: TableDataInsertAllRequest
- tdiarKind :: Lens' TableDataInsertAllRequest Text
- tdiarIgnoreUnknownValues :: Lens' TableDataInsertAllRequest (Maybe Bool)
- tdiarRows :: Lens' TableDataInsertAllRequest [TableDataInsertAllRequestRowsItem]
- tdiarTemplateSuffix :: Lens' TableDataInsertAllRequest (Maybe Text)
- tdiarSkipInvalidRows :: Lens' TableDataInsertAllRequest (Maybe Bool)
- data GetServiceAccountResponse
- getServiceAccountResponse :: GetServiceAccountResponse
- gsarEmail :: Lens' GetServiceAccountResponse (Maybe Text)
- gsarKind :: Lens' GetServiceAccountResponse Text
- data ProjectListProjectsItem
- projectListProjectsItem :: ProjectListProjectsItem
- plpiFriendlyName :: Lens' ProjectListProjectsItem (Maybe Text)
- plpiKind :: Lens' ProjectListProjectsItem Text
- plpiProjectReference :: Lens' ProjectListProjectsItem (Maybe ProjectReference)
- plpiId :: Lens' ProjectListProjectsItem (Maybe Text)
- plpiNumericId :: Lens' ProjectListProjectsItem (Maybe Word64)
- data BigtableColumn
- bigtableColumn :: BigtableColumn
- bcQualifierEncoded :: Lens' BigtableColumn (Maybe ByteString)
- bcFieldName :: Lens' BigtableColumn (Maybe Text)
- bcQualifierString :: Lens' BigtableColumn (Maybe Text)
- bcOnlyReadLatest :: Lens' BigtableColumn (Maybe Bool)
- bcType :: Lens' BigtableColumn (Maybe Text)
- bcEncoding :: Lens' BigtableColumn (Maybe Text)
- data Streamingbuffer
- streamingbuffer :: Streamingbuffer
- sEstimatedBytes :: Lens' Streamingbuffer (Maybe Word64)
- sOldestEntryTime :: Lens' Streamingbuffer (Maybe Word64)
- sEstimatedRows :: Lens' Streamingbuffer (Maybe Word64)
- data TableRow
- tableRow :: TableRow
- trF :: Lens' TableRow [TableCell]
- data JobListJobsItem
- jobListJobsItem :: JobListJobsItem
- jljiJobReference :: Lens' JobListJobsItem (Maybe JobReference)
- jljiStatus :: Lens' JobListJobsItem (Maybe JobStatus)
- jljiState :: Lens' JobListJobsItem (Maybe Text)
- jljiUserEmail :: Lens' JobListJobsItem (Maybe Text)
- jljiKind :: Lens' JobListJobsItem Text
- jljiErrorResult :: Lens' JobListJobsItem (Maybe ErrorProto)
- jljiId :: Lens' JobListJobsItem (Maybe Text)
- jljiStatistics :: Lens' JobListJobsItem (Maybe JobStatistics)
- jljiConfiguration :: Lens' JobListJobsItem (Maybe JobConfiguration)
- data TimePartitioning
- timePartitioning :: TimePartitioning
- tpField :: Lens' TimePartitioning (Maybe Text)
- tpExpirationMs :: Lens' TimePartitioning (Maybe Int64)
- tpRequirePartitionFilter :: Lens' TimePartitioning (Maybe Bool)
- tpType :: Lens' TimePartitioning (Maybe Text)
- data QueryParameterValueStructValues
- queryParameterValueStructValues :: HashMap Text QueryParameterValue -> QueryParameterValueStructValues
- qpvsvAddtional :: Lens' QueryParameterValueStructValues (HashMap Text QueryParameterValue)
- data DataSetLabels
- dataSetLabels :: HashMap Text Text -> DataSetLabels
- dslAddtional :: Lens' DataSetLabels (HashMap Text Text)
- data JobConfiguration
- jobConfiguration :: JobConfiguration
- jcJobType :: Lens' JobConfiguration (Maybe Text)
- jcCopy :: Lens' JobConfiguration (Maybe JobConfigurationTableCopy)
- jcLoad :: Lens' JobConfiguration (Maybe JobConfigurationLoad)
- jcQuery :: Lens' JobConfiguration (Maybe JobConfigurationQuery)
- jcJobTimeoutMs :: Lens' JobConfiguration (Maybe Int64)
- jcExtract :: Lens' JobConfiguration (Maybe JobConfigurationExtract)
- jcLabels :: Lens' JobConfiguration (Maybe JobConfigurationLabels)
- jcDryRun :: Lens' JobConfiguration (Maybe Bool)
- data Job
- job :: Job
- jJobReference :: Lens' Job (Maybe JobReference)
- jStatus :: Lens' Job (Maybe JobStatus)
- jEtag :: Lens' Job (Maybe Text)
- jUserEmail :: Lens' Job (Maybe Text)
- jKind :: Lens' Job Text
- jSelfLink :: Lens' Job (Maybe Text)
- jId :: Lens' Job (Maybe Text)
- jStatistics :: Lens' Job (Maybe JobStatistics)
- jConfiguration :: Lens' Job (Maybe JobConfiguration)
- data EncryptionConfiguration
- encryptionConfiguration :: EncryptionConfiguration
- ecKmsKeyName :: Lens' EncryptionConfiguration (Maybe Text)
- data TableDataInsertAllResponseInsertErrorsItem
- tableDataInsertAllResponseInsertErrorsItem :: TableDataInsertAllResponseInsertErrorsItem
- tdiarieiErrors :: Lens' TableDataInsertAllResponseInsertErrorsItem [ErrorProto]
- tdiarieiIndex :: Lens' TableDataInsertAllResponseInsertErrorsItem (Maybe Word32)
- data JobConfigurationExtract
- jobConfigurationExtract :: JobConfigurationExtract
- jceDestinationFormat :: Lens' JobConfigurationExtract (Maybe Text)
- jceSourceTable :: Lens' JobConfigurationExtract (Maybe TableReference)
- jcePrintHeader :: Lens' JobConfigurationExtract Bool
- jceCompression :: Lens' JobConfigurationExtract (Maybe Text)
- jceDestinationURIs :: Lens' JobConfigurationExtract [Text]
- jceDestinationURI :: Lens' JobConfigurationExtract (Maybe Text)
- jceFieldDelimiter :: Lens' JobConfigurationExtract (Maybe Text)
- data ModelDefinition
- modelDefinition :: ModelDefinition
- mdModelOptions :: Lens' ModelDefinition (Maybe ModelDefinitionModelOptions)
- mdTrainingRuns :: Lens' ModelDefinition [TrainingRun]
- data JobCancelResponse
- jobCancelResponse :: JobCancelResponse
- jcrKind :: Lens' JobCancelResponse Text
- jcrJob :: Lens' JobCancelResponse (Maybe Job)
- data JSONObject
- jsonObject :: HashMap Text JSONValue -> JSONObject
- joAddtional :: Lens' JSONObject (HashMap Text JSONValue)
- data JobConfigurationQuery
- jobConfigurationQuery :: JobConfigurationQuery
- jcqDestinationTable :: Lens' JobConfigurationQuery (Maybe TableReference)
- jcqWriteDisPosition :: Lens' JobConfigurationQuery (Maybe Text)
- jcqPriority :: Lens' JobConfigurationQuery (Maybe Text)
- jcqClustering :: Lens' JobConfigurationQuery (Maybe Clustering)
- jcqRangePartitioning :: Lens' JobConfigurationQuery (Maybe RangePartitioning)
- jcqUseQueryCache :: Lens' JobConfigurationQuery Bool
- jcqPreserveNulls :: Lens' JobConfigurationQuery (Maybe Bool)
- jcqTableDefinitions :: Lens' JobConfigurationQuery (Maybe JobConfigurationQueryTableDefinitions)
- jcqQueryParameters :: Lens' JobConfigurationQuery [QueryParameter]
- jcqSchemaUpdateOptions :: Lens' JobConfigurationQuery [Text]
- jcqMaximumBytesBilled :: Lens' JobConfigurationQuery (Maybe Int64)
- jcqCreateDisPosition :: Lens' JobConfigurationQuery (Maybe Text)
- jcqUserDefinedFunctionResources :: Lens' JobConfigurationQuery [UserDefinedFunctionResource]
- jcqAllowLargeResults :: Lens' JobConfigurationQuery Bool
- jcqMaximumBillingTier :: Lens' JobConfigurationQuery Int32
- jcqTimePartitioning :: Lens' JobConfigurationQuery (Maybe TimePartitioning)
- jcqQuery :: Lens' JobConfigurationQuery (Maybe Text)
- jcqFlattenResults :: Lens' JobConfigurationQuery Bool
- jcqParameterMode :: Lens' JobConfigurationQuery (Maybe Text)
- jcqUseLegacySQL :: Lens' JobConfigurationQuery Bool
- jcqDestinationEncryptionConfiguration :: Lens' JobConfigurationQuery (Maybe EncryptionConfiguration)
- jcqDefaultDataSet :: Lens' JobConfigurationQuery (Maybe DataSetReference)
- data GoogleSheetsOptions
- googleSheetsOptions :: GoogleSheetsOptions
- gsoSkipLeadingRows :: Lens' GoogleSheetsOptions (Maybe Int64)
- gsoRange :: Lens' GoogleSheetsOptions (Maybe Text)
- data TableDataInsertAllRequestRowsItem
- tableDataInsertAllRequestRowsItem :: TableDataInsertAllRequestRowsItem
- tdiarriJSON :: Lens' TableDataInsertAllRequestRowsItem (Maybe JSONObject)
- tdiarriInsertId :: Lens' TableDataInsertAllRequestRowsItem (Maybe Text)
- data JobList
- jobList :: JobList
- jlEtag :: Lens' JobList (Maybe Text)
- jlNextPageToken :: Lens' JobList (Maybe Text)
- jlKind :: Lens' JobList Text
- jlJobs :: Lens' JobList [JobListJobsItem]
- data JobConfigurationQueryTableDefinitions
- jobConfigurationQueryTableDefinitions :: HashMap Text ExternalDataConfiguration -> JobConfigurationQueryTableDefinitions
- jcqtdAddtional :: Lens' JobConfigurationQueryTableDefinitions (HashMap Text ExternalDataConfiguration)
- data TableCell
- tableCell :: TableCell
- tcV :: Lens' TableCell (Maybe JSONValue)
- data JobStatistics2ReservationUsageItem
- jobStatistics2ReservationUsageItem :: JobStatistics2ReservationUsageItem
- jName :: Lens' JobStatistics2ReservationUsageItem (Maybe Text)
- jSlotMs :: Lens' JobStatistics2ReservationUsageItem (Maybe Int64)
- data QueryParameterValue
- queryParameterValue :: QueryParameterValue
- qpvStructValues :: Lens' QueryParameterValue (Maybe QueryParameterValueStructValues)
- qpvValue :: Lens' QueryParameterValue (Maybe Text)
- qpvArrayValues :: Lens' QueryParameterValue [QueryParameterValue]
- data ViewDefinition
- viewDefinition :: ViewDefinition
- vdUserDefinedFunctionResources :: Lens' ViewDefinition [UserDefinedFunctionResource]
- vdQuery :: Lens' ViewDefinition (Maybe Text)
- vdUseLegacySQL :: Lens' ViewDefinition (Maybe Bool)
- data UserDefinedFunctionResource
- userDefinedFunctionResource :: UserDefinedFunctionResource
- udfrResourceURI :: Lens' UserDefinedFunctionResource (Maybe Text)
- udfrInlineCode :: Lens' UserDefinedFunctionResource (Maybe Text)
- data JobStatistics2
- jobStatistics2 :: JobStatistics2
- jModelTrainingExpectedTotalIteration :: Lens' JobStatistics2 (Maybe Int64)
- jModelTraining :: Lens' JobStatistics2 (Maybe BigQueryModelTraining)
- jTotalSlotMs :: Lens' JobStatistics2 (Maybe Int64)
- jDdlTargetTable :: Lens' JobStatistics2 (Maybe TableReference)
- jEstimatedBytesProcessed :: Lens' JobStatistics2 (Maybe Int64)
- jModelTrainingCurrentIteration :: Lens' JobStatistics2 (Maybe Int32)
- jSchema :: Lens' JobStatistics2 (Maybe TableSchema)
- jTotalBytesProcessed :: Lens' JobStatistics2 (Maybe Int64)
- jBillingTier :: Lens' JobStatistics2 (Maybe Int32)
- jTotalBytesProcessedAccuracy :: Lens' JobStatistics2 (Maybe Text)
- jUndeclaredQueryParameters :: Lens' JobStatistics2 [QueryParameter]
- jReferencedTables :: Lens' JobStatistics2 [TableReference]
- jStatementType :: Lens' JobStatistics2 (Maybe Text)
- jReservationUsage :: Lens' JobStatistics2 [JobStatistics2ReservationUsageItem]
- jNumDmlAffectedRows :: Lens' JobStatistics2 (Maybe Int64)
- jTimeline :: Lens' JobStatistics2 [QueryTimelineSample]
- jQueryPlan :: Lens' JobStatistics2 [ExplainQueryStage]
- jCacheHit :: Lens' JobStatistics2 (Maybe Bool)
- jTotalBytesBilled :: Lens' JobStatistics2 (Maybe Int64)
- jDdlOperationPerformed :: Lens' JobStatistics2 (Maybe Text)
- jTotalPartitionsProcessed :: Lens' JobStatistics2 (Maybe Int64)
- data JobStatus
- jobStatus :: JobStatus
- jsState :: Lens' JobStatus (Maybe Text)
- jsErrorResult :: Lens' JobStatus (Maybe ErrorProto)
- jsErrors :: Lens' JobStatus [ErrorProto]
- data TableLabels
- tableLabels :: HashMap Text Text -> TableLabels
- tlAddtional :: Lens' TableLabels (HashMap Text Text)
- data DestinationTableProperties
- destinationTableProperties :: DestinationTableProperties
- dtpFriendlyName :: Lens' DestinationTableProperties (Maybe Text)
- dtpDescription :: Lens' DestinationTableProperties (Maybe Text)
- data DataSetAccessItem
- dataSetAccessItem :: DataSetAccessItem
- dsaiGroupByEmail :: Lens' DataSetAccessItem (Maybe Text)
- dsaiDomain :: Lens' DataSetAccessItem (Maybe Text)
- dsaiSpecialGroup :: Lens' DataSetAccessItem (Maybe Text)
- dsaiRole :: Lens' DataSetAccessItem (Maybe Text)
- dsaiIAMMember :: Lens' DataSetAccessItem (Maybe Text)
- dsaiView :: Lens' DataSetAccessItem (Maybe TableReference)
- dsaiUserByEmail :: Lens' DataSetAccessItem (Maybe Text)
- data TableDataInsertAllResponse
- tableDataInsertAllResponse :: TableDataInsertAllResponse
- tKind :: Lens' TableDataInsertAllResponse Text
- tInsertErrors :: Lens' TableDataInsertAllResponse [TableDataInsertAllResponseInsertErrorsItem]
- data QueryParameterType
- queryParameterType :: QueryParameterType
- qptStructTypes :: Lens' QueryParameterType [QueryParameterTypeStructTypesItem]
- qptType :: Lens' QueryParameterType (Maybe Text)
- qptArrayType :: Lens' QueryParameterType (Maybe QueryParameterType)
- data Table
- table :: Table
- tabMaterializedView :: Lens' Table (Maybe MaterializedViewDefinition)
- tabCreationTime :: Lens' Table (Maybe Int64)
- tabEtag :: Lens' Table (Maybe Text)
- tabNumBytes :: Lens' Table (Maybe Int64)
- tabClustering :: Lens' Table (Maybe Clustering)
- tabExternalDataConfiguration :: Lens' Table (Maybe ExternalDataConfiguration)
- tabRangePartitioning :: Lens' Table (Maybe RangePartitioning)
- tabLocation :: Lens' Table (Maybe Text)
- tabTableReference :: Lens' Table (Maybe TableReference)
- tabFriendlyName :: Lens' Table (Maybe Text)
- tabKind :: Lens' Table Text
- tabLastModifiedTime :: Lens' Table (Maybe Word64)
- tabSchema :: Lens' Table (Maybe TableSchema)
- tabStreamingBuffer :: Lens' Table (Maybe Streamingbuffer)
- tabSelfLink :: Lens' Table (Maybe Text)
- tabRequirePartitionFilter :: Lens' Table Bool
- tabEncryptionConfiguration :: Lens' Table (Maybe EncryptionConfiguration)
- tabModel :: Lens' Table (Maybe ModelDefinition)
- tabTimePartitioning :: Lens' Table (Maybe TimePartitioning)
- tabNumRows :: Lens' Table (Maybe Word64)
- tabNumPhysicalBytes :: Lens' Table (Maybe Int64)
- tabView :: Lens' Table (Maybe ViewDefinition)
- tabId :: Lens' Table (Maybe Text)
- tabLabels :: Lens' Table (Maybe TableLabels)
- tabType :: Lens' Table (Maybe Text)
- tabNumLongTermBytes :: Lens' Table (Maybe Int64)
- tabExpirationTime :: Lens' Table (Maybe Int64)
- tabDescription :: Lens' Table (Maybe Text)
- data ErrorProto
- errorProto :: ErrorProto
- epDebugInfo :: Lens' ErrorProto (Maybe Text)
- epLocation :: Lens' ErrorProto (Maybe Text)
- epReason :: Lens' ErrorProto (Maybe Text)
- epMessage :: Lens' ErrorProto (Maybe Text)
- data CSVOptions
- csvOptions :: CSVOptions
- coSkipLeadingRows :: Lens' CSVOptions (Maybe Int64)
- coAllowJaggedRows :: Lens' CSVOptions (Maybe Bool)
- coAllowQuotedNewlines :: Lens' CSVOptions (Maybe Bool)
- coQuote :: Lens' CSVOptions Text
- coEncoding :: Lens' CSVOptions (Maybe Text)
- coFieldDelimiter :: Lens' CSVOptions (Maybe Text)
- data JobStatistics3
- jobStatistics3 :: JobStatistics3
- jsInputFiles :: Lens' JobStatistics3 (Maybe Int64)
- jsOutputRows :: Lens' JobStatistics3 (Maybe Int64)
- jsOutputBytes :: Lens' JobStatistics3 (Maybe Int64)
- jsInputFileBytes :: Lens' JobStatistics3 (Maybe Int64)
- jsBadRecords :: Lens' JobStatistics3 (Maybe Int64)
- data QueryResponse
- queryResponse :: QueryResponse
- qJobReference :: Lens' QueryResponse (Maybe JobReference)
- qKind :: Lens' QueryResponse Text
- qSchema :: Lens' QueryResponse (Maybe TableSchema)
- qTotalBytesProcessed :: Lens' QueryResponse (Maybe Int64)
- qRows :: Lens' QueryResponse [TableRow]
- qPageToken :: Lens' QueryResponse (Maybe Text)
- qNumDmlAffectedRows :: Lens' QueryResponse (Maybe Int64)
- qTotalRows :: Lens' QueryResponse (Maybe Word64)
- qErrors :: Lens' QueryResponse [ErrorProto]
- qJobComplete :: Lens' QueryResponse (Maybe Bool)
- qCacheHit :: Lens' QueryResponse (Maybe Bool)
- data DataSetListDataSetsItemLabels
- dataSetListDataSetsItemLabels :: HashMap Text Text -> DataSetListDataSetsItemLabels
- dsldsilAddtional :: Lens' DataSetListDataSetsItemLabels (HashMap Text Text)
- data TrainingRun
- trainingRun :: TrainingRun
- trState :: Lens' TrainingRun (Maybe Text)
- trStartTime :: Lens' TrainingRun (Maybe UTCTime)
- trIterationResults :: Lens' TrainingRun [IterationResult]
- trTrainingOptions :: Lens' TrainingRun (Maybe TrainingRunTrainingOptions)
- data TableListTablesItemView
- tableListTablesItemView :: TableListTablesItemView
- tltivUseLegacySQL :: Lens' TableListTablesItemView (Maybe Bool)
- data TableListTablesItemLabels
- tableListTablesItemLabels :: HashMap Text Text -> TableListTablesItemLabels
- tltilAddtional :: Lens' TableListTablesItemLabels (HashMap Text Text)
Service Configuration
bigQueryService :: ServiceConfig Source #
Default request referring to version v2
of the BigQuery API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudPlatformReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform.read-only"] Source #
View your data across Google Cloud Platform services
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
storageReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_only"] Source #
View your data in Google Cloud Storage
bigQueryInsertDataScope :: Proxy '["https://www.googleapis.com/auth/bigquery.insertdata"] Source #
Insert data into Google BigQuery
storageReadWriteScope :: Proxy '["https://www.googleapis.com/auth/devstorage.read_write"] Source #
Manage your data in Google Cloud Storage
bigQueryScope :: Proxy '["https://www.googleapis.com/auth/bigquery"] Source #
View and manage your data in Google BigQuery
storageFullControlScope :: Proxy '["https://www.googleapis.com/auth/devstorage.full_control"] Source #
Manage your data and permissions in Google Cloud Storage
API Declaration
type BigQueryAPI = JobsInsertResource :<|> (JobsListResource :<|> (JobsGetResource :<|> (JobsQueryResource :<|> (JobsCancelResource :<|> (JobsGetQueryResultsResource :<|> (TablesInsertResource :<|> (TablesListResource :<|> (TablesPatchResource :<|> (TablesGetResource :<|> (TablesDeleteResource :<|> (TablesUpdateResource :<|> (TableDataListResource :<|> (TableDataInsertAllResource :<|> (ProjectsGetServiceAccountResource :<|> (ProjectsListResource :<|> (DataSetsInsertResource :<|> (DataSetsListResource :<|> (DataSetsPatchResource :<|> (DataSetsGetResource :<|> (DataSetsDeleteResource :<|> DataSetsUpdateResource)))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the BigQuery API service.
Resources
bigquery.datasets.delete
bigquery.datasets.get
bigquery.datasets.insert
bigquery.datasets.list
bigquery.datasets.patch
bigquery.datasets.update
bigquery.jobs.cancel
bigquery.jobs.get
bigquery.jobs.getQueryResults
bigquery.jobs.insert
bigquery.jobs.list
bigquery.jobs.query
bigquery.projects.getServiceAccount
bigquery.projects.list
bigquery.tabledata.insertAll
bigquery.tabledata.list
bigquery.tables.delete
bigquery.tables.get
bigquery.tables.insert
bigquery.tables.list
bigquery.tables.patch
bigquery.tables.update
Types
JobReference
data JobReference Source #
Instances
jobReference :: JobReference Source #
Creates a value of JobReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jrJobId :: Lens' JobReference (Maybe Text) Source #
- Required
- The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
jrLocation :: Lens' JobReference (Maybe Text) Source #
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
jrProjectId :: Lens' JobReference (Maybe Text) Source #
- Required
- The ID of the project containing this job.
TableList
Instances
tableList :: TableList Source #
Creates a value of TableList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tlNextPageToken :: Lens' TableList (Maybe Text) Source #
A token to request the next page of results.
DataSetListDataSetsItem
data DataSetListDataSetsItem Source #
Instances
dataSetListDataSetsItem :: DataSetListDataSetsItem Source #
Creates a value of DataSetListDataSetsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsldsiLocation :: Lens' DataSetListDataSetsItem (Maybe Text) Source #
The geographic location where the data resides.
dsldsiFriendlyName :: Lens' DataSetListDataSetsItem (Maybe Text) Source #
A descriptive name for the dataset, if one exists.
dsldsiKind :: Lens' DataSetListDataSetsItem Text Source #
The resource type. This property always returns the value "bigquery#dataset".
dsldsiDataSetReference :: Lens' DataSetListDataSetsItem (Maybe DataSetReference) Source #
The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID.
dsldsiId :: Lens' DataSetListDataSetsItem (Maybe Text) Source #
The fully-qualified, unique, opaque ID of the dataset.
dsldsiLabels :: Lens' DataSetListDataSetsItem (Maybe DataSetListDataSetsItemLabels) Source #
The labels associated with this dataset. You can use these to organize and group your datasets.
TableDataList
data TableDataList Source #
Instances
tableDataList :: TableDataList Source #
Creates a value of TableDataList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdlPageToken :: Lens' TableDataList (Maybe Text) Source #
A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
tdlTotalRows :: Lens' TableDataList (Maybe Int64) Source #
The total number of rows in the complete table.
JobConfigurationTableCopy
data JobConfigurationTableCopy Source #
Instances
jobConfigurationTableCopy :: JobConfigurationTableCopy Source #
Creates a value of JobConfigurationTableCopy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jctcDestinationTable :: Lens' JobConfigurationTableCopy (Maybe TableReference) Source #
- Required
- The destination table
jctcWriteDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text) Source #
- Optional
- Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
jctcSourceTables :: Lens' JobConfigurationTableCopy [TableReference] Source #
- Pick one
- Source tables to copy.
jctcCreateDisPosition :: Lens' JobConfigurationTableCopy (Maybe Text) Source #
- Optional
- Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
jctcSourceTable :: Lens' JobConfigurationTableCopy (Maybe TableReference) Source #
- Pick one
- Source table to copy.
jctcDestinationEncryptionConfiguration :: Lens' JobConfigurationTableCopy (Maybe EncryptionConfiguration) Source #
Custom encryption configuration (e.g., Cloud KMS keys).
TableListTablesItem
data TableListTablesItem Source #
Instances
tableListTablesItem :: TableListTablesItem Source #
Creates a value of TableListTablesItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tltiCreationTime :: Lens' TableListTablesItem (Maybe Int64) Source #
The time when this table was created, in milliseconds since the epoch.
tltiClustering :: Lens' TableListTablesItem (Maybe Clustering) Source #
- Beta
- Clustering specification for this table, if configured.
tltiTableReference :: Lens' TableListTablesItem (Maybe TableReference) Source #
A reference uniquely identifying the table.
tltiFriendlyName :: Lens' TableListTablesItem (Maybe Text) Source #
The user-friendly name for this table.
tltiTimePartitioning :: Lens' TableListTablesItem (Maybe TimePartitioning) Source #
The time-based partitioning specification for this table, if configured.
tltiView :: Lens' TableListTablesItem (Maybe TableListTablesItemView) Source #
Additional details for a view.
tltiLabels :: Lens' TableListTablesItem (Maybe TableListTablesItemLabels) Source #
The labels associated with this table. You can use these to organize and group your tables.
tltiType :: Lens' TableListTablesItem (Maybe Text) Source #
The type of table. Possible values are: TABLE, VIEW.
tltiExpirationTime :: Lens' TableListTablesItem (Maybe Int64) Source #
- Optional
- The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.
TableSchema
data TableSchema Source #
Instances
tableSchema :: TableSchema Source #
Creates a value of TableSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsFields :: Lens' TableSchema [TableFieldSchema] Source #
Describes the fields in a table.
ProjectList
data ProjectList Source #
Instances
projectList :: ProjectList Source #
Creates a value of ProjectList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
plTotalItems :: Lens' ProjectList (Maybe Int32) Source #
The total number of projects in the list.
plNextPageToken :: Lens' ProjectList (Maybe Text) Source #
A token to request the next page of results.
plProjects :: Lens' ProjectList [ProjectListProjectsItem] Source #
Projects to which you have at least READ access.
ExplainQueryStep
data ExplainQueryStep Source #
Instances
explainQueryStep :: ExplainQueryStep Source #
Creates a value of ExplainQueryStep
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eqsSubsteps :: Lens' ExplainQueryStep [Text] Source #
Human-readable stage descriptions.
QueryTimelineSample
data QueryTimelineSample Source #
Instances
queryTimelineSample :: QueryTimelineSample Source #
Creates a value of QueryTimelineSample
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qtsPendingUnits :: Lens' QueryTimelineSample (Maybe Int64) Source #
Total parallel units of work remaining for the active stages.
qtsTotalSlotMs :: Lens' QueryTimelineSample (Maybe Int64) Source #
Cumulative slot-ms consumed by the query.
qtsActiveUnits :: Lens' QueryTimelineSample (Maybe Int64) Source #
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
qtsElapsedMs :: Lens' QueryTimelineSample (Maybe Int64) Source #
Milliseconds elapsed since the start of query execution.
qtsCompletedUnits :: Lens' QueryTimelineSample (Maybe Int64) Source #
Total parallel units of work completed by this query.
QueryParameterTypeStructTypesItem
data QueryParameterTypeStructTypesItem Source #
Instances
queryParameterTypeStructTypesItem :: QueryParameterTypeStructTypesItem Source #
Creates a value of QueryParameterTypeStructTypesItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qptstiName :: Lens' QueryParameterTypeStructTypesItem (Maybe Text) Source #
- Optional
- The name of this field.
qptstiType :: Lens' QueryParameterTypeStructTypesItem (Maybe QueryParameterType) Source #
- Required
- The type of this field.
qptstiDescription :: Lens' QueryParameterTypeStructTypesItem (Maybe Text) Source #
- Optional
- Human-oriented description of the field.
BigtableColumnFamily
data BigtableColumnFamily Source #
Instances
bigtableColumnFamily :: BigtableColumnFamily Source #
Creates a value of BigtableColumnFamily
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcfFamilyId :: Lens' BigtableColumnFamily (Maybe Text) Source #
Identifier of the column family.
bcfColumns :: Lens' BigtableColumnFamily [BigtableColumn] Source #
- Optional
- Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
bcfOnlyReadLatest :: Lens' BigtableColumnFamily (Maybe Bool) Source #
- Optional
- If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.
bcfType :: Lens' BigtableColumnFamily (Maybe Text) Source #
- Optional
- The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.
bcfEncoding :: Lens' BigtableColumnFamily (Maybe Text) Source #
- Optional
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.
JobStatistics
data JobStatistics Source #
Instances
jobStatistics :: JobStatistics Source #
Creates a value of JobStatistics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsCreationTime :: Lens' JobStatistics (Maybe Int64) Source #
- Output-only
- Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
jsStartTime :: Lens' JobStatistics (Maybe Int64) Source #
- Output-only
- Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
jsCompletionRatio :: Lens' JobStatistics (Maybe Double) Source #
- TrustedTester
- [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
jsTotalSlotMs :: Lens' JobStatistics (Maybe Int64) Source #
- Output-only
- Slot-milliseconds for the job.
jsLoad :: Lens' JobStatistics (Maybe JobStatistics3) Source #
- Output-only
- Statistics for a load job.
jsTotalBytesProcessed :: Lens' JobStatistics (Maybe Int64) Source #
- Output-only
- [Deprecated] Use the bytes processed in the query statistics instead.
jsQuotaDeferments :: Lens' JobStatistics [Text] Source #
- Output-only
- Quotas which delayed this job's start time.
jsEndTime :: Lens' JobStatistics (Maybe Int64) Source #
- Output-only
- End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
jsQuery :: Lens' JobStatistics (Maybe JobStatistics2) Source #
- Output-only
- Statistics for a query job.
jsExtract :: Lens' JobStatistics (Maybe JobStatistics4) Source #
- Output-only
- Statistics for an extract job.
jsReservationUsage :: Lens' JobStatistics [JobStatisticsReservationUsageItem] Source #
- Output-only
- Job resource usage breakdown by reservation.
JobConfigurationLabels
data JobConfigurationLabels Source #
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
See: jobConfigurationLabels
smart constructor.
Instances
jobConfigurationLabels Source #
Creates a value of JobConfigurationLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DataSet
Instances
Creates a value of DataSet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsCreationTime :: Lens' DataSet (Maybe Int64) Source #
- Output-only
- The time when this dataset was created, in milliseconds since the epoch.
dsDefaultPartitionExpirationMs :: Lens' DataSet (Maybe Int64) Source #
- Optional
- The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.
dsAccess :: Lens' DataSet [DataSetAccessItem] Source #
- Optional
- An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
dsLocation :: Lens' DataSet (Maybe Text) Source #
The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.
dsLastModifiedTime :: Lens' DataSet (Maybe Int64) Source #
- Output-only
- The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.
dsDataSetReference :: Lens' DataSet (Maybe DataSetReference) Source #
- Required
- A reference that identifies the dataset.
dsSelfLink :: Lens' DataSet (Maybe Text) Source #
- Output-only
- A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
dsId :: Lens' DataSet (Maybe Text) Source #
- Output-only
- The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.
dsLabels :: Lens' DataSet (Maybe DataSetLabels) Source #
The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
dsDefaultTableExpirationMs :: Lens' DataSet (Maybe Int64) Source #
- Optional
- The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.
dsDescription :: Lens' DataSet (Maybe Text) Source #
- Optional
- A user-friendly description of the dataset.
RangePartitioningRange
data RangePartitioningRange Source #
- TrustedTester
- [Required] Defines the ranges for range partitioning.
See: rangePartitioningRange
smart constructor.
Instances
rangePartitioningRange :: RangePartitioningRange Source #
Creates a value of RangePartitioningRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rprStart :: Lens' RangePartitioningRange (Maybe Int64) Source #
- TrustedTester
- [Required] The start of range partitioning, inclusive.
rprInterval :: Lens' RangePartitioningRange (Maybe Int64) Source #
- TrustedTester
- [Required] The width of each interval.
rprEnd :: Lens' RangePartitioningRange (Maybe Int64) Source #
- TrustedTester
- [Required] The end of range partitioning, exclusive.
JobStatisticsReservationUsageItem
data JobStatisticsReservationUsageItem Source #
Instances
jobStatisticsReservationUsageItem :: JobStatisticsReservationUsageItem Source #
Creates a value of JobStatisticsReservationUsageItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsruiName :: Lens' JobStatisticsReservationUsageItem (Maybe Text) Source #
- Output-only
- Reservation name or "unreserved" for on-demand resources usage.
jsruiSlotMs :: Lens' JobStatisticsReservationUsageItem (Maybe Int64) Source #
- Output-only
- Slot-milliseconds the job spent in the given reservation.
BigtableOptions
data BigtableOptions Source #
Instances
bigtableOptions :: BigtableOptions Source #
Creates a value of BigtableOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
boReadRowkeyAsString :: Lens' BigtableOptions (Maybe Bool) Source #
- Optional
- If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
boIgnoreUnspecifiedColumnFamilies :: Lens' BigtableOptions (Maybe Bool) Source #
- Optional
- If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
boColumnFamilies :: Lens' BigtableOptions [BigtableColumnFamily] Source #
- Optional
- List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
Clustering
data Clustering Source #
Instances
clustering :: Clustering Source #
Creates a value of Clustering
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cFields :: Lens' Clustering [Text] Source #
- Repeated
- One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
ExternalDataConfiguration
data ExternalDataConfiguration Source #
Instances
externalDataConfiguration :: ExternalDataConfiguration Source #
Creates a value of ExternalDataConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcBigtableOptions :: Lens' ExternalDataConfiguration (Maybe BigtableOptions) Source #
- Optional
- Additional options if sourceFormat is set to BIGTABLE.
edcIgnoreUnknownValues :: Lens' ExternalDataConfiguration (Maybe Bool) Source #
- Optional
- Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
edcCompression :: Lens' ExternalDataConfiguration (Maybe Text) Source #
- Optional
- The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
edcSourceFormat :: Lens' ExternalDataConfiguration (Maybe Text) Source #
- Required
- The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
edcSchema :: Lens' ExternalDataConfiguration (Maybe TableSchema) Source #
- Optional
- The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
edcMaxBadRecords :: Lens' ExternalDataConfiguration (Maybe Int32) Source #
- Optional
- The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
edcGoogleSheetsOptions :: Lens' ExternalDataConfiguration (Maybe GoogleSheetsOptions) Source #
- Optional
- Additional options if sourceFormat is set to GOOGLE_SHEETS.
edcAutodetect :: Lens' ExternalDataConfiguration (Maybe Bool) Source #
Try to detect schema and format options automatically. Any option specified explicitly will be honored.
edcSourceURIs :: Lens' ExternalDataConfiguration [Text] Source #
- Required
- The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
edcCSVOptions :: Lens' ExternalDataConfiguration (Maybe CSVOptions) Source #
Additional properties to set if sourceFormat is set to CSV.
TableReference
data TableReference Source #
Instances
tableReference :: TableReference Source #
Creates a value of TableReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trDataSetId :: Lens' TableReference (Maybe Text) Source #
- Required
- The ID of the dataset containing this table.
trProjectId :: Lens' TableReference (Maybe Text) Source #
- Required
- The ID of the project containing this table.
trTableId :: Lens' TableReference (Maybe Text) Source #
- Required
- The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
ModelDefinitionModelOptions
data ModelDefinitionModelOptions Source #
- Output-only, Beta
- Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
See: modelDefinitionModelOptions
smart constructor.
Instances
modelDefinitionModelOptions :: ModelDefinitionModelOptions Source #
Creates a value of ModelDefinitionModelOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RangePartitioning
data RangePartitioning Source #
Instances
rangePartitioning :: RangePartitioning Source #
Creates a value of RangePartitioning
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rpField :: Lens' RangePartitioning (Maybe Text) Source #
- TrustedTester
- [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
rpRange :: Lens' RangePartitioning (Maybe RangePartitioningRange) Source #
- TrustedTester
- [Required] Defines the ranges for range partitioning.
TableFieldSchema
data TableFieldSchema Source #
Instances
tableFieldSchema :: TableFieldSchema Source #
Creates a value of TableFieldSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tfsMode :: Lens' TableFieldSchema (Maybe Text) Source #
- Optional
- The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
tfsName :: Lens' TableFieldSchema (Maybe Text) Source #
- Required
- The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
tfsType :: Lens' TableFieldSchema (Maybe Text) Source #
- Required
- The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
tfsDescription :: Lens' TableFieldSchema (Maybe Text) Source #
- Optional
- The field description. The maximum length is 1,024 characters.
tfsFields :: Lens' TableFieldSchema [TableFieldSchema] Source #
- Optional
- Describes the nested schema fields if the type property is set to RECORD.
GetQueryResultsResponse
data GetQueryResultsResponse Source #
Instances
getQueryResultsResponse :: GetQueryResultsResponse Source #
Creates a value of GetQueryResultsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gqrrJobReference :: Lens' GetQueryResultsResponse (Maybe JobReference) Source #
Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
gqrrSchema :: Lens' GetQueryResultsResponse (Maybe TableSchema) Source #
The schema of the results. Present only when the query completes successfully.
gqrrTotalBytesProcessed :: Lens' GetQueryResultsResponse (Maybe Int64) Source #
The total number of bytes processed for this query.
gqrrRows :: Lens' GetQueryResultsResponse [TableRow] Source #
An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
gqrrPageToken :: Lens' GetQueryResultsResponse (Maybe Text) Source #
A token used for paging results.
gqrrNumDmlAffectedRows :: Lens' GetQueryResultsResponse (Maybe Int64) Source #
- Output-only
- The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
gqrrTotalRows :: Lens' GetQueryResultsResponse (Maybe Word64) Source #
The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
gqrrErrors :: Lens' GetQueryResultsResponse [ErrorProto] Source #
- Output-only
- The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
gqrrJobComplete :: Lens' GetQueryResultsResponse (Maybe Bool) Source #
Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
gqrrCacheHit :: Lens' GetQueryResultsResponse (Maybe Bool) Source #
Whether the query result was fetched from the query cache.
DataSetList
data DataSetList Source #
Instances
dataSetList :: DataSetList Source #
Creates a value of DataSetList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dslEtag :: Lens' DataSetList (Maybe Text) Source #
A hash value of the results page. You can use this property to determine if the page has changed since the last request.
dslNextPageToken :: Lens' DataSetList (Maybe Text) Source #
A token that can be used to request the next results page. This property is omitted on the final results page.
dslKind :: Lens' DataSetList Text Source #
The list type. This property always returns the value "bigquery#datasetList".
dslDataSets :: Lens' DataSetList [DataSetListDataSetsItem] Source #
An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.
QueryRequest
data QueryRequest Source #
Instances
queryRequest :: QueryRequest Source #
Creates a value of QueryRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qrLocation :: Lens' QueryRequest (Maybe Text) Source #
The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
qrUseQueryCache :: Lens' QueryRequest Bool Source #
- Optional
- 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. The default value is true.
qrPreserveNulls :: Lens' QueryRequest (Maybe Bool) Source #
- Deprecated
- This property is deprecated.
qrQueryParameters :: Lens' QueryRequest [QueryParameter] Source #
Query parameters for Standard SQL queries.
qrQuery :: Lens' QueryRequest (Maybe Text) Source #
- Required
- A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM
- myProjectId:myDatasetId.myTableId
- ".
qrParameterMode :: Lens' QueryRequest (Maybe Text) Source #
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named ('myparam) query parameters in this query.
qrTimeoutMs :: Lens' QueryRequest (Maybe Word32) Source #
- Optional
- 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).
qrUseLegacySQL :: Lens' QueryRequest Bool Source #
Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
qrDryRun :: Lens' QueryRequest (Maybe Bool) Source #
- Optional
- If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
qrMaxResults :: Lens' QueryRequest (Maybe Word32) Source #
- Optional
- 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.
qrDefaultDataSet :: Lens' QueryRequest (Maybe DataSetReference) Source #
- Optional
- Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.
JobsListProjection
data JobsListProjection Source #
Restrict information returned to a set of selected fields
Instances
QueryParameter
data QueryParameter Source #
Instances
queryParameter :: QueryParameter Source #
Creates a value of QueryParameter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qpParameterValue :: Lens' QueryParameter (Maybe QueryParameterValue) Source #
- Required
- The value of this parameter.
qpParameterType :: Lens' QueryParameter (Maybe QueryParameterType) Source #
- Required
- The type of this parameter.
qpName :: Lens' QueryParameter (Maybe Text) Source #
- Optional
- If unset, this is a positional parameter. Otherwise, should be unique within a query.
IterationResult
data IterationResult Source #
Instances
iterationResult :: IterationResult Source #
Creates a value of IterationResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
irDurationMs :: Lens' IterationResult (Maybe Int64) Source #
- Output-only, Beta
- Time taken to run the training iteration in milliseconds.
irLearnRate :: Lens' IterationResult (Maybe Double) Source #
- Output-only, Beta
- Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.
irEvalLoss :: Lens' IterationResult (Maybe Double) Source #
- Output-only, Beta
- Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.
irTrainingLoss :: Lens' IterationResult (Maybe Double) Source #
- Output-only, Beta
- Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.
irIndex :: Lens' IterationResult (Maybe Int32) Source #
- Output-only, Beta
- Index of the ML training iteration, starting from zero for each training run.
JobStatistics4
data JobStatistics4 Source #
Instances
jobStatistics4 :: JobStatistics4 Source #
Creates a value of JobStatistics4
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsDestinationURIFileCounts :: Lens' JobStatistics4 [Int64] Source #
- Output-only
- Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
ProjectReference
data ProjectReference Source #
Instances
projectReference :: ProjectReference Source #
Creates a value of ProjectReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
prProjectId :: Lens' ProjectReference (Maybe Text) Source #
- Required
- ID of the project. Can be either the numeric ID or the assigned ID of the project.
ExplainQueryStage
data ExplainQueryStage Source #
Instances
explainQueryStage :: ExplainQueryStage Source #
Creates a value of ExplainQueryStage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eqsReadMsAvg
eqsStatus
eqsShuffleOutputBytesSpilled
eqsReadMsMax
eqsCompletedParallelInputs
eqsWaitRatioMax
eqsParallelInputs
eqsShuffleOutputBytes
eqsRecordsWritten
eqsSteps
eqsInputStages
eqsWriteRatioAvg
eqsRecordsRead
eqsComputeRatioAvg
eqsName
eqsComputeMsMax
eqsReadRatioMax
eqsWriteMsMax
eqsWaitRatioAvg
eqsWaitMsAvg
eqsId
eqsComputeRatioMax
eqsWriteRatioMax
eqsComputeMsAvg
eqsReadRatioAvg
eqsWriteMsAvg
eqsStartMs
eqsEndMs
eqsWaitMsMax
eqsReadMsAvg :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the average shard spent reading input.
eqsShuffleOutputBytesSpilled :: Lens' ExplainQueryStage (Maybe Int64) Source #
Total number of bytes written to shuffle and spilled to disk.
eqsReadMsMax :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the slowest shard spent reading input.
eqsCompletedParallelInputs :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of parallel input segments completed.
eqsWaitRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent waiting to be scheduled.
eqsParallelInputs :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of parallel input segments to be processed.
eqsShuffleOutputBytes :: Lens' ExplainQueryStage (Maybe Int64) Source #
Total number of bytes written to shuffle.
eqsRecordsWritten :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of records written by the stage.
eqsSteps :: Lens' ExplainQueryStage [ExplainQueryStep] Source #
List of operations within the stage in dependency order (approximately chronological).
eqsInputStages :: Lens' ExplainQueryStage [Int64] Source #
IDs for stages that are inputs to this stage.
eqsWriteRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent on writing output.
eqsRecordsRead :: Lens' ExplainQueryStage (Maybe Int64) Source #
Number of records read into the stage.
eqsComputeRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent on CPU-bound tasks.
eqsComputeMsMax :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the slowest shard spent on CPU-bound tasks.
eqsReadRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent reading input.
eqsWriteMsMax :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the slowest shard spent on writing output.
eqsWaitRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent waiting to be scheduled.
eqsWaitMsAvg :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the average shard spent waiting to be scheduled.
eqsComputeRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent on CPU-bound tasks.
eqsWriteRatioMax :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the slowest shard spent on writing output.
eqsComputeMsAvg :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the average shard spent on CPU-bound tasks.
eqsReadRatioAvg :: Lens' ExplainQueryStage (Maybe Double) Source #
Relative amount of time the average shard spent reading input.
eqsWriteMsAvg :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the average shard spent on writing output.
eqsStartMs :: Lens' ExplainQueryStage (Maybe Int64) Source #
Stage start time represented as milliseconds since epoch.
eqsEndMs :: Lens' ExplainQueryStage (Maybe Int64) Source #
Stage end time represented as milliseconds since epoch.
eqsWaitMsMax :: Lens' ExplainQueryStage (Maybe Int64) Source #
Milliseconds the slowest shard spent waiting to be scheduled.
TrainingRunTrainingOptions
data TrainingRunTrainingOptions Source #
- Output-only, Beta
- Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
See: trainingRunTrainingOptions
smart constructor.
Instances
trainingRunTrainingOptions :: TrainingRunTrainingOptions Source #
Creates a value of TrainingRunTrainingOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
BigQueryModelTraining
data BigQueryModelTraining Source #
Instances
bigQueryModelTraining :: BigQueryModelTraining Source #
Creates a value of BigQueryModelTraining
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bqmtExpectedTotalIterations :: Lens' BigQueryModelTraining (Maybe Int64) Source #
- Output-only, Beta
- Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
bqmtCurrentIteration :: Lens' BigQueryModelTraining (Maybe Int32) Source #
- Output-only, Beta
- Index of current ML training iteration. Updated during create model query job to show job progress.
JobConfigurationLoad
data JobConfigurationLoad Source #
Instances
jobConfigurationLoad :: JobConfigurationLoad Source #
Creates a value of JobConfigurationLoad
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jclSkipLeadingRows
jclProjectionFields
jclDestinationTable
jclWriteDisPosition
jclAllowJaggedRows
jclClustering
jclRangePartitioning
jclSchemaInline
jclIgnoreUnknownValues
jclSchemaUpdateOptions
jclCreateDisPosition
jclSchemaInlineFormat
jclAllowQuotedNewlines
jclSourceFormat
jclUseAvroLogicalTypes
jclSchema
jclTimePartitioning
jclQuote
jclMaxBadRecords
jclAutodetect
jclSourceURIs
jclEncoding
jclDestinationTableProperties
jclDestinationEncryptionConfiguration
jclFieldDelimiter
jclNullMarker
jclSkipLeadingRows :: Lens' JobConfigurationLoad (Maybe Int32) Source #
- Optional
- The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
jclProjectionFields :: Lens' JobConfigurationLoad [Text] Source #
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
jclDestinationTable :: Lens' JobConfigurationLoad (Maybe TableReference) Source #
- Required
- The destination table to load the data into.
jclWriteDisPosition :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
jclAllowJaggedRows :: Lens' JobConfigurationLoad (Maybe Bool) Source #
- Optional
- Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
jclClustering :: Lens' JobConfigurationLoad (Maybe Clustering) Source #
- Beta
- Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
jclRangePartitioning :: Lens' JobConfigurationLoad (Maybe RangePartitioning) Source #
- TrustedTester
- Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
jclSchemaInline :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Deprecated
- The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
jclIgnoreUnknownValues :: Lens' JobConfigurationLoad (Maybe Bool) Source #
- Optional
- Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
jclSchemaUpdateOptions :: Lens' JobConfigurationLoad [Text] Source #
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
jclCreateDisPosition :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
jclSchemaInlineFormat :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Deprecated
- The format of the schemaInline property.
jclAllowQuotedNewlines :: Lens' JobConfigurationLoad (Maybe Bool) Source #
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
jclSourceFormat :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
jclUseAvroLogicalTypes :: Lens' JobConfigurationLoad (Maybe Bool) Source #
- Optional
- If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
jclSchema :: Lens' JobConfigurationLoad (Maybe TableSchema) Source #
- Optional
- The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
jclTimePartitioning :: Lens' JobConfigurationLoad (Maybe TimePartitioning) Source #
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
jclQuote :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
jclMaxBadRecords :: Lens' JobConfigurationLoad (Maybe Int32) Source #
- Optional
- The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
jclAutodetect :: Lens' JobConfigurationLoad (Maybe Bool) Source #
- Optional
- Indicates if we should automatically infer the options and schema for CSV and JSON sources.
jclSourceURIs :: Lens' JobConfigurationLoad [Text] Source #
- Required
- The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.
jclEncoding :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
jclDestinationTableProperties :: Lens' JobConfigurationLoad (Maybe DestinationTableProperties) Source #
- Beta
- [Optional] Properties with which to create the destination table if it is new.
jclDestinationEncryptionConfiguration :: Lens' JobConfigurationLoad (Maybe EncryptionConfiguration) Source #
Custom encryption configuration (e.g., Cloud KMS keys).
jclFieldDelimiter :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
jclNullMarker :: Lens' JobConfigurationLoad (Maybe Text) Source #
- Optional
- Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
JobsListStateFilter
data JobsListStateFilter Source #
Filter for job state
Instances
DataSetReference
data DataSetReference Source #
Instances
dataSetReference :: DataSetReference Source #
Creates a value of DataSetReference
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsrDataSetId :: Lens' DataSetReference (Maybe Text) Source #
- Required
- A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
dsrProjectId :: Lens' DataSetReference (Maybe Text) Source #
- Optional
- The ID of the project containing this dataset.
MaterializedViewDefinition
data MaterializedViewDefinition Source #
Instances
materializedViewDefinition :: MaterializedViewDefinition Source #
Creates a value of MaterializedViewDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mvdQuery :: Lens' MaterializedViewDefinition (Maybe Text) Source #
- Required
- A query whose result is persisted.
mvdLastRefreshTime :: Lens' MaterializedViewDefinition (Maybe Int64) Source #
- Output-only
- [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.
TableDataInsertAllRequest
data TableDataInsertAllRequest Source #
Instances
tableDataInsertAllRequest :: TableDataInsertAllRequest Source #
Creates a value of TableDataInsertAllRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdiarIgnoreUnknownValues :: Lens' TableDataInsertAllRequest (Maybe Bool) Source #
- Optional
- Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
tdiarRows :: Lens' TableDataInsertAllRequest [TableDataInsertAllRequestRowsItem] Source #
The rows to insert.
tdiarTemplateSuffix :: Lens' TableDataInsertAllRequest (Maybe Text) Source #
If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
tdiarSkipInvalidRows :: Lens' TableDataInsertAllRequest (Maybe Bool) Source #
- Optional
- Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
GetServiceAccountResponse
data GetServiceAccountResponse Source #
Instances
getServiceAccountResponse :: GetServiceAccountResponse Source #
Creates a value of GetServiceAccountResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsarEmail :: Lens' GetServiceAccountResponse (Maybe Text) Source #
The service account email address.
ProjectListProjectsItem
data ProjectListProjectsItem Source #
Instances
projectListProjectsItem :: ProjectListProjectsItem Source #
Creates a value of ProjectListProjectsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
plpiFriendlyName :: Lens' ProjectListProjectsItem (Maybe Text) Source #
A descriptive name for this project.
plpiProjectReference :: Lens' ProjectListProjectsItem (Maybe ProjectReference) Source #
A unique reference to this project.
plpiNumericId :: Lens' ProjectListProjectsItem (Maybe Word64) Source #
The numeric ID of this project.
BigtableColumn
data BigtableColumn Source #
Instances
bigtableColumn :: BigtableColumn Source #
Creates a value of BigtableColumn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bcQualifierEncoded :: Lens' BigtableColumn (Maybe ByteString) Source #
- Required
- Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
bcFieldName :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
bcOnlyReadLatest :: Lens' BigtableColumn (Maybe Bool) Source #
- Optional
- If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.
bcType :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.
bcEncoding :: Lens' BigtableColumn (Maybe Text) Source #
- Optional
- The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.
Streamingbuffer
data Streamingbuffer Source #
Instances
streamingbuffer :: Streamingbuffer Source #
Creates a value of Streamingbuffer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sEstimatedBytes :: Lens' Streamingbuffer (Maybe Word64) Source #
- Output-only
- A lower-bound estimate of the number of bytes currently in the streaming buffer.
sOldestEntryTime :: Lens' Streamingbuffer (Maybe Word64) Source #
- Output-only
- Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.
sEstimatedRows :: Lens' Streamingbuffer (Maybe Word64) Source #
- Output-only
- A lower-bound estimate of the number of rows currently in the streaming buffer.
TableRow
Instances
Eq TableRow Source # | |
Data TableRow Source # | |
Defined in Network.Google.BigQuery.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TableRow -> c TableRow # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TableRow # toConstr :: TableRow -> Constr # dataTypeOf :: TableRow -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TableRow) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TableRow) # gmapT :: (forall b. Data b => b -> b) -> TableRow -> TableRow # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TableRow -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TableRow -> r # gmapQ :: (forall d. Data d => d -> u) -> TableRow -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TableRow -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TableRow -> m TableRow # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TableRow -> m TableRow # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TableRow -> m TableRow # | |
Show TableRow Source # | |
Generic TableRow Source # | |
ToJSON TableRow Source # | |
Defined in Network.Google.BigQuery.Types.Product | |
FromJSON TableRow Source # | |
type Rep TableRow Source # | |
Defined in Network.Google.BigQuery.Types.Product |
trF :: Lens' TableRow [TableCell] Source #
Represents a single row in the result set, consisting of one or more fields.
JobListJobsItem
data JobListJobsItem Source #
Instances
jobListJobsItem :: JobListJobsItem Source #
Creates a value of JobListJobsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jljiJobReference :: Lens' JobListJobsItem (Maybe JobReference) Source #
Job reference uniquely identifying the job.
jljiStatus :: Lens' JobListJobsItem (Maybe JobStatus) Source #
- Full-projection-only
- Describes the state of the job.
jljiState :: Lens' JobListJobsItem (Maybe Text) Source #
Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
jljiUserEmail :: Lens' JobListJobsItem (Maybe Text) Source #
- Full-projection-only
- Email address of the user who ran the job.
jljiErrorResult :: Lens' JobListJobsItem (Maybe ErrorProto) Source #
A result object that will be present only if the job has failed.
jljiStatistics :: Lens' JobListJobsItem (Maybe JobStatistics) Source #
- Output-only
- Information about the job, including starting time and ending time of the job.
jljiConfiguration :: Lens' JobListJobsItem (Maybe JobConfiguration) Source #
- Full-projection-only
- Specifies the job configuration.
TimePartitioning
data TimePartitioning Source #
Instances
timePartitioning :: TimePartitioning Source #
Creates a value of TimePartitioning
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpField :: Lens' TimePartitioning (Maybe Text) Source #
- Beta
- [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
tpExpirationMs :: Lens' TimePartitioning (Maybe Int64) Source #
- Optional
- Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
tpType :: Lens' TimePartitioning (Maybe Text) Source #
- Required
- The only type supported is DAY, which will generate one partition per day.
QueryParameterValueStructValues
data QueryParameterValueStructValues Source #
- Optional
- The struct field values, in order of the struct type's declaration.
See: queryParameterValueStructValues
smart constructor.
Instances
queryParameterValueStructValues Source #
Creates a value of QueryParameterValueStructValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DataSetLabels
data DataSetLabels Source #
The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.
See: dataSetLabels
smart constructor.
Instances
Creates a value of DataSetLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
JobConfiguration
data JobConfiguration Source #
Instances
jobConfiguration :: JobConfiguration Source #
Creates a value of JobConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jcJobType :: Lens' JobConfiguration (Maybe Text) Source #
- Output-only
- The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
jcCopy :: Lens' JobConfiguration (Maybe JobConfigurationTableCopy) Source #
- Pick one
- Copies a table.
jcLoad :: Lens' JobConfiguration (Maybe JobConfigurationLoad) Source #
- Pick one
- Configures a load job.
jcQuery :: Lens' JobConfiguration (Maybe JobConfigurationQuery) Source #
- Pick one
- Configures a query job.
jcJobTimeoutMs :: Lens' JobConfiguration (Maybe Int64) Source #
- Optional
- Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
jcExtract :: Lens' JobConfiguration (Maybe JobConfigurationExtract) Source #
- Pick one
- Configures an extract job.
jcLabels :: Lens' JobConfiguration (Maybe JobConfigurationLabels) Source #
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
jcDryRun :: Lens' JobConfiguration (Maybe Bool) Source #
- Optional
- If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Job
Instances
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jJobReference :: Lens' Job (Maybe JobReference) Source #
- Optional
- Reference describing the unique-per-user name of the job.
jStatus :: Lens' Job (Maybe JobStatus) Source #
- Output-only
- The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
jSelfLink :: Lens' Job (Maybe Text) Source #
- Output-only
- A URL that can be used to access this resource again.
jStatistics :: Lens' Job (Maybe JobStatistics) Source #
- Output-only
- Information about the job, including starting time and ending time of the job.
jConfiguration :: Lens' Job (Maybe JobConfiguration) Source #
- Required
- Describes the job configuration.
EncryptionConfiguration
data EncryptionConfiguration Source #
Instances
encryptionConfiguration :: EncryptionConfiguration Source #
Creates a value of EncryptionConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecKmsKeyName :: Lens' EncryptionConfiguration (Maybe Text) Source #
- Optional
- Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
TableDataInsertAllResponseInsertErrorsItem
data TableDataInsertAllResponseInsertErrorsItem Source #
Instances
tableDataInsertAllResponseInsertErrorsItem :: TableDataInsertAllResponseInsertErrorsItem Source #
Creates a value of TableDataInsertAllResponseInsertErrorsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdiarieiErrors :: Lens' TableDataInsertAllResponseInsertErrorsItem [ErrorProto] Source #
Error information for the row indicated by the index property.
tdiarieiIndex :: Lens' TableDataInsertAllResponseInsertErrorsItem (Maybe Word32) Source #
The index of the row that error applies to.
JobConfigurationExtract
data JobConfigurationExtract Source #
Instances
jobConfigurationExtract :: JobConfigurationExtract Source #
Creates a value of JobConfigurationExtract
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jceDestinationFormat :: Lens' JobConfigurationExtract (Maybe Text) Source #
- Optional
- The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV.
jceSourceTable :: Lens' JobConfigurationExtract (Maybe TableReference) Source #
- Required
- A reference to the table being exported.
jcePrintHeader :: Lens' JobConfigurationExtract Bool Source #
- Optional
- Whether to print out a header row in the results. Default is true.
jceCompression :: Lens' JobConfigurationExtract (Maybe Text) Source #
- Optional
- The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.
jceDestinationURIs :: Lens' JobConfigurationExtract [Text] Source #
- Pick one
- A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
jceDestinationURI :: Lens' JobConfigurationExtract (Maybe Text) Source #
- Pick one
- DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
jceFieldDelimiter :: Lens' JobConfigurationExtract (Maybe Text) Source #
- Optional
- Delimiter to use between fields in the exported data. Default is ','
ModelDefinition
data ModelDefinition Source #
Instances
modelDefinition :: ModelDefinition Source #
Creates a value of ModelDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdModelOptions :: Lens' ModelDefinition (Maybe ModelDefinitionModelOptions) Source #
- Output-only, Beta
- Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.
mdTrainingRuns :: Lens' ModelDefinition [TrainingRun] Source #
- Output-only, Beta
- Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.
JobCancelResponse
data JobCancelResponse Source #
Instances
jobCancelResponse :: JobCancelResponse Source #
Creates a value of JobCancelResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
JSONObject
data JSONObject Source #
Represents a single JSON object.
See: jsonObject
smart constructor.
Instances
Creates a value of JSONObject
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
JobConfigurationQuery
data JobConfigurationQuery Source #
Instances
jobConfigurationQuery :: JobConfigurationQuery Source #
Creates a value of JobConfigurationQuery
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jcqDestinationTable
jcqWriteDisPosition
jcqPriority
jcqClustering
jcqRangePartitioning
jcqUseQueryCache
jcqPreserveNulls
jcqTableDefinitions
jcqQueryParameters
jcqSchemaUpdateOptions
jcqMaximumBytesBilled
jcqCreateDisPosition
jcqUserDefinedFunctionResources
jcqAllowLargeResults
jcqMaximumBillingTier
jcqTimePartitioning
jcqQuery
jcqFlattenResults
jcqParameterMode
jcqUseLegacySQL
jcqDestinationEncryptionConfiguration
jcqDefaultDataSet
jcqDestinationTable :: Lens' JobConfigurationQuery (Maybe TableReference) Source #
- Optional
- Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
jcqWriteDisPosition :: Lens' JobConfigurationQuery (Maybe Text) Source #
- Optional
- Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
jcqPriority :: Lens' JobConfigurationQuery (Maybe Text) Source #
- Optional
- Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
jcqClustering :: Lens' JobConfigurationQuery (Maybe Clustering) Source #
- Beta
- Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
jcqRangePartitioning :: Lens' JobConfigurationQuery (Maybe RangePartitioning) Source #
- TrustedTester
- Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
jcqUseQueryCache :: Lens' JobConfigurationQuery Bool Source #
- Optional
- 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 a query does not have a destination table specified. The default value is true.
jcqPreserveNulls :: Lens' JobConfigurationQuery (Maybe Bool) Source #
- Deprecated
- This property is deprecated.
jcqTableDefinitions :: Lens' JobConfigurationQuery (Maybe JobConfigurationQueryTableDefinitions) Source #
- Optional
- If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
jcqQueryParameters :: Lens' JobConfigurationQuery [QueryParameter] Source #
Query parameters for standard SQL queries.
jcqSchemaUpdateOptions :: Lens' JobConfigurationQuery [Text] Source #
Allows 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. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
jcqMaximumBytesBilled :: Lens' JobConfigurationQuery (Maybe Int64) Source #
- Optional
- 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.
jcqCreateDisPosition :: Lens' JobConfigurationQuery (Maybe Text) Source #
- Optional
- Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
jcqUserDefinedFunctionResources :: Lens' JobConfigurationQuery [UserDefinedFunctionResource] Source #
Describes user-defined function resources used in the query.
jcqAllowLargeResults :: Lens' JobConfigurationQuery Bool Source #
- Optional
- If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
jcqMaximumBillingTier :: Lens' JobConfigurationQuery Int32 Source #
- Optional
- 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.
jcqTimePartitioning :: Lens' JobConfigurationQuery (Maybe TimePartitioning) Source #
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
jcqQuery :: Lens' JobConfigurationQuery (Maybe Text) Source #
- Required
- SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
jcqFlattenResults :: Lens' JobConfigurationQuery Bool Source #
- Optional
- If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
jcqParameterMode :: Lens' JobConfigurationQuery (Maybe Text) Source #
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named ('myparam) query parameters in this query.
jcqUseLegacySQL :: Lens' JobConfigurationQuery Bool Source #
Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
jcqDestinationEncryptionConfiguration :: Lens' JobConfigurationQuery (Maybe EncryptionConfiguration) Source #
Custom encryption configuration (e.g., Cloud KMS keys).
jcqDefaultDataSet :: Lens' JobConfigurationQuery (Maybe DataSetReference) Source #
- Optional
- Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
GoogleSheetsOptions
data GoogleSheetsOptions Source #
Instances
googleSheetsOptions :: GoogleSheetsOptions Source #
Creates a value of GoogleSheetsOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsoSkipLeadingRows :: Lens' GoogleSheetsOptions (Maybe Int64) Source #
- Optional
- The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
gsoRange :: Lens' GoogleSheetsOptions (Maybe Text) Source #
- Beta
- [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
TableDataInsertAllRequestRowsItem
data TableDataInsertAllRequestRowsItem Source #
Instances
tableDataInsertAllRequestRowsItem :: TableDataInsertAllRequestRowsItem Source #
Creates a value of TableDataInsertAllRequestRowsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tdiarriJSON :: Lens' TableDataInsertAllRequestRowsItem (Maybe JSONObject) Source #
- Required
- A JSON object that contains a row of data. The object's properties and values must match the destination table's schema.
tdiarriInsertId :: Lens' TableDataInsertAllRequestRowsItem (Maybe Text) Source #
- Optional
- A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.
JobList
Instances
Eq JobList Source # | |
Data JobList Source # | |
Defined in Network.Google.BigQuery.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobList -> c JobList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobList # toConstr :: JobList -> Constr # dataTypeOf :: JobList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JobList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobList) # gmapT :: (forall b. Data b => b -> b) -> JobList -> JobList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobList -> r # gmapQ :: (forall d. Data d => d -> u) -> JobList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JobList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobList -> m JobList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobList -> m JobList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobList -> m JobList # | |
Show JobList Source # | |
Generic JobList Source # | |
ToJSON JobList Source # | |
Defined in Network.Google.BigQuery.Types.Product | |
FromJSON JobList Source # | |
type Rep JobList Source # | |
Defined in Network.Google.BigQuery.Types.Product type Rep JobList = D1 (MetaData "JobList" "Network.Google.BigQuery.Types.Product" "gogol-bigquery-0.4.0-3wbQXUDNgiIGV0tYGk98l5" False) (C1 (MetaCons "JobList'" PrefixI True) ((S1 (MetaSel (Just "_jlEtag") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_jlNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_jlKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_jlJobs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [JobListJobsItem]))))) |
Creates a value of JobList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
JobConfigurationQueryTableDefinitions
data JobConfigurationQueryTableDefinitions Source #
- Optional
- If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
See: jobConfigurationQueryTableDefinitions
smart constructor.
Instances
jobConfigurationQueryTableDefinitions Source #
Creates a value of JobConfigurationQueryTableDefinitions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jcqtdAddtional :: Lens' JobConfigurationQueryTableDefinitions (HashMap Text ExternalDataConfiguration) Source #
TableCell
Instances
Eq TableCell Source # | |
Data TableCell Source # | |
Defined in Network.Google.BigQuery.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TableCell -> c TableCell # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TableCell # toConstr :: TableCell -> Constr # dataTypeOf :: TableCell -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TableCell) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TableCell) # gmapT :: (forall b. Data b => b -> b) -> TableCell -> TableCell # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TableCell -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TableCell -> r # gmapQ :: (forall d. Data d => d -> u) -> TableCell -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TableCell -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TableCell -> m TableCell # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TableCell -> m TableCell # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TableCell -> m TableCell # | |
Show TableCell Source # | |
Generic TableCell Source # | |
ToJSON TableCell Source # | |
Defined in Network.Google.BigQuery.Types.Product | |
FromJSON TableCell Source # | |
type Rep TableCell Source # | |
Defined in Network.Google.BigQuery.Types.Product |
JobStatistics2ReservationUsageItem
data JobStatistics2ReservationUsageItem Source #
Instances
jobStatistics2ReservationUsageItem :: JobStatistics2ReservationUsageItem Source #
Creates a value of JobStatistics2ReservationUsageItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jName :: Lens' JobStatistics2ReservationUsageItem (Maybe Text) Source #
- Output-only
- Reservation name or "unreserved" for on-demand resources usage.
jSlotMs :: Lens' JobStatistics2ReservationUsageItem (Maybe Int64) Source #
- Output-only
- Slot-milliseconds the job spent in the given reservation.
QueryParameterValue
data QueryParameterValue Source #
Instances
queryParameterValue :: QueryParameterValue Source #
Creates a value of QueryParameterValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qpvStructValues :: Lens' QueryParameterValue (Maybe QueryParameterValueStructValues) Source #
- Optional
- The struct field values, in order of the struct type's declaration.
qpvValue :: Lens' QueryParameterValue (Maybe Text) Source #
- Optional
- The value of this value, if a simple scalar type.
qpvArrayValues :: Lens' QueryParameterValue [QueryParameterValue] Source #
- Optional
- The array values, if this is an array type.
ViewDefinition
data ViewDefinition Source #
Instances
viewDefinition :: ViewDefinition Source #
Creates a value of ViewDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vdUserDefinedFunctionResources :: Lens' ViewDefinition [UserDefinedFunctionResource] Source #
Describes user-defined function resources used in the query.
vdQuery :: Lens' ViewDefinition (Maybe Text) Source #
- Required
- A query that BigQuery executes when the view is referenced.
vdUseLegacySQL :: Lens' ViewDefinition (Maybe Bool) Source #
Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.
UserDefinedFunctionResource
data UserDefinedFunctionResource Source #
Instances
userDefinedFunctionResource :: UserDefinedFunctionResource Source #
Creates a value of UserDefinedFunctionResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udfrResourceURI :: Lens' UserDefinedFunctionResource (Maybe Text) Source #
- Pick one
- A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
udfrInlineCode :: Lens' UserDefinedFunctionResource (Maybe Text) Source #
- Pick one
- An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
JobStatistics2
data JobStatistics2 Source #
Instances
jobStatistics2 :: JobStatistics2 Source #
Creates a value of JobStatistics2
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jModelTrainingExpectedTotalIteration
jModelTraining
jTotalSlotMs
jDdlTargetTable
jEstimatedBytesProcessed
jModelTrainingCurrentIteration
jSchema
jTotalBytesProcessed
jBillingTier
jTotalBytesProcessedAccuracy
jUndeclaredQueryParameters
jReferencedTables
jStatementType
jReservationUsage
jNumDmlAffectedRows
jTimeline
jQueryPlan
jCacheHit
jTotalBytesBilled
jDdlOperationPerformed
jTotalPartitionsProcessed
jModelTrainingExpectedTotalIteration :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only, Beta
- Deprecated; do not use.
jModelTraining :: Lens' JobStatistics2 (Maybe BigQueryModelTraining) Source #
- Output-only, Beta
- Information about create model query job progress.
jTotalSlotMs :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- Slot-milliseconds for the job.
jDdlTargetTable :: Lens' JobStatistics2 (Maybe TableReference) Source #
The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries.
jEstimatedBytesProcessed :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- The original estimate of bytes processed for the job.
jModelTrainingCurrentIteration :: Lens' JobStatistics2 (Maybe Int32) Source #
- Output-only, Beta
- Deprecated; do not use.
jSchema :: Lens' JobStatistics2 (Maybe TableSchema) Source #
- Output-only
- The schema of the results. Present only for successful dry run of non-legacy SQL queries.
jTotalBytesProcessed :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- Total bytes processed for the job.
jBillingTier :: Lens' JobStatistics2 (Maybe Int32) Source #
- Output-only
- Billing tier for the job.
jTotalBytesProcessedAccuracy :: Lens' JobStatistics2 (Maybe Text) Source #
- Output-only
- For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estiamte is upper bound of what the query would cost.
jUndeclaredQueryParameters :: Lens' JobStatistics2 [QueryParameter] Source #
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
jReferencedTables :: Lens' JobStatistics2 [TableReference] Source #
- Output-only
- Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
jStatementType :: Lens' JobStatistics2 (Maybe Text) Source #
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "DROP_TABLE": DROP TABLE query. "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_VIEW": DROP VIEW query. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query.
jReservationUsage :: Lens' JobStatistics2 [JobStatistics2ReservationUsageItem] Source #
- Output-only
- Job resource usage breakdown by reservation.
jNumDmlAffectedRows :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
jTimeline :: Lens' JobStatistics2 [QueryTimelineSample] Source #
- Output-only
- [Beta] Describes a timeline of job execution.
jQueryPlan :: Lens' JobStatistics2 [ExplainQueryStage] Source #
- Output-only
- Describes execution plan for the query.
jCacheHit :: Lens' JobStatistics2 (Maybe Bool) Source #
- Output-only
- Whether the query result was fetched from the query cache.
jTotalBytesBilled :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- Total bytes billed for the job.
jDdlOperationPerformed :: Lens' JobStatistics2 (Maybe Text) Source #
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
jTotalPartitionsProcessed :: Lens' JobStatistics2 (Maybe Int64) Source #
- Output-only
- Total number of partitions processed from all partitioned tables referenced in the job.
JobStatus
Instances
Eq JobStatus Source # | |
Data JobStatus Source # | |
Defined in Network.Google.BigQuery.Types.Product gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobStatus -> c JobStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobStatus # toConstr :: JobStatus -> Constr # dataTypeOf :: JobStatus -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JobStatus) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobStatus) # gmapT :: (forall b. Data b => b -> b) -> JobStatus -> JobStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> JobStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JobStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobStatus -> m JobStatus # | |
Show JobStatus Source # | |
Generic JobStatus Source # | |
ToJSON JobStatus Source # | |
Defined in Network.Google.BigQuery.Types.Product | |
FromJSON JobStatus Source # | |
type Rep JobStatus Source # | |
Defined in Network.Google.BigQuery.Types.Product type Rep JobStatus = D1 (MetaData "JobStatus" "Network.Google.BigQuery.Types.Product" "gogol-bigquery-0.4.0-3wbQXUDNgiIGV0tYGk98l5" False) (C1 (MetaCons "JobStatus'" PrefixI True) (S1 (MetaSel (Just "_jsState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_jsErrorResult") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ErrorProto)) :*: S1 (MetaSel (Just "_jsErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ErrorProto]))))) |
jobStatus :: JobStatus Source #
Creates a value of JobStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsErrorResult :: Lens' JobStatus (Maybe ErrorProto) Source #
- Output-only
- Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
jsErrors :: Lens' JobStatus [ErrorProto] Source #
- Output-only
- The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
TableLabels
data TableLabels Source #
The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
See: tableLabels
smart constructor.
Instances
Creates a value of TableLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DestinationTableProperties
data DestinationTableProperties Source #
Instances
destinationTableProperties :: DestinationTableProperties Source #
Creates a value of DestinationTableProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtpFriendlyName :: Lens' DestinationTableProperties (Maybe Text) Source #
- Optional
- The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
dtpDescription :: Lens' DestinationTableProperties (Maybe Text) Source #
- Optional
- The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
DataSetAccessItem
data DataSetAccessItem Source #
Instances
dataSetAccessItem :: DataSetAccessItem Source #
Creates a value of DataSetAccessItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsaiGroupByEmail :: Lens' DataSetAccessItem (Maybe Text) Source #
- Pick one
- An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".
dsaiDomain :: Lens' DataSetAccessItem (Maybe Text) Source #
- Pick one
- A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN".
dsaiSpecialGroup :: Lens' DataSetAccessItem (Maybe Text) Source #
- Pick one
- A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.
dsaiRole :: Lens' DataSetAccessItem (Maybe Text) Source #
- Required
- Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER.
dsaiIAMMember :: Lens' DataSetAccessItem (Maybe Text) Source #
- Pick one
- Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.
dsaiView :: Lens' DataSetAccessItem (Maybe TableReference) Source #
- Pick one
- A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation.
dsaiUserByEmail :: Lens' DataSetAccessItem (Maybe Text) Source #
- Pick one
- An email address of a user to grant access to. For example: fred'example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL".
TableDataInsertAllResponse
data TableDataInsertAllResponse Source #
Instances
tableDataInsertAllResponse :: TableDataInsertAllResponse Source #
Creates a value of TableDataInsertAllResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tInsertErrors :: Lens' TableDataInsertAllResponse [TableDataInsertAllResponseInsertErrorsItem] Source #
An array of errors for rows that were not inserted.
QueryParameterType
data QueryParameterType Source #
Instances
queryParameterType :: QueryParameterType Source #
Creates a value of QueryParameterType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qptStructTypes :: Lens' QueryParameterType [QueryParameterTypeStructTypesItem] Source #
- Optional
- The types of the fields of this struct, in order, if this is a struct.
qptArrayType :: Lens' QueryParameterType (Maybe QueryParameterType) Source #
- Optional
- The type of the array's elements, if this is an array.
Table
Instances
Creates a value of Table
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tabMaterializedView
tabCreationTime
tabEtag
tabNumBytes
tabClustering
tabExternalDataConfiguration
tabRangePartitioning
tabLocation
tabTableReference
tabFriendlyName
tabKind
tabLastModifiedTime
tabSchema
tabStreamingBuffer
tabSelfLink
tabRequirePartitionFilter
tabEncryptionConfiguration
tabModel
tabTimePartitioning
tabNumRows
tabNumPhysicalBytes
tabView
tabId
tabLabels
tabType
tabNumLongTermBytes
tabExpirationTime
tabDescription
tabMaterializedView :: Lens' Table (Maybe MaterializedViewDefinition) Source #
- Optional
- Materialized view definition.
tabCreationTime :: Lens' Table (Maybe Int64) Source #
- Output-only
- The time when this table was created, in milliseconds since the epoch.
tabEtag :: Lens' Table (Maybe Text) Source #
- Output-only
- A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.
tabNumBytes :: Lens' Table (Maybe Int64) Source #
- Output-only
- The size of this table in bytes, excluding any data in the streaming buffer.
tabClustering :: Lens' Table (Maybe Clustering) Source #
- Beta
- Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered.
tabExternalDataConfiguration :: Lens' Table (Maybe ExternalDataConfiguration) Source #
- Optional
- Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
tabRangePartitioning :: Lens' Table (Maybe RangePartitioning) Source #
- TrustedTester
- Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
tabLocation :: Lens' Table (Maybe Text) Source #
- Output-only
- The geographic location where the table resides. This value is inherited from the dataset.
tabTableReference :: Lens' Table (Maybe TableReference) Source #
- Required
- Reference describing the ID of this table.
tabLastModifiedTime :: Lens' Table (Maybe Word64) Source #
- Output-only
- The time when this table was last modified, in milliseconds since the epoch.
tabStreamingBuffer :: Lens' Table (Maybe Streamingbuffer) Source #
- Output-only
- Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer.
tabSelfLink :: Lens' Table (Maybe Text) Source #
- Output-only
- A URL that can be used to access this resource again.
tabRequirePartitionFilter :: Lens' Table Bool Source #
- Beta
- [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
tabEncryptionConfiguration :: Lens' Table (Maybe EncryptionConfiguration) Source #
Custom encryption configuration (e.g., Cloud KMS keys).
tabModel :: Lens' Table (Maybe ModelDefinition) Source #
- Output-only, Beta
- Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries.
tabTimePartitioning :: Lens' Table (Maybe TimePartitioning) Source #
Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
tabNumRows :: Lens' Table (Maybe Word64) Source #
- Output-only
- The number of rows of data in this table, excluding any data in the streaming buffer.
tabNumPhysicalBytes :: Lens' Table (Maybe Int64) Source #
- Output-only
- [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.
tabLabels :: Lens' Table (Maybe TableLabels) Source #
The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
tabType :: Lens' Table (Maybe Text) Source #
- Output-only
- Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.
tabNumLongTermBytes :: Lens' Table (Maybe Int64) Source #
- Output-only
- The number of bytes in the table that are considered "long-term storage".
tabExpirationTime :: Lens' Table (Maybe Int64) Source #
- Optional
- The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.
tabDescription :: Lens' Table (Maybe Text) Source #
- Optional
- A user-friendly description of this table.
ErrorProto
data ErrorProto Source #
Instances
errorProto :: ErrorProto Source #
Creates a value of ErrorProto
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epDebugInfo :: Lens' ErrorProto (Maybe Text) Source #
Debugging information. This property is internal to Google and should not be used.
epLocation :: Lens' ErrorProto (Maybe Text) Source #
Specifies where the error occurred, if present.
CSVOptions
data CSVOptions Source #
Instances
csvOptions :: CSVOptions Source #
Creates a value of CSVOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
coSkipLeadingRows :: Lens' CSVOptions (Maybe Int64) Source #
- Optional
- The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
coAllowJaggedRows :: Lens' CSVOptions (Maybe Bool) Source #
- Optional
- Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
coAllowQuotedNewlines :: Lens' CSVOptions (Maybe Bool) Source #
- Optional
- Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
coQuote :: Lens' CSVOptions Text Source #
- Optional
- The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
coEncoding :: Lens' CSVOptions (Maybe Text) Source #
- Optional
- The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
coFieldDelimiter :: Lens' CSVOptions (Maybe Text) Source #
- Optional
- The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
JobStatistics3
data JobStatistics3 Source #
Instances
jobStatistics3 :: JobStatistics3 Source #
Creates a value of JobStatistics3
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsInputFiles :: Lens' JobStatistics3 (Maybe Int64) Source #
- Output-only
- Number of source files in a load job.
jsOutputRows :: Lens' JobStatistics3 (Maybe Int64) Source #
- Output-only
- Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
jsOutputBytes :: Lens' JobStatistics3 (Maybe Int64) Source #
- Output-only
- Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
jsInputFileBytes :: Lens' JobStatistics3 (Maybe Int64) Source #
- Output-only
- Number of bytes of source data in a load job.
jsBadRecords :: Lens' JobStatistics3 (Maybe Int64) Source #
- Output-only
- The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
QueryResponse
data QueryResponse Source #
Instances
queryResponse :: QueryResponse Source #
Creates a value of QueryResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qJobReference :: Lens' QueryResponse (Maybe JobReference) Source #
Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
qSchema :: Lens' QueryResponse (Maybe TableSchema) Source #
The schema of the results. Present only when the query completes successfully.
qTotalBytesProcessed :: Lens' QueryResponse (Maybe Int64) Source #
The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
qRows :: Lens' QueryResponse [TableRow] Source #
An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
qPageToken :: Lens' QueryResponse (Maybe Text) Source #
A token used for paging results.
qNumDmlAffectedRows :: Lens' QueryResponse (Maybe Int64) Source #
- Output-only
- The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
qTotalRows :: Lens' QueryResponse (Maybe Word64) Source #
The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
qErrors :: Lens' QueryResponse [ErrorProto] Source #
- Output-only
- The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
qJobComplete :: Lens' QueryResponse (Maybe Bool) Source #
Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
qCacheHit :: Lens' QueryResponse (Maybe Bool) Source #
Whether the query result was fetched from the query cache.
DataSetListDataSetsItemLabels
data DataSetListDataSetsItemLabels Source #
The labels associated with this dataset. You can use these to organize and group your datasets.
See: dataSetListDataSetsItemLabels
smart constructor.
Instances
dataSetListDataSetsItemLabels Source #
Creates a value of DataSetListDataSetsItemLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
TrainingRun
data TrainingRun Source #
Instances
trainingRun :: TrainingRun Source #
Creates a value of TrainingRun
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trState :: Lens' TrainingRun (Maybe Text) Source #
- Output-only, Beta
- Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.
trStartTime :: Lens' TrainingRun (Maybe UTCTime) Source #
- Output-only, Beta
- Training run start time in milliseconds since the epoch.
trIterationResults :: Lens' TrainingRun [IterationResult] Source #
- Output-only, Beta
- List of each iteration results.
trTrainingOptions :: Lens' TrainingRun (Maybe TrainingRunTrainingOptions) Source #
- Output-only, Beta
- Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
TableListTablesItemView
data TableListTablesItemView Source #
Additional details for a view.
See: tableListTablesItemView
smart constructor.
Instances
tableListTablesItemView :: TableListTablesItemView Source #
Creates a value of TableListTablesItemView
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tltivUseLegacySQL :: Lens' TableListTablesItemView (Maybe Bool) Source #
True if view is defined in legacy SQL dialect, false if in standard SQL.
TableListTablesItemLabels
data TableListTablesItemLabels Source #
The labels associated with this table. You can use these to organize and group your tables.
See: tableListTablesItemLabels
smart constructor.
Instances
tableListTablesItemLabels Source #
Creates a value of TableListTablesItemLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired: