target.apidocs.com.google.api.services.bigquery.model.JobStatistics.html Maven / Gradle / Ivy

Go to download







JobStatistics (BigQuery API v2-rev20220422-1.32.1)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class JobStatistics



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.JobStatistics













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class JobStatistics
extends GenericJson
Model definition for JobStatistics.

  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 
JobStatistics.ReservationUsage
Model definition for JobStatisticsReservationUsage.







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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


JobStatistics() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


JobStatistics
clone() 


Double
getCompletionRatio()
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.



JobStatistics5
getCopy()
[Output-only] Statistics for a copy job.



Long
getCreationTime()
[Output-only] Creation time of this job, in milliseconds since the epoch.



Long
getEndTime()
[Output-only] End time of this job, in milliseconds since the epoch.



JobStatistics4
getExtract()
[Output-only] Statistics for an extract job.



JobStatistics3
getLoad()
[Output-only] Statistics for a load job.



Long
getNumChildJobs()
[Output-only] Number of child jobs executed.



String
getParentJobId()
[Output-only] If this is a child job, the id of the parent.



JobStatistics2
getQuery()
[Output-only] Statistics for a query job.



List<String>
getQuotaDeferments()
[Output-only] Quotas which delayed this job's start time.



String
getReservationId()
[Output-only] Name of the primary reservation assigned to this job.



List<JobStatistics.ReservationUsage>
getReservationUsage()
[Output-only] Job resource usage breakdown by reservation.



RowLevelSecurityStatistics
getRowLevelSecurityStatistics()
[Output-only] [Preview] Statistics for row-level security.



ScriptStatistics
getScriptStatistics()
[Output-only] Statistics for a child job of a script.



SessionInfo
getSessionInfo()
[Output-only] [Preview] Information of the session if this job is part of one.



Long
getStartTime()
[Output-only] Start time of this job, in milliseconds since the epoch.



