Class BigQuery.JobListOption (2.42.1)

public static class BigQuery.JobListOption extends Option

Class for specifying job list options.

Inheritance

Object > com.google.cloud.bigquery.Option > BigQuery.JobListOption

Static Methods

allUsers()

public static BigQuery.JobListOption allUsers()

Returns an option to list all jobs, even the ones issued by other users.

Returns
Type Description
BigQuery.JobListOption

fields(BigQuery.JobField[] fields)

public static BigQuery.JobListOption fields(BigQuery.JobField[] fields)

Returns an option to specify the job's fields to be returned by the RPC call. If this option is not provided all job's fields are returned. JobOption.fields() can be used to specify only the fields of interest. Job#getJobId(), JobStatus#getState(), JobStatus#getError() as well as type-specific configuration (e.g. QueryJobConfiguration#getQuery() for Query Jobs) are always returned, even if not specified. JobField#SELF_LINK and JobField#ETAG can not be selected when listing jobs.

Parameter
Name Description
fields JobField[]
Returns
Type Description
BigQuery.JobListOption

maxCreationTime(long maxCreationTime)

public static BigQuery.JobListOption maxCreationTime(long maxCreationTime)

Returns an option to filter out jobs after the given maximum creation time.

Parameter
Name Description
maxCreationTime long
Returns
Type Description
BigQuery.JobListOption

minCreationTime(long minCreationTime)

public static BigQuery.JobListOption minCreationTime(long minCreationTime)

Returns an option to filter out jobs before the given minimum creation time.

Parameter
Name Description
minCreationTime long
Returns
Type Description
BigQuery.JobListOption

pageSize(long pageSize)

public static BigQuery.JobListOption pageSize(long pageSize)

Returns an option to specify the maximum number of jobs returned per page.

Parameter
Name Description
pageSize long
Returns
Type Description
BigQuery.JobListOption

pageToken(String pageToken)

public static BigQuery.JobListOption pageToken(String pageToken)

Returns an option to specify the page token from which to start listing jobs.

Parameter
Name Description
pageToken String
Returns
Type Description
BigQuery.JobListOption

parentJobId(String parentJobId)

public static BigQuery.JobListOption parentJobId(String parentJobId)

Returns an option to list only child job from specify parent job id.

Parameter
Name Description
parentJobId String
Returns
Type Description
BigQuery.JobListOption

stateFilter(JobStatus.State[] stateFilters)

public static BigQuery.JobListOption stateFilter(JobStatus.State[] stateFilters)

Returns an option to list only jobs that match the provided state filters.

Parameter
Name Description
stateFilters State[]
Returns
Type Description
BigQuery.JobListOption