google-cloud-dataproc-v1 0.7.0 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -236,6 +236,21 @@ module Google
236
236
  #
237
237
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
238
238
  #
239
+ # @example Basic example
240
+ # require "google/cloud/dataproc/v1"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Cloud::Dataproc::V1::SubmitJobRequest.new
247
+ #
248
+ # # Call the submit_job method.
249
+ # result = client.submit_job request
250
+ #
251
+ # # The returned object is of type Google::Cloud::Dataproc::V1::Job.
252
+ # p result
253
+ #
239
254
  def submit_job request, options = nil
240
255
  raise ::ArgumentError, "request must be provided" if request.nil?
241
256
 
@@ -253,10 +268,14 @@ module Google
253
268
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
254
269
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
255
270
 
256
- header_params = {
257
- "project_id" => request.project_id,
258
- "region" => request.region
259
- }
271
+ header_params = {}
272
+ if request.project_id
273
+ header_params["project_id"] = request.project_id
274
+ end
275
+ if request.region
276
+ header_params["region"] = request.region
277
+ end
278
+
260
279
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
261
280
  metadata[:"x-goog-request-params"] ||= request_params_header
262
281
 
@@ -323,6 +342,28 @@ module Google
323
342
  #
324
343
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
325
344
  #
345
+ # @example Basic example
346
+ # require "google/cloud/dataproc/v1"
347
+ #
348
+ # # Create a client object. The client can be reused for multiple calls.
349
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
350
+ #
351
+ # # Create a request. To set request fields, pass in keyword arguments.
352
+ # request = Google::Cloud::Dataproc::V1::SubmitJobRequest.new
353
+ #
354
+ # # Call the submit_job_as_operation method.
355
+ # result = client.submit_job_as_operation request
356
+ #
357
+ # # The returned object is of type Gapic::Operation. You can use this
358
+ # # object to check the status of an operation, cancel it, or wait
359
+ # # for results. Here is how to block until completion:
360
+ # result.wait_until_done! timeout: 60
361
+ # if result.response?
362
+ # p result.response
363
+ # else
364
+ # puts "Error!"
365
+ # end
366
+ #
326
367
  def submit_job_as_operation request, options = nil
327
368
  raise ::ArgumentError, "request must be provided" if request.nil?
328
369
 
@@ -340,10 +381,14 @@ module Google
340
381
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
341
382
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
342
383
 
343
- header_params = {
344
- "project_id" => request.project_id,
345
- "region" => request.region
346
- }
384
+ header_params = {}
385
+ if request.project_id
386
+ header_params["project_id"] = request.project_id
387
+ end
388
+ if request.region
389
+ header_params["region"] = request.region
390
+ end
391
+
347
392
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
348
393
  metadata[:"x-goog-request-params"] ||= request_params_header
349
394
 
@@ -398,6 +443,21 @@ module Google
398
443
  #
399
444
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
400
445
  #
446
+ # @example Basic example
447
+ # require "google/cloud/dataproc/v1"
448
+ #
449
+ # # Create a client object. The client can be reused for multiple calls.
450
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
451
+ #
452
+ # # Create a request. To set request fields, pass in keyword arguments.
453
+ # request = Google::Cloud::Dataproc::V1::GetJobRequest.new
454
+ #
455
+ # # Call the get_job method.
456
+ # result = client.get_job request
457
+ #
458
+ # # The returned object is of type Google::Cloud::Dataproc::V1::Job.
459
+ # p result
460
+ #
401
461
  def get_job request, options = nil
402
462
  raise ::ArgumentError, "request must be provided" if request.nil?
403
463
 
@@ -415,11 +475,17 @@ module Google
415
475
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
416
476
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
417
477
 
418
- header_params = {
419
- "project_id" => request.project_id,
420
- "region" => request.region,
421
- "job_id" => request.job_id
422
- }
478
+ header_params = {}
479
+ if request.project_id
480
+ header_params["project_id"] = request.project_id
481
+ end
482
+ if request.region
483
+ header_params["region"] = request.region
484
+ end
485
+ if request.job_id
486
+ header_params["job_id"] = request.job_id
487
+ end
488
+
423
489
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
424
490
  metadata[:"x-goog-request-params"] ||= request_params_header