Long
getTotalBytesProcessed()
[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.



Long
getTotalSlotMs()
[Output-only] Slot-milliseconds for the job.



TransactionInfo
getTransactionInfo()
[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of
 one.



JobStatistics
set(String fieldName,
   Object value) 


JobStatistics
setCompletionRatio(Double completionRatio)
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.



JobStatistics
setCopy(JobStatistics5 copy)
[Output-only] Statistics for a copy job.



JobStatistics
setCreationTime(Long creationTime)
[Output-only] Creation time of this job, in milliseconds since the epoch.



JobStatistics
setEndTime(Long endTime)
[Output-only] End time of this job, in milliseconds since the epoch.



JobStatistics
setExtract(JobStatistics4 extract)
[Output-only] Statistics for an extract job.



JobStatistics
setLoad(JobStatistics3 load)
[Output-only] Statistics for a load job.



JobStatistics
setNumChildJobs(Long numChildJobs)
[Output-only] Number of child jobs executed.



JobStatistics
setParentJobId(String parentJobId)
[Output-only] If this is a child job, the id of the parent.



JobStatistics
setQuery(JobStatistics2 query)
[Output-only] Statistics for a query job.



JobStatistics
setQuotaDeferments(List<String> quotaDeferments)
[Output-only] Quotas which delayed this job's start time.



JobStatistics
setReservationId(String reservationId)
[Output-only] Name of the primary reservation assigned to this job.



JobStatistics
setReservationUsage(List<JobStatistics.ReservationUsage> reservationUsage)
[Output-only] Job resource usage breakdown by reservation.



JobStatistics
setRowLevelSecurityStatistics(RowLevelSecurityStatistics rowLevelSecurityStatistics)
[Output-only] [Preview] Statistics for row-level security.



JobStatistics
setScriptStatistics(ScriptStatistics scriptStatistics)
[Output-only] Statistics for a child job of a script.



JobStatistics
setSessionInfo(SessionInfo sessionInfo)
[Output-only] [Preview] Information of the session if this job is part of one.



JobStatistics
setStartTime(Long startTime)
[Output-only] Start time of this job, in milliseconds since the epoch.



JobStatistics
setTotalBytesProcessed(Long totalBytesProcessed)
[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.



JobStatistics
setTotalSlotMs(Long totalSlotMs)
[Output-only] Slot-milliseconds for the job.



JobStatistics
setTransactionInfo(TransactionInfo transactionInfo)
[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of
 one.







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














Constructor Detail





JobStatistics
public JobStatistics()









Method Detail





getCompletionRatio
public Double getCompletionRatio()
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

Returns:
value or null for none








setCompletionRatio
public JobStatistics setCompletionRatio(Double completionRatio)
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

Parameters:
completionRatio - completionRatio or null for none








getCopy
public JobStatistics5 getCopy()
[Output-only] Statistics for a copy job.

Returns:
value or null for none








setCopy
public JobStatistics setCopy(JobStatistics5 copy)
[Output-only] Statistics for a copy job.

Parameters:
copy - copy or null for none








getCreationTime
public Long getCreationTime()
[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be
 present on all jobs.

Returns:
value or null for none








setCreationTime
public JobStatistics setCreationTime(Long creationTime)
[Output-only] Creation time of this job, in milliseconds since the epoch. This field will be
 present on all jobs.

Parameters:
creationTime - creationTime or null for none








getEndTime
public Long getEndTime()
[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.

Returns:
value or null for none








setEndTime
public JobStatistics setEndTime(Long endTime)
[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.

Parameters:
endTime - endTime or null for none








getExtract
public JobStatistics4 getExtract()
[Output-only] Statistics for an extract job.

Returns:
value or null for none








setExtract
public JobStatistics setExtract(JobStatistics4 extract)
[Output-only] Statistics for an extract job.

Parameters:
extract - extract or null for none








getLoad
public JobStatistics3 getLoad()
[Output-only] Statistics for a load job.

Returns:
value or null for none








setLoad
public JobStatistics setLoad(JobStatistics3 load)
[Output-only] Statistics for a load job.

Parameters:
load - load or null for none








getNumChildJobs
public Long getNumChildJobs()
[Output-only] Number of child jobs executed.

Returns:
value or null for none








setNumChildJobs
public JobStatistics setNumChildJobs(Long numChildJobs)
[Output-only] Number of child jobs executed.

Parameters:
numChildJobs - numChildJobs or null for none








getParentJobId
public String getParentJobId()
[Output-only] If this is a child job, the id of the parent.

Returns:
value or null for none








setParentJobId
public JobStatistics setParentJobId(String parentJobId)
[Output-only] If this is a child job, the id of the parent.

Parameters:
parentJobId - parentJobId or null for none








getQuery
public JobStatistics2 getQuery()
[Output-only] Statistics for a query job.

Returns:
value or null for none








setQuery
public JobStatistics setQuery(JobStatistics2 query)
[Output-only] Statistics for a query job.

Parameters:
query - query or null for none








getQuotaDeferments
public List<String> getQuotaDeferments()
[Output-only] Quotas which delayed this job's start time.

Returns:
value or null for none








setQuotaDeferments
public JobStatistics setQuotaDeferments(List<String> quotaDeferments)
[Output-only] Quotas which delayed this job's start time.

Parameters:
quotaDeferments - quotaDeferments or null for none








getReservationUsage
public List<JobStatistics.ReservationUsage> getReservationUsage()
[Output-only] Job resource usage breakdown by reservation.

Returns:
value or null for none








setReservationUsage
public JobStatistics setReservationUsage(List<JobStatistics.ReservationUsage> reservationUsage)
[Output-only] Job resource usage breakdown by reservation.

Parameters:
reservationUsage - reservationUsage or null for none








getReservationId
public String getReservationId()
[Output-only] Name of the primary reservation assigned to this job. Note that this could be
 different than reservations reported in the reservation usage field if parent reservations were
 used to execute this job.

Returns:
value or null for none








setReservationId
public JobStatistics setReservationId(String reservationId)
[Output-only] Name of the primary reservation assigned to this job. Note that this could be
 different than reservations reported in the reservation usage field if parent reservations were
 used to execute this job.

Parameters:
reservationId - reservationId or null for none








getRowLevelSecurityStatistics
public RowLevelSecurityStatistics getRowLevelSecurityStatistics()
[Output-only] [Preview] Statistics for row-level security. Present only for query and extract
 jobs.

Returns:
value or null for none








setRowLevelSecurityStatistics
public JobStatistics setRowLevelSecurityStatistics(RowLevelSecurityStatistics rowLevelSecurityStatistics)
[Output-only] [Preview] Statistics for row-level security. Present only for query and extract
 jobs.

Parameters:
rowLevelSecurityStatistics - rowLevelSecurityStatistics or null for none








getScriptStatistics
public ScriptStatistics getScriptStatistics()
[Output-only] Statistics for a child job of a script.

Returns:
value or null for none








setScriptStatistics
public JobStatistics setScriptStatistics(ScriptStatistics scriptStatistics)
[Output-only] Statistics for a child job of a script.

Parameters:
scriptStatistics - scriptStatistics or null for none








getSessionInfo
public SessionInfo getSessionInfo()
[Output-only] [Preview] Information of the session if this job is part of one.

Returns:
value or null for none








setSessionInfo
public JobStatistics setSessionInfo(SessionInfo sessionInfo)
[Output-only] [Preview] Information of the session if this job is part of one.

Parameters:
sessionInfo - sessionInfo or null for none








getStartTime
public Long getStartTime()
[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.

Returns:
value or null for none








setStartTime
public JobStatistics setStartTime(Long startTime)
[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.

Parameters:
startTime - startTime or null for none








getTotalBytesProcessed
public Long getTotalBytesProcessed()
[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

Returns:
value or null for none








setTotalBytesProcessed
public JobStatistics setTotalBytesProcessed(Long totalBytesProcessed)
[Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

Parameters:
totalBytesProcessed - totalBytesProcessed or null for none








getTotalSlotMs
public Long getTotalSlotMs()
[Output-only] Slot-milliseconds for the job.

Returns:
value or null for none








setTotalSlotMs
public JobStatistics setTotalSlotMs(Long totalSlotMs)
[Output-only] Slot-milliseconds for the job.

Parameters:
totalSlotMs - totalSlotMs or null for none








getTransactionInfo
public TransactionInfo getTransactionInfo()
[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of
 one.

Returns:
value or null for none








setTransactionInfo
public JobStatistics setTransactionInfo(TransactionInfo transactionInfo)
[Output-only] [Alpha] Information of the multi-statement transaction if this job is part of
 one.

Parameters:
transactionInfo - transactionInfo or null for none








set
public JobStatistics set(String fieldName,
                         Object value)

Overrides:
set in class GenericJson








clone
public JobStatistics clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2022 Google. All rights reserved.

Modifier and Type	Method and Description
`JobStatistics`	`clone()`
`Double`	`getCompletionRatio()` [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
`JobStatistics5`	`getCopy()` [Output-only] Statistics for a copy job.
`Long`	`getCreationTime()` [Output-only] Creation time of this job, in milliseconds since the epoch.
`Long`	`getEndTime()` [Output-only] End time of this job, in milliseconds since the epoch.
`JobStatistics4`	`getExtract()` [Output-only] Statistics for an extract job.
`JobStatistics3`	`getLoad()` [Output-only] Statistics for a load job.
`Long`	`getNumChildJobs()` [Output-only] Number of child jobs executed.
`String`	`getParentJobId()` [Output-only] If this is a child job, the id of the parent.
`JobStatistics2`	`getQuery()` [Output-only] Statistics for a query job.
`List<String>`	`getQuotaDeferments()` [Output-only] Quotas which delayed this job's start time.
`String`	`getReservationId()` [Output-only] Name of the primary reservation assigned to this job.
`List<JobStatistics.ReservationUsage>`	`getReservationUsage()` [Output-only] Job resource usage breakdown by reservation.
`RowLevelSecurityStatistics`	`getRowLevelSecurityStatistics()` [Output-only] [Preview] Statistics for row-level security.
`ScriptStatistics`	`getScriptStatistics()` [Output-only] Statistics for a child job of a script.
`SessionInfo`	`getSessionInfo()` [Output-only] [Preview] Information of the session if this job is part of one.
`Long`	`getStartTime()` [Output-only] Start time of this job, in milliseconds since the epoch.
`Long`	`getTotalBytesProcessed()` [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
`Long`	`getTotalSlotMs()` [Output-only] Slot-milliseconds for the job.
`TransactionInfo`	`getTransactionInfo()` [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
`JobStatistics`	`set(String fieldName, Object value)`
`JobStatistics`	`setCompletionRatio(Double completionRatio)` [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
`JobStatistics`	`setCopy(JobStatistics5 copy)` [Output-only] Statistics for a copy job.
`JobStatistics`	`setCreationTime(Long creationTime)` [Output-only] Creation time of this job, in milliseconds since the epoch.
`JobStatistics`	`setEndTime(Long endTime)` [Output-only] End time of this job, in milliseconds since the epoch.
`JobStatistics`	`setExtract(JobStatistics4 extract)` [Output-only] Statistics for an extract job.
`JobStatistics`	`setLoad(JobStatistics3 load)` [Output-only] Statistics for a load job.
`JobStatistics`	`setNumChildJobs(Long numChildJobs)` [Output-only] Number of child jobs executed.
`JobStatistics`	`setParentJobId(String parentJobId)` [Output-only] If this is a child job, the id of the parent.
`JobStatistics`	`setQuery(JobStatistics2 query)` [Output-only] Statistics for a query job.
`JobStatistics`	`setQuotaDeferments(List<String> quotaDeferments)` [Output-only] Quotas which delayed this job's start time.
`JobStatistics`	`setReservationId(String reservationId)` [Output-only] Name of the primary reservation assigned to this job.
`JobStatistics`	`setReservationUsage(List<JobStatistics.ReservationUsage> reservationUsage)` [Output-only] Job resource usage breakdown by reservation.
`JobStatistics`	`setRowLevelSecurityStatistics(RowLevelSecurityStatistics rowLevelSecurityStatistics)` [Output-only] [Preview] Statistics for row-level security.
`JobStatistics`	`setScriptStatistics(ScriptStatistics scriptStatistics)` [Output-only] Statistics for a child job of a script.
`JobStatistics`	`setSessionInfo(SessionInfo sessionInfo)` [Output-only] [Preview] Information of the session if this job is part of one.
`JobStatistics`	`setStartTime(Long startTime)` [Output-only] Start time of this job, in milliseconds since the epoch.
`JobStatistics`	`setTotalBytesProcessed(Long totalBytesProcessed)` [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
`JobStatistics`	`setTotalSlotMs(Long totalSlotMs)` [Output-only] Slot-milliseconds for the job.
`JobStatistics`	`setTransactionInfo(TransactionInfo transactionInfo)` [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.