forked from googleapis/google-cloud-ruby
-
Notifications
You must be signed in to change notification settings - Fork 2
/
list.rb
169 lines (158 loc) · 5.5 KB
/
list.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# Copyright 2015 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require "delegate"
module Google
module Cloud
module Bigquery
class Job
##
# Job::List is a special case Array with additional values.
class List < DelegateClass(::Array)
##
# If not empty, indicates that there are more records that match
# the request and this value should be passed to continue.
attr_accessor :token
# A hash of this page of results.
attr_accessor :etag
##
# @private Create a new Job::List with an array of jobs.
def initialize arr = []
super arr
end
##
# Whether there is a next page of jobs.
#
# @return [Boolean]
#
# @example
# require "google/cloud/bigquery"
#
# bigquery = Google::Cloud::Bigquery.new
#
# jobs = bigquery.jobs
# if jobs.next?
# next_jobs = jobs.next
# end
def next?
!token.nil?
end
##
# Retrieve the next page of jobs.
#
# @return [Job::List]
#
# @example
# require "google/cloud/bigquery"
#
# bigquery = Google::Cloud::Bigquery.new
#
# jobs = bigquery.jobs
# if jobs.next?
# next_jobs = jobs.next
# end
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
##
# 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.
#
# @param [Integer] request_limit The upper limit of API requests to
# make to load all jobs. Default is no limit.
# @yield [job] The block for accessing each job.
# @yieldparam [Job] job The job object.
#
# @return [Enumerator]
#
# @example 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
#
# @example 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
#
# @example 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
#
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
##
# @private New Job::List from a Google API Client
# Google::Apis::BigqueryV2::JobList object.
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
protected
##
# Raise an error unless an active service is available.
def ensure_service!
raise "Must have active connection" unless @service
end
end
end
end
end
end