google-cloud-notebooks-v1 0.6.0 → 0.7.0

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.
@@ -190,7 +190,7 @@ module Google
190
190
  credentials = @config.credentials
191
191
  # Use self-signed JWT if the endpoint is unchanged from default,
192
192
  # but only if the default endpoint does not have a region prefix.
193
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
193
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
194
194
  !@config.endpoint.split(".").first.include?("-")
195
195
  credentials ||= Credentials.default scope: @config.scope,
196
196
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -280,6 +280,26 @@ module Google
280
280
  # @return [::Google::Cloud::Notebooks::V1::ListInstancesResponse]
281
281
  #
282
282
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
283
+ #
284
+ # @example Basic example
285
+ # require "google/cloud/notebooks/v1"
286
+ #
287
+ # # Create a client object. The client can be reused for multiple calls.
288
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
289
+ #
290
+ # # Create a request. To set request fields, pass in keyword arguments.
291
+ # request = Google::Cloud::Notebooks::V1::ListInstancesRequest.new
292
+ #
293
+ # # Call the list_instances method.
294
+ # result = client.list_instances request
295
+ #
296
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
297
+ # # over elements, and API calls will be issued to fetch pages as needed.
298
+ # result.each do |item|
299
+ # # Each element is of type ::Google::Cloud::Notebooks::V1::Instance.
300
+ # p item
301
+ # end
302
+ #
283
303
  def list_instances request, options = nil
284
304
  raise ::ArgumentError, "request must be provided" if request.nil?
285
305
 
@@ -343,6 +363,22 @@ module Google
343
363
  # @return [::Google::Cloud::Notebooks::V1::Instance]
344
364
  #
345
365
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
366
+ #
367
+ # @example Basic example
368
+ # require "google/cloud/notebooks/v1"
369
+ #
370
+ # # Create a client object. The client can be reused for multiple calls.
371
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
372
+ #
373
+ # # Create a request. To set request fields, pass in keyword arguments.
374
+ # request = Google::Cloud::Notebooks::V1::GetInstanceRequest.new
375
+ #
376
+ # # Call the get_instance method.
377
+ # result = client.get_instance request
378
+ #
379
+ # # The returned object is of type Google::Cloud::Notebooks::V1::Instance.
380
+ # p result
381
+ #
346
382
  def get_instance request, options = nil
347
383
  raise ::ArgumentError, "request must be provided" if request.nil?
348
384
 
@@ -410,6 +446,29 @@ module Google
410
446
  # @return [::Gapic::Operation]
411
447
  #
412
448
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
449
+ #
450
+ # @example Basic example
451
+ # require "google/cloud/notebooks/v1"
452
+ #
453
+ # # Create a client object. The client can be reused for multiple calls.
454
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
455
+ #
456
+ # # Create a request. To set request fields, pass in keyword arguments.
457
+ # request = Google::Cloud::Notebooks::V1::CreateInstanceRequest.new
458
+ #
459
+ # # Call the create_instance method.
460
+ # result = client.create_instance request
461
+ #
462
+ # # The returned object is of type Gapic::Operation. You can use it to
463
+ # # check the status of an operation, cancel it, or wait for results.
464
+ # # Here is how to wait for a response.
465
+ # result.wait_until_done! timeout: 60
466
+ # if result.response?
467
+ # p result.response
468
+ # else
469
+ # puts "No response received."
470
+ # end
471
+ #
413
472
  def create_instance request, options = nil
414
473
  raise ::ArgumentError, "request must be provided" if request.nil?
415
474
 
@@ -482,6 +541,29 @@ module Google
482
541
  # @return [::Gapic::Operation]
483
542
  #
484
543
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
544
+ #
545
+ # @example Basic example
546
+ # require "google/cloud/notebooks/v1"
547
+ #
548
+ # # Create a client object. The client can be reused for multiple calls.
549
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
550
+ #
551
+ # # Create a request. To set request fields, pass in keyword arguments.
552
+ # request = Google::Cloud::Notebooks::V1::RegisterInstanceRequest.new
553
+ #
554
+ # # Call the register_instance method.
555
+ # result = client.register_instance request
556
+ #
557
+ # # The returned object is of type Gapic::Operation. You can use it to
558
+ # # check the status of an operation, cancel it, or wait for results.
559
+ # # Here is how to wait for a response.
560
+ # result.wait_until_done! timeout: 60
561
+ # if result.response?
562
+ # p result.response
563
+ # else
564
+ # puts "No response received."
565
+ # end
566
+ #
485
567
  def register_instance request, options = nil
486
568
  raise ::ArgumentError, "request must be provided" if request.nil?
487
569
 
@@ -553,6 +635,29 @@ module Google
553
635
  # @return [::Gapic::Operation]
554
636
  #
