BigQuery API - Class Google::Cloud::Bigquery::Job::List (v1.49.0)

Reference documentation and code samples for the BigQuery API class Google::Cloud::Bigquery::Job::List.

Job::List is a special case Array with additional values.

Inherits

Array

Methods

#all

def all(request_limit: nil, &block) { |job| ... } -> Enumerator

Retrieves remaining results by repeatedly invoking #next until #next? returns false. Calls the given block once for each result, which is passed as the argument to the block.

An Enumerator is returned if no block is given.

This method will make repeated API calls until all remaining results are retrieved. (Unlike #each, for example, which merely iterates over the results returned by a single API call.) Use with caution.

Parameter

request_limit (Integer) (defaults to: nil) — The upper limit of API requests to make to load all jobs. Default is no limit.

Yields

(job) — The block for accessing each job.

Yield Parameter

job (Job) — The job object.

Returns

(Enumerator)

Examples

Iterating each job by passing a block:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

bigquery.jobs.all do |job|
  puts job.state
end

Using the enumerator by not passing a block:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

all_states = bigquery.jobs.all.map do |job|
  job.state
end

Limit the number of API calls made:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

bigquery.jobs.all(request_limit: 10) do |job|
  puts job.state
end

#etag

def etag()

A hash of this page of results.

#etag=

def etag=(value)

A hash of this page of results.

#next

def next() -> Job::List

Retrieve the next page of jobs.

Returns

(Job::List)

Example

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

jobs = bigquery.jobs
if jobs.next?
  next_jobs = jobs.next
end

#next?

def next?() -> Boolean

Whether there is a next page of jobs.

Returns

(Boolean)

Example

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new

jobs = bigquery.jobs
if jobs.next?
  next_jobs = jobs.next
end

#token

def token()

If not empty, indicates that there are more records that match the request and this value should be passed to continue.

#token=

def token=(value)

If not empty, indicates that there are more records that match the request and this value should be passed to continue.