Class: Gcloud::Bigquery::Job::List

Inherits:
Array
  • Object
show all
Defined in:
lib/gcloud/bigquery/job/list.rb

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arr = []) ⇒ List

Returns a new instance of List.



34
35
36
 
# File 'lib/gcloud/bigquery/job/list.rb', line 34

def initialize arr = []
  super arr
end

Instance Attribute Details

#etag ⇒ Object

A hash of this page of results.



30
31
32
 
# File 'lib/gcloud/bigquery/job/list.rb', line 30

def etag
  @etag
end

#token ⇒ Object

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



27
28
29
 
# File 'lib/gcloud/bigquery/job/list.rb', line 27

def token
  @token
end

Class Method Details

.from_gapi(gapi_list, service, hidden = nil, max = nil, filter = nil) ⇒ Object

Google::Apis::BigqueryV2::JobList object.



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/gcloud/bigquery/job/list.rb', line 148

def self.from_gapi gapi_list, service, hidden = nil, max = nil,
                   filter = nil
  jobs = List.new(Array(gapi_list.jobs).map do |gapi_object|
    Job.from_gapi gapi_object, service
  end)
  jobs.instance_variable_set :@token,   gapi_list.next_page_token
  jobs.instance_variable_set :@etag,    gapi_list.etag
  jobs.instance_variable_set :@service, service
  jobs.instance_variable_set :@hidden,  hidden
  jobs.instance_variable_set :@max,     max
  jobs.instance_variable_set :@filter,  filter
  jobs
end

Instance Method Details

#all(request_limit: nil) {|job| ... } ⇒ Enumerator

Retrieves all jobs by repeatedly loading #next until #next? returns ‘false`. Calls the given block once for each job, which is passed as the parameter.

An Enumerator is returned if no block is given.

This method may make several API calls until all jobs are retrieved. Be sure to use as narrow a search criteria as possible. Please use with caution.

Examples:

Iterating each job by passing a block:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery

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

Using the enumerator by not passing a block:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery

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

Limit the number of API calls made:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery

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

Parameters:

  • 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 Parameters:

  • job (Job) —

    The job object.

Returns:

  • (Enumerator) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/gcloud/bigquery/job/list.rb', line 128

def all request_limit: nil
  request_limit = request_limit.to_i if request_limit
  unless block_given?
    return enum_for(:all, request_limit: request_limit)
  end
  results = self
  loop do
    results.each { |r| yield r }
    if request_limit
      request_limit -= 1
      break if request_limit < 0
    end
    break unless results.next?
    results = results.next
  end
end

#next ⇒ Job::List

Retrieve the next page of jobs.

Examples:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery

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

Returns:



72
73
74
75
76
77
78
 
# File 'lib/gcloud/bigquery/job/list.rb', line 72

def next
  return nil unless next?
  ensure_service!
  options = { all: @hidden, token: token, max: @max, filter: @filter }
  gapi = @service.list_jobs options
  self.class.from_gapi gapi, @service, @hidden, @max, @filter
end

#next? ⇒ Boolean

Whether there is a next page of jobs.

Examples:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery

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

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/gcloud/bigquery/job/list.rb', line 53

def next?
  !token.nil?
end