555
637
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
638
+ #
639
+ # @example Basic example
640
+ # require "google/cloud/notebooks/v1"
641
+ #
642
+ # # Create a client object. The client can be reused for multiple calls.
643
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
644
+ #
645
+ # # Create a request. To set request fields, pass in keyword arguments.
646
+ # request = Google::Cloud::Notebooks::V1::SetInstanceAcceleratorRequest.new
647
+ #
648
+ # # Call the set_instance_accelerator method.
649
+ # result = client.set_instance_accelerator request
650
+ #
651
+ # # The returned object is of type Gapic::Operation. You can use it to
652
+ # # check the status of an operation, cancel it, or wait for results.
653
+ # # Here is how to wait for a response.
654
+ # result.wait_until_done! timeout: 60
655
+ # if result.response?
656
+ # p result.response
657
+ # else
658
+ # puts "No response received."
659
+ # end
660
+ #
556
661
  def set_instance_accelerator request, options = nil
557
662
  raise ::ArgumentError, "request must be provided" if request.nil?
558
663
 
@@ -620,6 +725,29 @@ module Google
620
725
  # @return [::Gapic::Operation]
621
726
  #
622
727
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
728
+ #
729
+ # @example Basic example
730
+ # require "google/cloud/notebooks/v1"
731
+ #
732
+ # # Create a client object. The client can be reused for multiple calls.
733
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
734
+ #
735
+ # # Create a request. To set request fields, pass in keyword arguments.
736
+ # request = Google::Cloud::Notebooks::V1::SetInstanceMachineTypeRequest.new
737
+ #
738
+ # # Call the set_instance_machine_type method.
739
+ # result = client.set_instance_machine_type request
740
+ #
741
+ # # The returned object is of type Gapic::Operation. You can use it to
742
+ # # check the status of an operation, cancel it, or wait for results.
743
+ # # Here is how to wait for a response.
744
+ # result.wait_until_done! timeout: 60
745
+ # if result.response?
746
+ # p result.response
747
+ # else
748
+ # puts "No response received."
749
+ # end
750
+ #
623
751
  def set_instance_machine_type request, options = nil
624
752
  raise ::ArgumentError, "request must be provided" if request.nil?
625
753
 
@@ -686,6 +814,29 @@ module Google
686
814
  # @return [::Gapic::Operation]
687
815
  #
688
816
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
817
+ #
818
+ # @example Basic example
819
+ # require "google/cloud/notebooks/v1"
820
+ #
821
+ # # Create a client object. The client can be reused for multiple calls.
822
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
823
+ #
824
+ # # Create a request. To set request fields, pass in keyword arguments.
825
+ # request = Google::Cloud::Notebooks::V1::UpdateInstanceConfigRequest.new
826
+ #
827
+ # # Call the update_instance_config method.
828
+ # result = client.update_instance_config request
829
+ #
830
+ # # The returned object is of type Gapic::Operation. You can use it to
831
+ # # check the status of an operation, cancel it, or wait for results.
832
+ # # Here is how to wait for a response.
833
+ # result.wait_until_done! timeout: 60
834
+ # if result.response?
835
+ # p result.response
836
+ # else
837
+ # puts "No response received."
838
+ # end
839
+ #
689
840
  def update_instance_config request, options = nil
690
841
  raise ::ArgumentError, "request must be provided" if request.nil?
691
842
 
@@ -752,6 +903,29 @@ module Google
752
903
  # @return [::Gapic::Operation]
753
904
  #
754
905
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
906
+ #
907
+ # @example Basic example
908
+ # require "google/cloud/notebooks/v1"
909
+ #
910
+ # # Create a client object. The client can be reused for multiple calls.
911
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
912
+ #
913
+ # # Create a request. To set request fields, pass in keyword arguments.
914
+ # request = Google::Cloud::Notebooks::V1::UpdateShieldedInstanceConfigRequest.new
915
+ #
916
+ # # Call the update_shielded_instance_config method.
917
+ # result = client.update_shielded_instance_config request
918
+ #
919
+ # # The returned object is of type Gapic::Operation. You can use it to
920
+ # # check the status of an operation, cancel it, or wait for results.
921
+ # # Here is how to wait for a response.
922
+ # result.wait_until_done! timeout: 60
923
+ # if result.response?
924
+ # p result.response
925
+ # else
926
+ # puts "No response received."
927
+ # end
928
+ #
755
929
  def update_shielded_instance_config request, options = nil
756
930
  raise ::ArgumentError, "request must be provided" if request.nil?
757
931
 
@@ -819,6 +993,29 @@ module Google
819
993
  # @return [::Gapic::Operation]
820
994
  #
821
995
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
996
+ #
997
+ # @example Basic example
998
+ # require "google/cloud/notebooks/v1"
999
+ #
1000
+ # # Create a client object. The client can be reused for multiple calls.
1001
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1002
+ #
1003
+ # # Create a request. To set request fields, pass in keyword arguments.
1004
+ # request = Google::Cloud::Notebooks::V1::SetInstanceLabelsRequest.new
1005
+ #
1006
+ # # Call the set_instance_labels method.
1007
+ # result = client.set_instance_labels request
1008
+ #
1009
+ # # The returned object is of type Gapic::Operation. You can use it to
1010
+ # # check the status of an operation, cancel it, or wait for results.
1011
+ # # Here is how to wait for a response.
1012
+ # result.wait_until_done! timeout: 60
1013
+ # if result.response?
1014
+ # p result.response
1015
+ # else
1016
+ # puts "No response received."
1017
+ # end
1018
+ #
822
1019
  def set_instance_labels request, options = nil