425
491
 
@@ -499,6 +565,27 @@ module Google
499
565
  #
500
566
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
501
567
  #
568
+ # @example Basic example
569
+ # require "google/cloud/dataproc/v1"
570
+ #
571
+ # # Create a client object. The client can be reused for multiple calls.
572
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
573
+ #
574
+ # # Create a request. To set request fields, pass in keyword arguments.
575
+ # request = Google::Cloud::Dataproc::V1::ListJobsRequest.new
576
+ #
577
+ # # Call the list_jobs method.
578
+ # result = client.list_jobs request
579
+ #
580
+ # # The returned object is of type Gapic::PagedEnumerable. You can
581
+ # # iterate over all elements by calling #each, and the enumerable
582
+ # # will lazily make API calls to fetch subsequent pages. Other
583
+ # # methods are also available for managing paging directly.
584
+ # result.each do |response|
585
+ # # Each element is of type ::Google::Cloud::Dataproc::V1::Job.
586
+ # p response
587
+ # end
588
+ #
502
589
  def list_jobs request, options = nil
503
590
  raise ::ArgumentError, "request must be provided" if request.nil?
504
591
 
@@ -516,10 +603,14 @@ module Google
516
603
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
517
604
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
518
605
 
519
- header_params = {
520
- "project_id" => request.project_id,
521
- "region" => request.region
522
- }
606
+ header_params = {}
607
+ if request.project_id
608
+ header_params["project_id"] = request.project_id
609
+ end
610
+ if request.region
611
+ header_params["region"] = request.region
612
+ end
613
+
523
614
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
524
615
  metadata[:"x-goog-request-params"] ||= request_params_header
525
616
 
@@ -583,6 +674,21 @@ module Google
583
674
  #
584
675
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
585
676
  #
677
+ # @example Basic example
678
+ # require "google/cloud/dataproc/v1"
679
+ #
680
+ # # Create a client object. The client can be reused for multiple calls.
681
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
682
+ #
683
+ # # Create a request. To set request fields, pass in keyword arguments.
684
+ # request = Google::Cloud::Dataproc::V1::UpdateJobRequest.new
685
+ #
686
+ # # Call the update_job method.
687
+ # result = client.update_job request
688
+ #
689
+ # # The returned object is of type Google::Cloud::Dataproc::V1::Job.
690
+ # p result
691
+ #
586
692
  def update_job request, options = nil
587
693
  raise ::ArgumentError, "request must be provided" if request.nil?
588
694
 
@@ -600,11 +706,17 @@ module Google
600
706
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
601
707
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
602
708
 
603
- header_params = {
604
- "project_id" => request.project_id,
605
- "region" => request.region,
606
- "job_id" => request.job_id
607
- }
709
+ header_params = {}
710
+ if request.project_id
711
+ header_params["project_id"] = request.project_id
712
+ end
713
+ if request.region
714
+ header_params["region"] = request.region
715
+ end
716
+ if request.job_id
717
+ header_params["job_id"] = request.job_id
718
+ end
719
+
608
720
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
609
721
  metadata[:"x-goog-request-params"] ||= request_params_header
610
722
 
@@ -662,6 +774,21 @@ module Google
662
774
  #
663
775
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
664
776
  #
777
+ # @example Basic example
778
+ # require "google/cloud/dataproc/v1"
779
+ #
780
+ # # Create a client object. The client can be reused for multiple calls.
781
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
782
+ #
783
+ # # Create a request. To set request fields, pass in keyword arguments.
784
+ # request = Google::Cloud::Dataproc::V1::CancelJobRequest.new
785
+ #
786
+ # # Call the cancel_job method.
787
+ # result = client.cancel_job request
788
+ #
789
+ # # The returned object is of type Google::Cloud::Dataproc::V1::Job.
790
+ # p result
791
+ #
665
792
  def cancel_job request, options = nil
666
793
  raise ::ArgumentError, "request must be provided" if request.nil?
667
794
 
@@ -679,11 +806,17 @@ module Google
679
806
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
680
807
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
681
808
 
682
- header_params = {
683
- "project_id" => request.project_id,
684
- "region" => request.region,
685
- "job_id" => request.job_id
686
- }
809
+ header_params = {}
810
+ if request.project_id
811
+ header_params["project_id"] = request.project_id
812
+ end
813
+ if request.region
814
+ header_params["region"] = request.region
815
+ end
816
+ if request.job_id
817
+ header_params["job_id"] = request.job_id
818
+ end
819
+
687
820
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
688
821
  metadata[:"x-goog-request-params"] ||= request_params_header
689
822
 
@@ -738,6 +871,21 @@ module Google
738
871
  #
739
872
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
740
873
  #
874
+ # @example Basic example
875
+ # require "google/cloud/dataproc/v1"
876
+ #
877
+ # # Create a client object. The client can be reused for multiple calls.
878
+ # client = Google::Cloud::Dataproc::V1::JobController::Client.new
879
+ #
880
+ # # Create a request. To set request fields, pass in keyword arguments.
881
+ # request = Google::Cloud::Dataproc::V1::DeleteJobRequest.new
882
+ #
883
+ # # Call the delete_job method.
884
+ # result = client.delete_job request
885
+ #
886
+ # # The returned object is of type Google::Protobuf::Empty.
887
+ # p result
888
+ #
741
889
  def delete_job request, options = nil
742
890
  raise ::ArgumentError, "request must be provided" if request.nil?
743
891
 
@@ -755,11 +903,17 @@ module Google
755
903
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
756
904
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
757
905
 
758
- header_params = {
759
- "project_id" => request.project_id,
760
- "region" => request.region,
761
- "job_id" => request.job_id
762
- }
906
+ header_params = {}
907
+ if request.project_id
908
+ header_params["project_id"] = request.project_id
909
+ end
910
+ if request.region
911
+ header_params["region"] = request.region
912
+ end
913
+ if request.job_id
914
+ header_params["job_id"] = request.job_id
915
+ end
916
+
763
917
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
764
918
  metadata[:"x-goog-request-params"] ||= request_params_header
765
919
 
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,9 +181,11 @@ module Google
160
181
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
@@ -215,6 +238,28 @@ module Google
215
238
  #
216
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
217
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
218
263
  def get_operation request, options = nil
219
264
  raise ::ArgumentError, "request must be provided" if request.nil?
220
265
 
@@ -232,9 +277,11 @@ module Google
232
277
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
233
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
234
279
 
235
- header_params = {
236
- "name" => request.name
237
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
238
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
239
286
  metadata[:"x-goog-request-params"] ||= request_params_header
240
287
 
@@ -287,6 +334,21 @@ module Google
287
334
  #
288
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
289
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
290
352
  def delete_operation request, options = nil
291
353
  raise ::ArgumentError, "request must be provided" if request.nil?
292
354
 
@@ -304,9 +366,11 @@ module Google
304
366
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
305
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
306
368
 
307
- header_params = {
308
- "name" => request.name
309
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
310
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
311
375
  metadata[:"x-goog-request-params"] ||= request_params_header
312
376
 
@@ -364,6 +428,21 @@ module Google
364
428
  #
365
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
366
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
367
446
  def cancel_operation request, options = nil
368
447
  raise ::ArgumentError, "request must be provided" if request.nil?
369
448
 
@@ -381,9 +460,11 @@ module Google
381
460
  gapic_version: ::Google::Cloud::Dataproc::V1::VERSION
382
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
383
462
 
384
- header_params = {
385
- "name" => request.name
386
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
387
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
388
469
  metadata[:"x-goog-request-params"] ||= request_params_header
389
470
 
@@ -444,6 +525,28 @@ module Google
444
525
  #
445
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
446
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
447
550
  def wait_operation request, options = nil
448
551
  raise ::ArgumentError, "request must be provided" if request.nil?
449
552
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Dataproc
23
23
  module V1
24
- VERSION = "0.7.0"
24
+ VERSION = "0.7.1"
25
25
  end
26
26
  end
27
27
  end