target.apidocs.com.google.api.services.bigquery.model.JobStatistics2.html Maven / Gradle / Ivy
JobStatistics2 (BigQuery API v2-rev20190616-1.29.2)
com.google.api.services.bigquery.model
Class JobStatistics2
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.bigquery.model.JobStatistics2
-
public final class JobStatistics2
extends GenericJson
Model definition for JobStatistics2.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the BigQuery API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
static class
JobStatistics2.ReservationUsage
Model definition for JobStatistics2ReservationUsage.
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
JobStatistics2()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
JobStatistics2
clone()
Integer
getBillingTier()
[Output-only] Billing tier for the job.
Boolean
getCacheHit()
[Output-only] Whether the query result was fetched from the query cache.
String
getDdlOperationPerformed()
The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
RoutineReference
getDdlTargetRoutine()
The DDL target routine.
TableReference
getDdlTargetTable()
The DDL target table.
Long
getEstimatedBytesProcessed()
[Output-only] The original estimate of bytes processed for the job.
BigQueryModelTraining
getModelTraining()
[Output-only, Beta] Information about create model query job progress.
Integer
getModelTrainingCurrentIteration()
[Output-only, Beta] Deprecated; do not use.
Long
getModelTrainingExpectedTotalIteration()
[Output-only, Beta] Deprecated; do not use.
Long
getNumDmlAffectedRows()
[Output-only] The number of rows affected by a DML statement.
List<ExplainQueryStage>
getQueryPlan()
[Output-only] Describes execution plan for the query.
List<TableReference>
getReferencedTables()
[Output-only] Referenced tables for the job.
List<JobStatistics2.ReservationUsage>
getReservationUsage()
[Output-only] Job resource usage breakdown by reservation.
TableSchema
getSchema()
[Output-only] The schema of the results.
String
getStatementType()
The type of query statement, if valid.
List<QueryTimelineSample>
getTimeline()
[Output-only] [Beta] Describes a timeline of job execution.
Long
getTotalBytesBilled()
[Output-only] Total bytes billed for the job.
Long
getTotalBytesProcessed()
[Output-only] Total bytes processed for the job.
String
getTotalBytesProcessedAccuracy()
[Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the
accuracy of the estimate.
Long
getTotalPartitionsProcessed()
[Output-only] Total number of partitions processed from all partitioned tables referenced in
the job.
Long
getTotalSlotMs()
[Output-only] Slot-milliseconds for the job.
List<QueryParameter>
getUndeclaredQueryParameters()
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
JobStatistics2
set(String fieldName,
Object value)
JobStatistics2
setBillingTier(Integer billingTier)
[Output-only] Billing tier for the job.
JobStatistics2
setCacheHit(Boolean cacheHit)
[Output-only] Whether the query result was fetched from the query cache.
JobStatistics2
setDdlOperationPerformed(String ddlOperationPerformed)
The DDL operation performed, possibly dependent on the pre-existence of the DDL target.
JobStatistics2
setDdlTargetRoutine(RoutineReference ddlTargetRoutine)
The DDL target routine.
JobStatistics2
setDdlTargetTable(TableReference ddlTargetTable)
The DDL target table.
JobStatistics2
setEstimatedBytesProcessed(Long estimatedBytesProcessed)
[Output-only] The original estimate of bytes processed for the job.
JobStatistics2
setModelTraining(BigQueryModelTraining modelTraining)
[Output-only, Beta] Information about create model query job progress.
JobStatistics2
setModelTrainingCurrentIteration(Integer modelTrainingCurrentIteration)
[Output-only, Beta] Deprecated; do not use.
JobStatistics2
setModelTrainingExpectedTotalIteration(Long modelTrainingExpectedTotalIteration)
[Output-only, Beta] Deprecated; do not use.
JobStatistics2
setNumDmlAffectedRows(Long numDmlAffectedRows)
[Output-only] The number of rows affected by a DML statement.
JobStatistics2
setQueryPlan(List<ExplainQueryStage> queryPlan)
[Output-only] Describes execution plan for the query.
JobStatistics2
setReferencedTables(List<TableReference> referencedTables)
[Output-only] Referenced tables for the job.
JobStatistics2
setReservationUsage(List<JobStatistics2.ReservationUsage> reservationUsage)
[Output-only] Job resource usage breakdown by reservation.
JobStatistics2
setSchema(TableSchema schema)
[Output-only] The schema of the results.
JobStatistics2
setStatementType(String statementType)
The type of query statement, if valid.
JobStatistics2
setTimeline(List<QueryTimelineSample> timeline)
[Output-only] [Beta] Describes a timeline of job execution.
JobStatistics2
setTotalBytesBilled(Long totalBytesBilled)
[Output-only] Total bytes billed for the job.
JobStatistics2
setTotalBytesProcessed(Long totalBytesProcessed)
[Output-only] Total bytes processed for the job.
JobStatistics2
setTotalBytesProcessedAccuracy(String totalBytesProcessedAccuracy)
[Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the
accuracy of the estimate.
JobStatistics2
setTotalPartitionsProcessed(Long totalPartitionsProcessed)
[Output-only] Total number of partitions processed from all partitioned tables referenced in
the job.
JobStatistics2
setTotalSlotMs(Long totalSlotMs)
[Output-only] Slot-milliseconds for the job.
JobStatistics2
setUndeclaredQueryParameters(List<QueryParameter> undeclaredQueryParameters)
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getBillingTier
public Integer getBillingTier()
[Output-only] Billing tier for the job.
- Returns:
- value or
null
for none
-
setBillingTier
public JobStatistics2 setBillingTier(Integer billingTier)
[Output-only] Billing tier for the job.
- Parameters:
billingTier
- billingTier or null
for none
-
getCacheHit
public Boolean getCacheHit()
[Output-only] Whether the query result was fetched from the query cache.
- Returns:
- value or
null
for none
-
setCacheHit
public JobStatistics2 setCacheHit(Boolean cacheHit)
[Output-only] Whether the query result was fetched from the query cache.
- Parameters:
cacheHit
- cacheHit or null
for none
-
getDdlOperationPerformed
public String getDdlOperationPerformed()
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.
- Returns:
- value or
null
for none
-
setDdlOperationPerformed
public JobStatistics2 setDdlOperationPerformed(String ddlOperationPerformed)
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.
- Parameters:
ddlOperationPerformed
- ddlOperationPerformed or null
for none
-
getDdlTargetRoutine
public RoutineReference getDdlTargetRoutine()
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Returns:
- value or
null
for none
-
setDdlTargetRoutine
public JobStatistics2 setDdlTargetRoutine(RoutineReference ddlTargetRoutine)
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Parameters:
ddlTargetRoutine
- ddlTargetRoutine or null
for none
-
getDdlTargetTable
public TableReference getDdlTargetTable()
The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries.
- Returns:
- value or
null
for none
-
setDdlTargetTable
public JobStatistics2 setDdlTargetTable(TableReference ddlTargetTable)
The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries.
- Parameters:
ddlTargetTable
- ddlTargetTable or null
for none
-
getEstimatedBytesProcessed
public Long getEstimatedBytesProcessed()
[Output-only] The original estimate of bytes processed for the job.
- Returns:
- value or
null
for none
-
setEstimatedBytesProcessed
public JobStatistics2 setEstimatedBytesProcessed(Long estimatedBytesProcessed)
[Output-only] The original estimate of bytes processed for the job.
- Parameters:
estimatedBytesProcessed
- estimatedBytesProcessed or null
for none
-
getModelTraining
public BigQueryModelTraining getModelTraining()
[Output-only, Beta] Information about create model query job progress.
- Returns:
- value or
null
for none
-
setModelTraining
public JobStatistics2 setModelTraining(BigQueryModelTraining modelTraining)
[Output-only, Beta] Information about create model query job progress.
- Parameters:
modelTraining
- modelTraining or null
for none
-
getModelTrainingCurrentIteration
public Integer getModelTrainingCurrentIteration()
[Output-only, Beta] Deprecated; do not use.
- Returns:
- value or
null
for none
-
setModelTrainingCurrentIteration
public JobStatistics2 setModelTrainingCurrentIteration(Integer modelTrainingCurrentIteration)
[Output-only, Beta] Deprecated; do not use.
- Parameters:
modelTrainingCurrentIteration
- modelTrainingCurrentIteration or null
for none
-
getModelTrainingExpectedTotalIteration
public Long getModelTrainingExpectedTotalIteration()
[Output-only, Beta] Deprecated; do not use.
- Returns:
- value or
null
for none
-
setModelTrainingExpectedTotalIteration
public JobStatistics2 setModelTrainingExpectedTotalIteration(Long modelTrainingExpectedTotalIteration)
[Output-only, Beta] Deprecated; do not use.
- Parameters:
modelTrainingExpectedTotalIteration
- modelTrainingExpectedTotalIteration or null
for none
-
getNumDmlAffectedRows
public Long getNumDmlAffectedRows()
[Output-only] The number of rows affected by a DML statement. Present only for DML statements
INSERT, UPDATE or DELETE.
- Returns:
- value or
null
for none
-
setNumDmlAffectedRows
public JobStatistics2 setNumDmlAffectedRows(Long numDmlAffectedRows)
[Output-only] The number of rows affected by a DML statement. Present only for DML statements
INSERT, UPDATE or DELETE.
- Parameters:
numDmlAffectedRows
- numDmlAffectedRows or null
for none
-
getQueryPlan
public List<ExplainQueryStage> getQueryPlan()
[Output-only] Describes execution plan for the query.
- Returns:
- value or
null
for none
-
setQueryPlan
public JobStatistics2 setQueryPlan(List<ExplainQueryStage> queryPlan)
[Output-only] Describes execution plan for the query.
- Parameters:
queryPlan
- queryPlan or null
for none
-
getReferencedTables
public List<TableReference> getReferencedTables()
[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will
not have a complete list.
- Returns:
- value or
null
for none
-
setReferencedTables
public JobStatistics2 setReferencedTables(List<TableReference> referencedTables)
[Output-only] Referenced tables for the job. Queries that reference more than 50 tables will
not have a complete list.
- Parameters:
referencedTables
- referencedTables or null
for none
-
getReservationUsage
public List<JobStatistics2.ReservationUsage> getReservationUsage()
[Output-only] Job resource usage breakdown by reservation.
- Returns:
- value or
null
for none
-
setReservationUsage
public JobStatistics2 setReservationUsage(List<JobStatistics2.ReservationUsage> reservationUsage)
[Output-only] Job resource usage breakdown by reservation.
- Parameters:
reservationUsage
- reservationUsage or null
for none
-
getSchema
public TableSchema getSchema()
[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL
queries.
- Returns:
- value or
null
for none
-
setSchema
public JobStatistics2 setSchema(TableSchema schema)
[Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL
queries.
- Parameters:
schema
- schema or null
for none
-
getStatementType
public String getStatementType()
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. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query.
"CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS
SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE]
TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ...
. "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION
query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW":
DROP VIEW query.
- Returns:
- value or
null
for none
-
setStatementType
public JobStatistics2 setStatementType(String statementType)
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. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query.
"CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS
SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE]
TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ...
. "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION
query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW":
DROP VIEW query.
- Parameters:
statementType
- statementType or null
for none
-
getTimeline
public List<QueryTimelineSample> getTimeline()
[Output-only] [Beta] Describes a timeline of job execution.
- Returns:
- value or
null
for none
-
setTimeline
public JobStatistics2 setTimeline(List<QueryTimelineSample> timeline)
[Output-only] [Beta] Describes a timeline of job execution.
- Parameters:
timeline
- timeline or null
for none
-
getTotalBytesBilled
public Long getTotalBytesBilled()
[Output-only] Total bytes billed for the job.
- Returns:
- value or
null
for none
-
setTotalBytesBilled
public JobStatistics2 setTotalBytesBilled(Long totalBytesBilled)
[Output-only] Total bytes billed for the job.
- Parameters:
totalBytesBilled
- totalBytesBilled or null
for none
-
getTotalBytesProcessed
public Long getTotalBytesProcessed()
[Output-only] Total bytes processed for the job.
- Returns:
- value or
null
for none
-
setTotalBytesProcessed
public JobStatistics2 setTotalBytesProcessed(Long totalBytesProcessed)
[Output-only] Total bytes processed for the job.
- Parameters:
totalBytesProcessed
- totalBytesProcessed or null
for none
-
getTotalBytesProcessedAccuracy
public String getTotalBytesProcessedAccuracy()
[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: estimate is upper bound of what the query would cost.
- Returns:
- value or
null
for none
-
setTotalBytesProcessedAccuracy
public JobStatistics2 setTotalBytesProcessedAccuracy(String totalBytesProcessedAccuracy)
[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: estimate is upper bound of what the query would cost.
- Parameters:
totalBytesProcessedAccuracy
- totalBytesProcessedAccuracy or null
for none
-
getTotalPartitionsProcessed
public Long getTotalPartitionsProcessed()
[Output-only] Total number of partitions processed from all partitioned tables referenced in
the job.
- Returns:
- value or
null
for none
-
setTotalPartitionsProcessed
public JobStatistics2 setTotalPartitionsProcessed(Long totalPartitionsProcessed)
[Output-only] Total number of partitions processed from all partitioned tables referenced in
the job.
- Parameters:
totalPartitionsProcessed
- totalPartitionsProcessed or null
for none
-
getTotalSlotMs
public Long getTotalSlotMs()
[Output-only] Slot-milliseconds for the job.
- Returns:
- value or
null
for none
-
setTotalSlotMs
public JobStatistics2 setTotalSlotMs(Long totalSlotMs)
[Output-only] Slot-milliseconds for the job.
- Parameters:
totalSlotMs
- totalSlotMs or null
for none
-
getUndeclaredQueryParameters
public List<QueryParameter> getUndeclaredQueryParameters()
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- Returns:
- value or
null
for none
-
setUndeclaredQueryParameters
public JobStatistics2 setUndeclaredQueryParameters(List<QueryParameter> undeclaredQueryParameters)
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- Parameters:
undeclaredQueryParameters
- undeclaredQueryParameters or null
for none
-
set
public JobStatistics2 set(String fieldName,
Object value)
- Overrides:
set
in class GenericJson
-
clone
public JobStatistics2 clone()
- Overrides:
clone
in class GenericJson
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy