JobStatistics (BigQuery API v2-rev20240803-2.0.0)

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 com.google.api.client.json.GenericJson
```
Statistics for a single job execution.
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
Job resource usage breakdown by reservation.
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.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>

Nested Classes
Modifier and Type	Class and Description
`static class`	`JobStatistics.ReservationUsage` Job resource usage breakdown by reservation.

Constructor Summary

Constructors
Constructor and Description

JobStatistics()

Constructors
Constructor and Description
`JobStatistics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobStatistics`	`clone()`
`Double`	`getCompletionRatio()` Output only.
`JobStatistics5`	`getCopy()` Output only.
`Long`	`getCreationTime()` Output only.
`DataMaskingStatistics`	`getDataMaskingStatistics()` Output only.
`String`	`getEdition()` Output only.
`Long`	`getEndTime()` Output only.
`JobStatistics4`	`getExtract()` Output only.
`Long`	`getFinalExecutionDurationMs()` Output only.
`JobStatistics3`	`getLoad()` Output only.
`Long`	`getNumChildJobs()` Output only.
`String`	`getParentJobId()` Output only.
`JobStatistics2`	`getQuery()` Output only.
`List<String>`	`getQuotaDeferments()` Output only.
`String`	`getReservationId()` Output only.
`List<JobStatistics.ReservationUsage>`	`getReservationUsage()` Output only.
`RowLevelSecurityStatistics`	`getRowLevelSecurityStatistics()` Output only.
`ScriptStatistics`	`getScriptStatistics()` Output only.
`SessionInfo`	`getSessionInfo()` Output only.
`Long`	`getStartTime()` Output only.
`Long`	`getTotalBytesProcessed()` Output only.
`Long`	`getTotalSlotMs()` Output only.
`TransactionInfo`	`getTransactionInfo()` Output only.
`JobStatistics`	`set(String fieldName, Object value)`
`JobStatistics`	`setCompletionRatio(Double completionRatio)` Output only.
`JobStatistics`	`setCopy(JobStatistics5 copy)` Output only.
`JobStatistics`	`setCreationTime(Long creationTime)` Output only.
`JobStatistics`	`setDataMaskingStatistics(DataMaskingStatistics dataMaskingStatistics)` Output only.
`JobStatistics`	`setEdition(String edition)` Output only.
`JobStatistics`	`setEndTime(Long endTime)` Output only.
`JobStatistics`	`setExtract(JobStatistics4 extract)` Output only.
`JobStatistics`	`setFinalExecutionDurationMs(Long finalExecutionDurationMs)` Output only.
`JobStatistics`	`setLoad(JobStatistics3 load)` Output only.
`JobStatistics`	`setNumChildJobs(Long numChildJobs)` Output only.
`JobStatistics`	`setParentJobId(String parentJobId)` Output only.
`JobStatistics`	`setQuery(JobStatistics2 query)` Output only.
`JobStatistics`	`setQuotaDeferments(List<String> quotaDeferments)` Output only.
`JobStatistics`	`setReservationId(String reservationId)` Output only.
`JobStatistics`	`setReservationUsage(List<JobStatistics.ReservationUsage> reservationUsage)` Output only.
`JobStatistics`	`setRowLevelSecurityStatistics(RowLevelSecurityStatistics rowLevelSecurityStatistics)` Output only.
`JobStatistics`	`setScriptStatistics(ScriptStatistics scriptStatistics)` Output only.
`JobStatistics`	`setSessionInfo(SessionInfo sessionInfo)` Output only.
`JobStatistics`	`setStartTime(Long startTime)` Output only.
`JobStatistics`	`setTotalBytesProcessed(Long totalBytesProcessed)` Output only.
`JobStatistics`	`setTotalSlotMs(Long totalSlotMs)` Output only.
`JobStatistics`	`setTransactionInfo(TransactionInfo transactionInfo)` Output only.

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()
```
    Output only. [TrustedTester] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
    
    Returns:
    
    value or null for none
  - setCompletionRatio