823
1020
  raise ::ArgumentError, "request must be provided" if request.nil?
824
1021
 
@@ -885,6 +1082,22 @@ module Google
885
1082
  # @return [::Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse]
886
1083
  #
887
1084
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1085
+ #
1086
+ # @example Basic example
1087
+ # require "google/cloud/notebooks/v1"
1088
+ #
1089
+ # # Create a client object. The client can be reused for multiple calls.
1090
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1091
+ #
1092
+ # # Create a request. To set request fields, pass in keyword arguments.
1093
+ # request = Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsRequest.new
1094
+ #
1095
+ # # Call the update_instance_metadata_items method.
1096
+ # result = client.update_instance_metadata_items request
1097
+ #
1098
+ # # The returned object is of type Google::Cloud::Notebooks::V1::UpdateInstanceMetadataItemsResponse.
1099
+ # p result
1100
+ #
888
1101
  def update_instance_metadata_items request, options = nil
889
1102
  raise ::ArgumentError, "request must be provided" if request.nil?
890
1103
 
@@ -948,6 +1161,29 @@ module Google
948
1161
  # @return [::Gapic::Operation]
949
1162
  #
950
1163
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1164
+ #
1165
+ # @example Basic example
1166
+ # require "google/cloud/notebooks/v1"
1167
+ #
1168
+ # # Create a client object. The client can be reused for multiple calls.
1169
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1170
+ #
1171
+ # # Create a request. To set request fields, pass in keyword arguments.
1172
+ # request = Google::Cloud::Notebooks::V1::DeleteInstanceRequest.new
1173
+ #
1174
+ # # Call the delete_instance method.
1175
+ # result = client.delete_instance request
1176
+ #
1177
+ # # The returned object is of type Gapic::Operation. You can use it to
1178
+ # # check the status of an operation, cancel it, or wait for results.
1179
+ # # Here is how to wait for a response.
1180
+ # result.wait_until_done! timeout: 60
1181
+ # if result.response?
1182
+ # p result.response
1183
+ # else
1184
+ # puts "No response received."
1185
+ # end
1186
+ #
951
1187
  def delete_instance request, options = nil
952
1188
  raise ::ArgumentError, "request must be provided" if request.nil?
953
1189
 
@@ -1012,6 +1248,29 @@ module Google
1012
1248
  # @return [::Gapic::Operation]
1013
1249
  #
1014
1250
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1251
+ #
1252
+ # @example Basic example
1253
+ # require "google/cloud/notebooks/v1"
1254
+ #
1255
+ # # Create a client object. The client can be reused for multiple calls.
1256
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1257
+ #
1258
+ # # Create a request. To set request fields, pass in keyword arguments.
1259
+ # request = Google::Cloud::Notebooks::V1::StartInstanceRequest.new
1260
+ #
1261
+ # # Call the start_instance method.
1262
+ # result = client.start_instance request
1263
+ #
1264
+ # # The returned object is of type Gapic::Operation. You can use it to
1265
+ # # check the status of an operation, cancel it, or wait for results.
1266
+ # # Here is how to wait for a response.
1267
+ # result.wait_until_done! timeout: 60
1268
+ # if result.response?
1269
+ # p result.response
1270
+ # else
1271
+ # puts "No response received."
1272
+ # end
1273
+ #
1015
1274
  def start_instance request, options = nil
1016
1275
  raise ::ArgumentError, "request must be provided" if request.nil?
1017
1276
 
@@ -1076,6 +1335,29 @@ module Google
1076
1335
  # @return [::Gapic::Operation]
1077
1336
  #
1078
1337
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1338
+ #
1339
+ # @example Basic example
1340
+ # require "google/cloud/notebooks/v1"
1341
+ #
1342
+ # # Create a client object. The client can be reused for multiple calls.
1343
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1344
+ #
1345
+ # # Create a request. To set request fields, pass in keyword arguments.
1346
+ # request = Google::Cloud::Notebooks::V1::StopInstanceRequest.new
1347
+ #
1348
+ # # Call the stop_instance method.
1349
+ # result = client.stop_instance request
1350
+ #
1351
+ # # The returned object is of type Gapic::Operation. You can use it to
1352
+ # # check the status of an operation, cancel it, or wait for results.
1353
+ # # Here is how to wait for a response.
1354
+ # result.wait_until_done! timeout: 60
1355
+ # if result.response?
1356
+ # p result.response
1357
+ # else
1358
+ # puts "No response received."
1359
+ # end
1360
+ #
1079
1361
  def stop_instance request, options = nil
1080
1362
  raise ::ArgumentError, "request must be provided" if request.nil?
1081
1363
 
@@ -1140,6 +1422,29 @@ module Google
1140
1422
  # @return [::Gapic::Operation]
1141
1423
  #
1142
1424
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1425
+ #
1426
+ # @example Basic example
1427
+ # require "google/cloud/notebooks/v1"
1428
+ #
1429
+ # # Create a client object. The client can be reused for multiple calls.
1430
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1431
+ #
1432
+ # # Create a request. To set request fields, pass in keyword arguments.
1433
+ # request = Google::Cloud::Notebooks::V1::ResetInstanceRequest.new
1434
+ #
1435
+ # # Call the reset_instance method.
1436
+ # result = client.reset_instance request
1437
+ #
1438
+ # # The returned object is of type Gapic::Operation. You can use it to
1439
+ # # check the status of an operation, cancel it, or wait for results.
1440
+ # # Here is how to wait for a response.
1441
+ # result.wait_until_done! timeout: 60
1442
+ # if result.response?
1443
+ # p result.response
1444
+ # else
1445
+ # puts "No response received."
1446
+ # end
1447
+ #
1143
1448
  def reset_instance request, options = nil
1144
1449
  raise ::ArgumentError, "request must be provided" if request.nil?
1145
1450
 
@@ -1213,6 +1518,29 @@ module Google
1213
1518
  # @return [::Gapic::Operation]
1214
1519
  #
1215
1520
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1521
+ #
1522
+ # @example Basic example
1523
+ # require "google/cloud/notebooks/v1"
1524
+ #
1525
+ # # Create a client object. The client can be reused for multiple calls.
1526
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1527
+ #
1528
+ # # Create a request. To set request fields, pass in keyword arguments.
1529
+ # request = Google::Cloud::Notebooks::V1::ReportInstanceInfoRequest.new
1530
+ #
1531
+ # # Call the report_instance_info method.
1532
+ # result = client.report_instance_info request
1533
+ #
1534
+ # # The returned object is of type Gapic::Operation. You can use it to
1535
+ # # check the status of an operation, cancel it, or wait for results.
1536
+ # # Here is how to wait for a response.
1537
+ # result.wait_until_done! timeout: 60
1538
+ # if result.response?
1539
+ # p result.response
1540
+ # else
1541
+ # puts "No response received."
1542
+ # end
1543
+ #
1216
1544
  def report_instance_info request, options = nil
1217
1545
  raise ::ArgumentError, "request must be provided" if request.nil?
1218
1546
 
@@ -1280,6 +1608,22 @@ module Google
1280
1608
  # @return [::Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse]
1281
1609
  #
1282
1610
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1611
+ #
1612
+ # @example Basic example
1613
+ # require "google/cloud/notebooks/v1"
1614
+ #
1615
+ # # Create a client object. The client can be reused for multiple calls.
1616
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1617
+ #
1618
+ # # Create a request. To set request fields, pass in keyword arguments.
1619
+ # request = Google::Cloud::Notebooks::V1::IsInstanceUpgradeableRequest.new
1620
+ #
1621
+ # # Call the is_instance_upgradeable method.
1622
+ # result = client.is_instance_upgradeable request
1623
+ #
1624
+ # # The returned object is of type Google::Cloud::Notebooks::V1::IsInstanceUpgradeableResponse.
1625
+ # p result
1626
+ #
1283
1627
  def is_instance_upgradeable request, options = nil
1284
1628
  raise ::ArgumentError, "request must be provided" if request.nil?
1285
1629
 
@@ -1343,6 +1687,22 @@ module Google
1343
1687
  # @return [::Google::Cloud::Notebooks::V1::GetInstanceHealthResponse]
1344
1688
  #
1345
1689
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1690
+ #
1691
+ # @example Basic example
1692
+ # require "google/cloud/notebooks/v1"
1693
+ #
1694
+ # # Create a client object. The client can be reused for multiple calls.
1695
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1696
+ #
1697
+ # # Create a request. To set request fields, pass in keyword arguments.
1698
+ # request = Google::Cloud::Notebooks::V1::GetInstanceHealthRequest.new
1699
+ #
1700
+ # # Call the get_instance_health method.
1701
+ # result = client.get_instance_health request
1702
+ #
1703
+ # # The returned object is of type Google::Cloud::Notebooks::V1::GetInstanceHealthResponse.
1704
+ # p result
1705
+ #
1346
1706
  def get_instance_health request, options = nil
1347
1707
  raise ::ArgumentError, "request must be provided" if request.nil?
1348
1708
 
@@ -1409,6 +1769,29 @@ module Google
1409
1769
  # @return [::Gapic::Operation]
1410
1770
  #
1411
1771
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1772
+ #
1773
+ # @example Basic example
1774
+ # require "google/cloud/notebooks/v1"
1775
+ #
1776
+ # # Create a client object. The client can be reused for multiple calls.
1777
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1778
+ #
1779
+ # # Create a request. To set request fields, pass in keyword arguments.
1780
+ # request = Google::Cloud::Notebooks::V1::UpgradeInstanceRequest.new
1781
+ #
1782
+ # # Call the upgrade_instance method.
1783
+ # result = client.upgrade_instance request
1784
+ #
1785
+ # # The returned object is of type Gapic::Operation. You can use it to
1786
+ # # check the status of an operation, cancel it, or wait for results.
1787
+ # # Here is how to wait for a response.
1788
+ # result.wait_until_done! timeout: 60
1789
+ # if result.response?
1790
+ # p result.response
1791
+ # else
1792
+ # puts "No response received."
1793
+ # end
1794
+ #
1412
1795
  def upgrade_instance request, options = nil
1413
1796
  raise ::ArgumentError, "request must be provided" if request.nil?
1414
1797
 
@@ -1476,6 +1859,29 @@ module Google
1476
1859
  # @return [::Gapic::Operation]
1477
1860
  #
1478
1861
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1862
+ #
1863
+ # @example Basic example
1864
+ # require "google/cloud/notebooks/v1"
1865
+ #
1866
+ # # Create a client object. The client can be reused for multiple calls.
1867
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1868
+ #
1869
+ # # Create a request. To set request fields, pass in keyword arguments.
1870
+ # request = Google::Cloud::Notebooks::V1::RollbackInstanceRequest.new
1871
+ #
1872
+ # # Call the rollback_instance method.
1873
+ # result = client.rollback_instance request
1874
+ #
1875
+ # # The returned object is of type Gapic::Operation. You can use it to
1876
+ # # check the status of an operation, cancel it, or wait for results.
1877
+ # # Here is how to wait for a response.
1878
+ # result.wait_until_done! timeout: 60
1879
+ # if result.response?
1880
+ # p result.response
1881
+ # else
1882
+ # puts "No response received."
1883
+ # end
1884
+ #
1479
1885
  def rollback_instance request, options = nil
1480
1886
  raise ::ArgumentError, "request must be provided" if request.nil?
1481
1887
 
@@ -1542,6 +1948,29 @@ module Google
1542
1948
  # @return [::Gapic::Operation]
1543
1949
  #
1544
1950
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1951
+ #
1952
+ # @example Basic example
1953
+ # require "google/cloud/notebooks/v1"
1954
+ #
1955
+ # # Create a client object. The client can be reused for multiple calls.
1956
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
1957
+ #
1958
+ # # Create a request. To set request fields, pass in keyword arguments.
1959
+ # request = Google::Cloud::Notebooks::V1::DiagnoseInstanceRequest.new
1960
+ #
1961
+ # # Call the diagnose_instance method.
1962
+ # result = client.diagnose_instance request
1963
+ #
1964
+ # # The returned object is of type Gapic::Operation. You can use it to
1965
+ # # check the status of an operation, cancel it, or wait for results.
1966
+ # # Here is how to wait for a response.
1967
+ # result.wait_until_done! timeout: 60
1968
+ # if result.response?
1969
+ # p result.response
1970
+ # else
1971
+ # puts "No response received."
1972
+ # end
1973
+ #
1545
1974
  def diagnose_instance request, options = nil
1546
1975
  raise ::ArgumentError, "request must be provided" if request.nil?
1547
1976
 
@@ -1613,6 +2042,29 @@ module Google
1613
2042
  # @return [::Gapic::Operation]
1614
2043
  #
1615
2044
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2045
+ #
2046
+ # @example Basic example
2047
+ # require "google/cloud/notebooks/v1"
2048
+ #
2049
+ # # Create a client object. The client can be reused for multiple calls.
2050
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2051
+ #
2052
+ # # Create a request. To set request fields, pass in keyword arguments.
2053
+ # request = Google::Cloud::Notebooks::V1::UpgradeInstanceInternalRequest.new
2054
+ #
2055
+ # # Call the upgrade_instance_internal method.
2056
+ # result = client.upgrade_instance_internal request
2057
+ #
2058
+ # # The returned object is of type Gapic::Operation. You can use it to
2059
+ # # check the status of an operation, cancel it, or wait for results.
2060
+ # # Here is how to wait for a response.
2061
+ # result.wait_until_done! timeout: 60
2062
+ # if result.response?
2063
+ # p result.response
2064
+ # else
2065
+ # puts "No response received."
2066
+ # end
2067
+ #
1616
2068
  def upgrade_instance_internal request, options = nil
1617
2069
  raise ::ArgumentError, "request must be provided" if request.nil?
1618
2070
 
@@ -1681,6 +2133,26 @@ module Google
1681
2133
  # @return [::Google::Cloud::Notebooks::V1::ListEnvironmentsResponse]
1682
2134
  #
1683
2135
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2136
+ #
2137
+ # @example Basic example
2138
+ # require "google/cloud/notebooks/v1"
2139
+ #
2140
+ # # Create a client object. The client can be reused for multiple calls.
2141
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2142
+ #
2143
+ # # Create a request. To set request fields, pass in keyword arguments.
2144
+ # request = Google::Cloud::Notebooks::V1::ListEnvironmentsRequest.new
2145
+ #
2146
+ # # Call the list_environments method.
2147
+ # result = client.list_environments request
2148
+ #
2149
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2150
+ # # over elements, and API calls will be issued to fetch pages as needed.
2151
+ # result.each do |item|
2152
+ # # Each element is of type ::Google::Cloud::Notebooks::V1::Environment.
2153
+ # p item
2154
+ # end
2155
+ #
1684
2156
  def list_environments request, options = nil
1685
2157
  raise ::ArgumentError, "request must be provided" if request.nil?
1686
2158
 
@@ -1744,6 +2216,22 @@ module Google
1744
2216
  # @return [::Google::Cloud::Notebooks::V1::Environment]
1745
2217
  #
1746
2218
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2219
+ #
2220
+ # @example Basic example
2221
+ # require "google/cloud/notebooks/v1"
2222
+ #
2223
+ # # Create a client object. The client can be reused for multiple calls.
2224
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2225
+ #
2226
+ # # Create a request. To set request fields, pass in keyword arguments.
2227
+ # request = Google::Cloud::Notebooks::V1::GetEnvironmentRequest.new
2228
+ #
2229
+ # # Call the get_environment method.
2230
+ # result = client.get_environment request
2231
+ #
2232
+ # # The returned object is of type Google::Cloud::Notebooks::V1::Environment.
2233
+ # p result
2234
+ #
1747
2235
  def get_environment request, options = nil
1748
2236
  raise ::ArgumentError, "request must be provided" if request.nil?
1749
2237
 
@@ -1813,6 +2301,29 @@ module Google
1813
2301
  # @return [::Gapic::Operation]
1814
2302
  #
1815
2303
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2304
+ #
2305
+ # @example Basic example
2306
+ # require "google/cloud/notebooks/v1"
2307
+ #
2308
+ # # Create a client object. The client can be reused for multiple calls.
2309
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2310
+ #
2311
+ # # Create a request. To set request fields, pass in keyword arguments.
2312
+ # request = Google::Cloud::Notebooks::V1::CreateEnvironmentRequest.new
2313
+ #
2314
+ # # Call the create_environment method.
2315
+ # result = client.create_environment request
2316
+ #
2317
+ # # The returned object is of type Gapic::Operation. You can use it to
2318
+ # # check the status of an operation, cancel it, or wait for results.
2319
+ # # Here is how to wait for a response.
2320
+ # result.wait_until_done! timeout: 60
2321
+ # if result.response?
2322
+ # p result.response
2323
+ # else
2324
+ # puts "No response received."
2325
+ # end
2326
+ #
1816
2327
  def create_environment request, options = nil
1817
2328
  raise ::ArgumentError, "request must be provided" if request.nil?
1818
2329
 
@@ -1877,6 +2388,29 @@ module Google
1877
2388
  # @return [::Gapic::Operation]
1878
2389
  #
1879
2390
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2391
+ #
2392
+ # @example Basic example
2393
+ # require "google/cloud/notebooks/v1"
2394
+ #
2395
+ # # Create a client object. The client can be reused for multiple calls.
2396
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2397
+ #
2398
+ # # Create a request. To set request fields, pass in keyword arguments.
2399
+ # request = Google::Cloud::Notebooks::V1::DeleteEnvironmentRequest.new
2400
+ #
2401
+ # # Call the delete_environment method.
2402
+ # result = client.delete_environment request
2403
+ #
2404
+ # # The returned object is of type Gapic::Operation. You can use it to
2405
+ # # check the status of an operation, cancel it, or wait for results.
2406
+ # # Here is how to wait for a response.
2407
+ # result.wait_until_done! timeout: 60
2408
+ # if result.response?
2409
+ # p result.response
2410
+ # else
2411
+ # puts "No response received."
2412
+ # end
2413
+ #
1880
2414
  def delete_environment request, options = nil
1881
2415
  raise ::ArgumentError, "request must be provided" if request.nil?
1882
2416
 
@@ -1950,6 +2484,26 @@ module Google
1950
2484
  # @return [::Google::Cloud::Notebooks::V1::ListSchedulesResponse]
1951
2485
  #
1952
2486
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2487
+ #
2488
+ # @example Basic example
2489
+ # require "google/cloud/notebooks/v1"
2490
+ #
2491
+ # # Create a client object. The client can be reused for multiple calls.
2492
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2493
+ #
2494
+ # # Create a request. To set request fields, pass in keyword arguments.
2495
+ # request = Google::Cloud::Notebooks::V1::ListSchedulesRequest.new
2496
+ #
2497
+ # # Call the list_schedules method.
2498
+ # result = client.list_schedules request
2499
+ #
2500
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2501
+ # # over elements, and API calls will be issued to fetch pages as needed.
2502
+ # result.each do |item|
2503
+ # # Each element is of type ::Google::Cloud::Notebooks::V1::Schedule.
2504
+ # p item
2505
+ # end
2506
+ #
1953
2507
  def list_schedules request, options = nil
