Debian Codegraph @

talent/apiv4beta1/auxiliary.go

raw
1 // Copyright 2025 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // https://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 // Code generated by protoc-gen-go_gapic. DO NOT EDIT.
16
17 package talent
18
19 import (
20 "context"
21 "time"
22
23 "cloud.google.com/go/longrunning"
24 talentpb "cloud.google.com/go/talent/apiv4beta1/talentpb"
25 gax "github.com/googleapis/gax-go/v2"
26 "google.golang.org/api/iterator"
27 )
28
29 // BatchCreateJobsOperation manages a long-running operation from BatchCreateJobs.
30 type BatchCreateJobsOperation struct {
31 lro *longrunning.Operation
32 pollPath string
33 }
34
35 // Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
36 //
37 // See documentation of Poll for error-handling information.
38 func (op *BatchCreateJobsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*talentpb.JobOperationResult, error) {
39 opts = append([]gax.CallOption{gax.WithPath(op.pollPath)}, opts...)
40 var resp talentpb.JobOperationResult
41 if err := op.lro.WaitWithInterval(ctx, &resp, time.Minute, opts...); err != nil {
42 return nil, err
43 }
44 return &resp, nil
45 }
46
47 // Poll fetches the latest state of the long-running operation.
48 //
49 // Poll also fetches the latest metadata, which can be retrieved by Metadata.
50 //
51 // If Poll fails, the error is returned and op is unmodified. If Poll succeeds and
52 // the operation has completed with failure, the error is returned and op.Done will return true.
53 // If Poll succeeds and the operation has completed successfully,
54 // op.Done will return true, and the response of the operation is returned.
55 // If Poll succeeds and the operation has not completed, the returned response and error are both nil.
56 func (op *BatchCreateJobsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*talentpb.JobOperationResult, error) {
57 opts = append([]gax.CallOption{gax.WithPath(op.pollPath)}, opts...)
58 var resp talentpb.JobOperationResult
59 if err := op.lro.Poll(ctx, &resp, opts...); err != nil {
60 return nil, err
61 }
62 if !op.Done() {
63 return nil, nil
64 }
65 return &resp, nil
66 }
67
68 // Metadata returns metadata associated with the long-running operation.
69 // Metadata itself does not contact the server, but Poll does.
70 // To get the latest metadata, call this method after a successful call to Poll.
71 // If the metadata is not available, the returned metadata and error are both nil.
72 func (op *BatchCreateJobsOperation) Metadata() (*talentpb.BatchOperationMetadata, error) {
73 var meta talentpb.BatchOperationMetadata
74 if err := op.lro.Metadata(&meta); err == longrunning.ErrNoMetadata {
75 return nil, nil
76 } else if err != nil {
77 return nil, err
78 }
79 return &meta, nil
80 }
81
82 // Done reports whether the long-running operation has completed.
83 func (op *BatchCreateJobsOperation) Done() bool {
84 return op.lro.Done()
85 }
86
87 // Name returns the name of the long-running operation.
88 // The name is assigned by the server and is unique within the service from which the operation is created.
89 func (op *BatchCreateJobsOperation) Name() string {
90 return op.lro.Name()
91 }
92
93 // BatchUpdateJobsOperation manages a long-running operation from BatchUpdateJobs.
94 type BatchUpdateJobsOperation struct {
95 lro *longrunning.Operation
96 pollPath string
97 }
98
99 // Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
100 //
101 // See documentation of Poll for error-handling information.
102 func (op *BatchUpdateJobsOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*talentpb.JobOperationResult, error) {
103 opts = append([]gax.CallOption{gax.WithPath(op.pollPath)}, opts...)
104 var resp talentpb.JobOperationResult
105 if err := op.lro.WaitWithInterval(ctx, &resp, time.Minute, opts...); err != nil {
106 return nil, err
107 }
108 return &resp, nil
109 }
110
111 // Poll fetches the latest state of the long-running operation.
112 //
113 // Poll also fetches the latest metadata, which can be retrieved by Metadata.
114 //
115 // If Poll fails, the error is returned and op is unmodified. If Poll succeeds and
116 // the operation has completed with failure, the error is returned and op.Done will return true.
117 // If Poll succeeds and the operation has completed successfully,
118 // op.Done will return true, and the response of the operation is returned.
119 // If Poll succeeds and the operation has not completed, the returned response and error are both nil.
120 func (op *BatchUpdateJobsOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*talentpb.JobOperationResult, error) {
121 opts = append([]gax.CallOption{gax.WithPath(op.pollPath)}, opts...)
122 var resp talentpb.JobOperationResult
123 if err := op.lro.Poll(ctx, &resp, opts...); err != nil {
124 return nil, err
125 }
126 if !op.Done() {
127 return nil, nil
128 }
129 return &resp, nil
130 }
131
132 // Metadata returns metadata associated with the long-running operation.
133 // Metadata itself does not contact the server, but Poll does.
134 // To get the latest metadata, call this method after a successful call to Poll.
135 // If the metadata is not available, the returned metadata and error are both nil.
136 func (op *BatchUpdateJobsOperation) Metadata() (*talentpb.BatchOperationMetadata, error) {
137 var meta talentpb.BatchOperationMetadata
138 if err := op.lro.Metadata(&meta); err == longrunning.ErrNoMetadata {
139 return nil, nil
140 } else if err != nil {
141 return nil, err
142 }
143 return &meta, nil
144 }
145
146 // Done reports whether the long-running operation has completed.
147 func (op *BatchUpdateJobsOperation) Done() bool {
148 return op.lro.Done()
149 }
150
151 // Name returns the name of the long-running operation.
152 // The name is assigned by the server and is unique within the service from which the operation is created.
153 func (op *BatchUpdateJobsOperation) Name() string {
154 return op.lro.Name()
155 }
156
157 // CompanyIterator manages a stream of *talentpb.Company.
158 type CompanyIterator struct {
159 items []*talentpb.Company
160 pageInfo *iterator.PageInfo
161 nextFunc func() error
162
163 // Response is the raw response for the current page.
164 // It must be cast to the RPC response type.
165 // Calling Next() or InternalFetch() updates this value.
166 Response interface{}
167
168 // InternalFetch is for use by the Google Cloud Libraries only.
169 // It is not part of the stable interface of this package.
170 //
171 // InternalFetch returns results from a single call to the underlying RPC.
172 // The number of results is no greater than pageSize.
173 // If there are no more results, nextPageToken is empty and err is nil.
174 InternalFetch func(pageSize int, pageToken string) (results []*talentpb.Company, nextPageToken string, err error)
175 }
176
177 // PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
178 func (it *CompanyIterator) PageInfo() *iterator.PageInfo {
179 return it.pageInfo
180 }
181
182 // Next returns the next result. Its second return value is iterator.Done if there are no more
183 // results. Once Next returns Done, all subsequent calls will return Done.
184 func (it *CompanyIterator) Next() (*talentpb.Company, error) {
185 var item *talentpb.Company
186 if err := it.nextFunc(); err != nil {
187 return item, err
188 }
189 item = it.items[0]
190 it.items = it.items[1:]
191 return item, nil
192 }
193
194 func (it *CompanyIterator) bufLen() int {
195 return len(it.items)
196 }
197
198 func (it *CompanyIterator) takeBuf() interface{} {
199 b := it.items
200 it.items = nil
201 return b
202 }
203
204 // JobIterator manages a stream of *talentpb.Job.
205 type JobIterator struct {
206 items []*talentpb.Job
207 pageInfo *iterator.PageInfo
208 nextFunc func() error
209
210 // Response is the raw response for the current page.
211 // It must be cast to the RPC response type.
212 // Calling Next() or InternalFetch() updates this value.
213 Response interface{}
214
215 // InternalFetch is for use by the Google Cloud Libraries only.
216 // It is not part of the stable interface of this package.
217 //
218 // InternalFetch returns results from a single call to the underlying RPC.
219 // The number of results is no greater than pageSize.
220 // If there are no more results, nextPageToken is empty and err is nil.
221 InternalFetch func(pageSize int, pageToken string) (results []*talentpb.Job, nextPageToken string, err error)
222 }
223
224 // PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
225 func (it *JobIterator) PageInfo() *iterator.PageInfo {
226 return it.pageInfo
227 }
228
229 // Next returns the next result. Its second return value is iterator.Done if there are no more
230 // results. Once Next returns Done, all subsequent calls will return Done.
231 func (it *JobIterator) Next() (*talentpb.Job, error) {
232 var item *talentpb.Job
233 if err := it.nextFunc(); err != nil {
234 return item, err
235 }
236 item = it.items[0]
237 it.items = it.items[1:]
238 return item, nil
239 }
240
241 func (it *JobIterator) bufLen() int {
242 return len(it.items)
243 }
244
245 func (it *JobIterator) takeBuf() interface{} {
246 b := it.items
247 it.items = nil
248 return b
249 }
250
251 // SearchJobsResponse_MatchingJobIterator manages a stream of *talentpb.SearchJobsResponse_MatchingJob.
252 type SearchJobsResponse_MatchingJobIterator struct {
253 items []*talentpb.SearchJobsResponse_MatchingJob
254 pageInfo *iterator.PageInfo
255 nextFunc func() error
256
257 // Response is the raw response for the current page.
258 // It must be cast to the RPC response type.
259 // Calling Next() or InternalFetch() updates this value.
260 Response interface{}
261
262 // InternalFetch is for use by the Google Cloud Libraries only.
263 // It is not part of the stable interface of this package.
264 //
265 // InternalFetch returns results from a single call to the underlying RPC.
266 // The number of results is no greater than pageSize.
267 // If there are no more results, nextPageToken is empty and err is nil.
268 InternalFetch func(pageSize int, pageToken string) (results []*talentpb.SearchJobsResponse_MatchingJob, nextPageToken string, err error)
269 }
270
271 // PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
272 func (it *SearchJobsResponse_MatchingJobIterator) PageInfo() *iterator.PageInfo {
273 return it.pageInfo
274 }
275
276 // Next returns the next result. Its second return value is iterator.Done if there are no more
277 // results. Once Next returns Done, all subsequent calls will return Done.
278 func (it *SearchJobsResponse_MatchingJobIterator) Next() (*talentpb.SearchJobsResponse_MatchingJob, error) {
279 var item *talentpb.SearchJobsResponse_MatchingJob
280 if err := it.nextFunc(); err != nil {
281 return item, err
282 }
283 item = it.items[0]
284 it.items = it.items[1:]
285 return item, nil
286 }
287
288 func (it *SearchJobsResponse_MatchingJobIterator) bufLen() int {
289 return len(it.items)
290 }
291
292 func (it *SearchJobsResponse_MatchingJobIterator) takeBuf() interface{} {
293 b := it.items
294 it.items = nil
295 return b
296 }
297
298 // TenantIterator manages a stream of *talentpb.Tenant.
299 type TenantIterator struct {
300 items []*talentpb.Tenant
301 pageInfo *iterator.PageInfo
302 nextFunc func() error
303
304 // Response is the raw response for the current page.
305 // It must be cast to the RPC response type.
306 // Calling Next() or InternalFetch() updates this value.
307 Response interface{}
308
309 // InternalFetch is for use by the Google Cloud Libraries only.
310 // It is not part of the stable interface of this package.
311 //
312 // InternalFetch returns results from a single call to the underlying RPC.
313 // The number of results is no greater than pageSize.
314 // If there are no more results, nextPageToken is empty and err is nil.
315 InternalFetch func(pageSize int, pageToken string) (results []*talentpb.Tenant, nextPageToken string, err error)
316 }
317
318 // PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
319 func (it *TenantIterator) PageInfo() *iterator.PageInfo {
320 return it.pageInfo
321 }
322
323 // Next returns the next result. Its second return value is iterator.Done if there are no more
324 // results. Once Next returns Done, all subsequent calls will return Done.
325 func (it *TenantIterator) Next() (*talentpb.Tenant, error) {
326 var item *talentpb.Tenant
327 if err := it.nextFunc(); err != nil {
328 return item, err
329 }
330 item = it.items[0]
331 it.items = it.items[1:]
332 return item, nil
333 }
334
335 func (it *TenantIterator) bufLen() int {
336 return len(it.items)
337 }
338
339 func (it *TenantIterator) takeBuf() interface{} {
340 b := it.items
341 it.items = nil
342 return b
343 }