```
public JobStatistics setCompletionRatio(Double completionRatio)
```
    Output only. [TrustedTester] 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
  - getDataMaskingStatistics
```
public DataMaskingStatistics getDataMaskingStatistics()
```
    Output only. Statistics for data-masking. Present only for query and extract jobs.
    
    Returns:
    
    value or null for none
  - setDataMaskingStatistics
```
public JobStatistics setDataMaskingStatistics(DataMaskingStatistics dataMaskingStatistics)
```
    Output only. Statistics for data-masking. Present only for query and extract jobs.
    
    Parameters:
    
    dataMaskingStatistics - dataMaskingStatistics or null for none
  - getEdition
```
public String getEdition()
```
    Output only. Name of edition corresponding to the reservation for this job at the time of this update.
    
    Returns:
    
    value or null for none
  - setEdition
```
public JobStatistics setEdition(String edition)
```
    Output only. Name of edition corresponding to the reservation for this job at the time of this update.
    
    Parameters:
    
    edition - edition 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
  - getFinalExecutionDurationMs
```
public Long getFinalExecutionDurationMs()
```
    Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job.
    
    Returns:
    
    value or null for none
  - setFinalExecutionDurationMs
```
public JobStatistics setFinalExecutionDurationMs(Long finalExecutionDurationMs)
```
    Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job.
    
    Parameters:
    
    finalExecutionDurationMs - finalExecutionDurationMs 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, specifies the job ID of the parent.
    
    Returns:
    
    value or null for none
  - setParentJobId
```
public JobStatistics setParentJobId(String parentJobId)
```
    Output only. If this is a child job, specifies the job 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. This field reported misleading information and will no longer be populated.
    
    Returns:
    
    value or null for none
  - setReservationUsage
```
public JobStatistics setReservationUsage(List<JobStatistics.ReservationUsage> reservationUsage)
```
    Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.
    
    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. 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. 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. If this a child job of a script, specifies information about the context of this job within the script.
    
    Returns:
    
    value or null for none
  - setScriptStatistics
```
public JobStatistics setScriptStatistics(ScriptStatistics scriptStatistics)
```
    Output only. If this a child job of a script, specifies information about the context of this job within the script.
    
    Parameters:
    
    scriptStatistics - scriptStatistics or null for none
  - getSessionInfo
```
public SessionInfo getSessionInfo()
```
    Output only. 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. 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. Total bytes processed for the job.
    
    Returns:
    
    value or null for none
  - setTotalBytesProcessed
```
public JobStatistics setTotalBytesProcessed(Long totalBytesProcessed)
```
    Output only. Total bytes processed for the job.
    
    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. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
    
    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. This property is only expected on a child job or a job that is in a session. A script parent job is not part of the transaction started in the script.
    
    Parameters:
    
    transactionInfo - transactionInfo or null for none
  - set
```
public JobStatistics set(String fieldName,
                         Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public JobStatistics clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class JobStatistics

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

JobStatistics

Method Detail

getCompletionRatio

setCompletionRatio

getCopy

setCopy

getCreationTime

setCreationTime

getDataMaskingStatistics

setDataMaskingStatistics

getEdition

setEdition

getEndTime

setEndTime

getExtract

setExtract

getFinalExecutionDurationMs

setFinalExecutionDurationMs

getLoad

setLoad

getNumChildJobs

setNumChildJobs

getParentJobId

setParentJobId

getQuery

setQuery

getQuotaDeferments

setQuotaDeferments

getReservationUsage

setReservationUsage

getReservationId

setReservationId

getRowLevelSecurityStatistics

setRowLevelSecurityStatistics

getScriptStatistics

setScriptStatistics

getSessionInfo

setSessionInfo

getStartTime

setStartTime

getTotalBytesProcessed

setTotalBytesProcessed

getTotalSlotMs

setTotalSlotMs

getTransactionInfo

setTransactionInfo

set

clone