1954
2508
  raise ::ArgumentError, "request must be provided" if request.nil?
1955
2509
 
@@ -2013,6 +2567,22 @@ module Google
2013
2567
  # @return [::Google::Cloud::Notebooks::V1::Schedule]
2014
2568
  #
2015
2569
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2570
+ #
2571
+ # @example Basic example
2572
+ # require "google/cloud/notebooks/v1"
2573
+ #
2574
+ # # Create a client object. The client can be reused for multiple calls.
2575
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2576
+ #
2577
+ # # Create a request. To set request fields, pass in keyword arguments.
2578
+ # request = Google::Cloud::Notebooks::V1::GetScheduleRequest.new
2579
+ #
2580
+ # # Call the get_schedule method.
2581
+ # result = client.get_schedule request
2582
+ #
2583
+ # # The returned object is of type Google::Cloud::Notebooks::V1::Schedule.
2584
+ # p result
2585
+ #
2016
2586
  def get_schedule request, options = nil
2017
2587
  raise ::ArgumentError, "request must be provided" if request.nil?
2018
2588
 
@@ -2076,6 +2646,29 @@ module Google
2076
2646
  # @return [::Gapic::Operation]
2077
2647
  #
2078
2648
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2649
+ #
2650
+ # @example Basic example
2651
+ # require "google/cloud/notebooks/v1"
2652
+ #
2653
+ # # Create a client object. The client can be reused for multiple calls.
2654
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2655
+ #
2656
+ # # Create a request. To set request fields, pass in keyword arguments.
2657
+ # request = Google::Cloud::Notebooks::V1::DeleteScheduleRequest.new
2658
+ #
2659
+ # # Call the delete_schedule method.
2660
+ # result = client.delete_schedule request
2661
+ #
2662
+ # # The returned object is of type Gapic::Operation. You can use it to
2663
+ # # check the status of an operation, cancel it, or wait for results.
2664
+ # # Here is how to wait for a response.
2665
+ # result.wait_until_done! timeout: 60
2666
+ # if result.response?
2667
+ # p result.response
2668
+ # else
2669
+ # puts "No response received."
2670
+ # end
2671
+ #
2079
2672
  def delete_schedule request, options = nil
2080
2673
  raise ::ArgumentError, "request must be provided" if request.nil?
2081
2674
 
@@ -2144,6 +2737,29 @@ module Google
2144
2737
  # @return [::Gapic::Operation]
2145
2738
  #
2146
2739
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2740
+ #
2741
+ # @example Basic example
2742
+ # require "google/cloud/notebooks/v1"
2743
+ #
2744
+ # # Create a client object. The client can be reused for multiple calls.
2745
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2746
+ #
2747
+ # # Create a request. To set request fields, pass in keyword arguments.
2748
+ # request = Google::Cloud::Notebooks::V1::CreateScheduleRequest.new
2749
+ #
2750
+ # # Call the create_schedule method.
2751
+ # result = client.create_schedule request
2752
+ #
2753
+ # # The returned object is of type Gapic::Operation. You can use it to
2754
+ # # check the status of an operation, cancel it, or wait for results.
2755
+ # # Here is how to wait for a response.
2756
+ # result.wait_until_done! timeout: 60
2757
+ # if result.response?
2758
+ # p result.response
2759
+ # else
2760
+ # puts "No response received."
2761
+ # end
2762
+ #
2147
2763
  def create_schedule request, options = nil
2148
2764
  raise ::ArgumentError, "request must be provided" if request.nil?
2149
2765
 
@@ -2208,6 +2824,29 @@ module Google
2208
2824
  # @return [::Gapic::Operation]
2209
2825
  #
2210
2826
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2827
+ #
2828
+ # @example Basic example
2829
+ # require "google/cloud/notebooks/v1"
2830
+ #
2831
+ # # Create a client object. The client can be reused for multiple calls.
2832
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2833
+ #
2834
+ # # Create a request. To set request fields, pass in keyword arguments.
2835
+ # request = Google::Cloud::Notebooks::V1::TriggerScheduleRequest.new
2836
+ #
2837
+ # # Call the trigger_schedule method.
2838
+ # result = client.trigger_schedule request
2839
+ #
2840
+ # # The returned object is of type Gapic::Operation. You can use it to
2841
+ # # check the status of an operation, cancel it, or wait for results.
2842
+ # # Here is how to wait for a response.
2843
+ # result.wait_until_done! timeout: 60
2844
+ # if result.response?
2845
+ # p result.response
2846
+ # else
2847
+ # puts "No response received."
2848
+ # end
2849
+ #
2211
2850
  def trigger_schedule request, options = nil
2212
2851
  raise ::ArgumentError, "request must be provided" if request.nil?
2213
2852
 
@@ -2283,6 +2922,26 @@ module Google
2283
2922
  # @return [::Google::Cloud::Notebooks::V1::ListExecutionsResponse]
2284
2923
  #
2285
2924
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2925
+ #
2926
+ # @example Basic example
2927
+ # require "google/cloud/notebooks/v1"
2928
+ #
2929
+ # # Create a client object. The client can be reused for multiple calls.
2930
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
2931
+ #
2932
+ # # Create a request. To set request fields, pass in keyword arguments.
2933
+ # request = Google::Cloud::Notebooks::V1::ListExecutionsRequest.new
2934
+ #
2935
+ # # Call the list_executions method.
2936
+ # result = client.list_executions request
2937
+ #
2938
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2939
+ # # over elements, and API calls will be issued to fetch pages as needed.
2940
+ # result.each do |item|
2941
+ # # Each element is of type ::Google::Cloud::Notebooks::V1::Execution.
2942
+ # p item
2943
+ # end
2944
+ #
2286
2945
  def list_executions request, options = nil
2287
2946
  raise ::ArgumentError, "request must be provided" if request.nil?
2288
2947
 
@@ -2346,6 +3005,22 @@ module Google
2346
3005
  # @return [::Google::Cloud::Notebooks::V1::Execution]
2347
3006
  #
2348
3007
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3008
+ #
3009
+ # @example Basic example
3010
+ # require "google/cloud/notebooks/v1"
3011
+ #
3012
+ # # Create a client object. The client can be reused for multiple calls.
3013
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
3014
+ #
3015
+ # # Create a request. To set request fields, pass in keyword arguments.
3016
+ # request = Google::Cloud::Notebooks::V1::GetExecutionRequest.new
3017
+ #
3018
+ # # Call the get_execution method.
3019
+ # result = client.get_execution request
3020
+ #
3021
+ # # The returned object is of type Google::Cloud::Notebooks::V1::Execution.
3022
+ # p result
3023
+ #
2349
3024
  def get_execution request, options = nil
2350
3025
  raise ::ArgumentError, "request must be provided" if request.nil?
2351
3026
 
@@ -2409,6 +3084,29 @@ module Google
2409
3084
  # @return [::Gapic::Operation]
2410
3085
  #
2411
3086
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3087
+ #
3088
+ # @example Basic example
3089
+ # require "google/cloud/notebooks/v1"
3090
+ #
3091
+ # # Create a client object. The client can be reused for multiple calls.
3092
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
3093
+ #
3094
+ # # Create a request. To set request fields, pass in keyword arguments.
3095
+ # request = Google::Cloud::Notebooks::V1::DeleteExecutionRequest.new
3096
+ #
3097
+ # # Call the delete_execution method.
3098
+ # result = client.delete_execution request
3099
+ #
3100
+ # # The returned object is of type Gapic::Operation. You can use it to
3101
+ # # check the status of an operation, cancel it, or wait for results.
3102
+ # # Here is how to wait for a response.
3103
+ # result.wait_until_done! timeout: 60
3104
+ # if result.response?
3105
+ # p result.response
3106
+ # else
3107
+ # puts "No response received."
3108
+ # end
3109
+ #
2412
3110
  def delete_execution request, options = nil
2413
3111
  raise ::ArgumentError, "request must be provided" if request.nil?
2414
3112
 
@@ -2477,6 +3175,29 @@ module Google
2477
3175
  # @return [::Gapic::Operation]
2478
3176
  #
2479
3177
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3178
+ #
3179
+ # @example Basic example
3180
+ # require "google/cloud/notebooks/v1"
3181
+ #
3182
+ # # Create a client object. The client can be reused for multiple calls.
3183
+ # client = Google::Cloud::Notebooks::V1::NotebookService::Rest::Client.new
3184
+ #
3185
+ # # Create a request. To set request fields, pass in keyword arguments.
3186
+ # request = Google::Cloud::Notebooks::V1::CreateExecutionRequest.new
3187
+ #
3188
+ # # Call the create_execution method.
3189
+ # result = client.create_execution request
3190
+ #
3191
+ # # The returned object is of type Gapic::Operation. You can use it to
3192
+ # # check the status of an operation, cancel it, or wait for results.
3193
+ # # Here is how to wait for a response.
3194
+ # result.wait_until_done! timeout: 60
3195
+ # if result.response?
3196
+ # p result.response
3197
+ # else
3198
+ # puts "No response received."
3199
+ # end
3200
+ #
2480
3201
  def create_execution request, options = nil
2481
3202
  raise ::ArgumentError, "request must be provided" if request.nil?
2482
3203
 
@@ -2586,7 +3307,9 @@ module Google
2586
3307
  class Configuration
2587
3308
  extend ::Gapic::Config
2588
3309
 
2589
- config_attr :endpoint, "notebooks.googleapis.com", ::String
3310
+ DEFAULT_ENDPOINT = "notebooks.googleapis.com"
3311
+
3312
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2590
3313
  config_attr :credentials, nil do |value|
2591
3314
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2592
3315
  allowed.any? { |klass| klass === value }