google-cloud-dataform-v1beta1 0.2.0 → 0.4.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.
@@ -122,7 +122,7 @@ module Google
122
122
  credentials = @config.credentials
123
123
  # Use self-signed JWT if the endpoint is unchanged from default,
124
124
  # but only if the default endpoint does not have a region prefix.
125
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
125
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
126
126
  !@config.endpoint.split(".").first.include?("-")
127
127
  credentials ||= Credentials.default scope: @config.scope,
128
128
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -209,6 +209,26 @@ module Google
209
209
  # @return [::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse]
210
210
  #
211
211
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
212
+ #
213
+ # @example Basic example
214
+ # require "google/cloud/dataform/v1beta1"
215
+ #
216
+ # # Create a client object. The client can be reused for multiple calls.
217
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
218
+ #
219
+ # # Create a request. To set request fields, pass in keyword arguments.
220
+ # request = Google::Cloud::Dataform::V1beta1::ListRepositoriesRequest.new
221
+ #
222
+ # # Call the list_repositories method.
223
+ # result = client.list_repositories request
224
+ #
225
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
226
+ # # over elements, and API calls will be issued to fetch pages as needed.
227
+ # result.each do |item|
228
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::Repository.
229
+ # p item
230
+ # end
231
+ #
212
232
  def list_repositories request, options = nil
213
233
  raise ::ArgumentError, "request must be provided" if request.nil?
214
234
 
@@ -271,6 +291,22 @@ module Google
271
291
  # @return [::Google::Cloud::Dataform::V1beta1::Repository]
272
292
  #
273
293
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
294
+ #
295
+ # @example Basic example
296
+ # require "google/cloud/dataform/v1beta1"
297
+ #
298
+ # # Create a client object. The client can be reused for multiple calls.
299
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
300
+ #
301
+ # # Create a request. To set request fields, pass in keyword arguments.
302
+ # request = Google::Cloud::Dataform::V1beta1::GetRepositoryRequest.new
303
+ #
304
+ # # Call the get_repository method.
305
+ # result = client.get_repository request
306
+ #
307
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository.
308
+ # p result
309
+ #
274
310
  def get_repository request, options = nil
275
311
  raise ::ArgumentError, "request must be provided" if request.nil?
276
312
 
@@ -339,6 +375,22 @@ module Google
339
375
  # @return [::Google::Cloud::Dataform::V1beta1::Repository]
340
376
  #
341
377
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
378
+ #
379
+ # @example Basic example
380
+ # require "google/cloud/dataform/v1beta1"
381
+ #
382
+ # # Create a client object. The client can be reused for multiple calls.
383
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
384
+ #
385
+ # # Create a request. To set request fields, pass in keyword arguments.
386
+ # request = Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest.new
387
+ #
388
+ # # Call the create_repository method.
389
+ # result = client.create_repository request
390
+ #
391
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository.
392
+ # p result
393
+ #
342
394
  def create_repository request, options = nil
343
395
  raise ::ArgumentError, "request must be provided" if request.nil?
344
396
 
@@ -404,6 +456,22 @@ module Google
404
456
  # @return [::Google::Cloud::Dataform::V1beta1::Repository]
405
457
  #
406
458
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
459
+ #
460
+ # @example Basic example
461
+ # require "google/cloud/dataform/v1beta1"
462
+ #
463
+ # # Create a client object. The client can be reused for multiple calls.
464
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
465
+ #
466
+ # # Create a request. To set request fields, pass in keyword arguments.
467
+ # request = Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest.new
468
+ #
469
+ # # Call the update_repository method.
470
+ # result = client.update_repository request
471
+ #
472
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository.
473
+ # p result
474
+ #
407
475
  def update_repository request, options = nil
408
476
  raise ::ArgumentError, "request must be provided" if request.nil?
409
477
 
@@ -470,6 +538,22 @@ module Google
470
538
  # @return [::Google::Protobuf::Empty]
471
539
  #
472
540
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
541
+ #
542
+ # @example Basic example
543
+ # require "google/cloud/dataform/v1beta1"
544
+ #
545
+ # # Create a client object. The client can be reused for multiple calls.
546
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
547
+ #
548
+ # # Create a request. To set request fields, pass in keyword arguments.
549
+ # request = Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest.new
550
+ #
551
+ # # Call the delete_repository method.
552
+ # result = client.delete_repository request
553
+ #
554
+ # # The returned object is of type Google::Protobuf::Empty.
555
+ # p result
556
+ #
473
557
  def delete_repository request, options = nil
474
558
  raise ::ArgumentError, "request must be provided" if request.nil?
475
559
 
@@ -532,6 +616,22 @@ module Google
532
616
  # @return [::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse]
533
617
  #
534
618
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
619
+ #
620
+ # @example Basic example
621
+ # require "google/cloud/dataform/v1beta1"
622
+ #
623
+ # # Create a client object. The client can be reused for multiple calls.
624
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
625
+ #
626
+ # # Create a request. To set request fields, pass in keyword arguments.
627
+ # request = Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesRequest.new
628
+ #
629
+ # # Call the fetch_remote_branches method.
630
+ # result = client.fetch_remote_branches request
631
+ #
632
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse.
633
+ # p result
634
+ #
535
635
  def fetch_remote_branches request, options = nil
536
636
  raise ::ArgumentError, "request must be provided" if request.nil?
537
637
 
@@ -611,6 +711,26 @@ module Google
611
711
  # @return [::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse]
612
712
  #
613
713
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
714
+ #
715
+ # @example Basic example
716
+ # require "google/cloud/dataform/v1beta1"
717
+ #
718
+ # # Create a client object. The client can be reused for multiple calls.
719
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
720
+ #
721
+ # # Create a request. To set request fields, pass in keyword arguments.
722
+ # request = Google::Cloud::Dataform::V1beta1::ListWorkspacesRequest.new
723
+ #
724
+ # # Call the list_workspaces method.
725
+ # result = client.list_workspaces request
726
+ #
727
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
728
+ # # over elements, and API calls will be issued to fetch pages as needed.
729
+ # result.each do |item|
730
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::Workspace.
731
+ # p item
732
+ # end
733
+ #
614
734
  def list_workspaces request, options = nil
615
735
  raise ::ArgumentError, "request must be provided" if request.nil?
616
736
 
@@ -673,6 +793,22 @@ module Google
673
793
  # @return [::Google::Cloud::Dataform::V1beta1::Workspace]
674
794
  #
675
795
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
796
+ #
797
+ # @example Basic example
798
+ # require "google/cloud/dataform/v1beta1"
799
+ #
800
+ # # Create a client object. The client can be reused for multiple calls.
801
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
802
+ #
803
+ # # Create a request. To set request fields, pass in keyword arguments.
804
+ # request = Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest.new
805
+ #
806
+ # # Call the get_workspace method.
807
+ # result = client.get_workspace request
808
+ #
809
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Workspace.
810
+ # p result
811
+ #
676
812
  def get_workspace request, options = nil
677
813
  raise ::ArgumentError, "request must be provided" if request.nil?
678
814
 
@@ -741,6 +877,22 @@ module Google
741
877
  # @return [::Google::Cloud::Dataform::V1beta1::Workspace]
742
878
  #
743
879
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
880
+ #
881
+ # @example Basic example
882
+ # require "google/cloud/dataform/v1beta1"
883
+ #
884
+ # # Create a client object. The client can be reused for multiple calls.
885
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
886
+ #
887
+ # # Create a request. To set request fields, pass in keyword arguments.
888
+ # request = Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest.new
889
+ #
890
+ # # Call the create_workspace method.
891
+ # result = client.create_workspace request
892
+ #
893
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Workspace.
894
+ # p result
895
+ #
744
896
  def create_workspace request, options = nil
745
897
  raise ::ArgumentError, "request must be provided" if request.nil?
746
898
 
@@ -803,6 +955,22 @@ module Google
803
955
  # @return [::Google::Protobuf::Empty]
804
956
  #
805
957
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
958
+ #
959
+ # @example Basic example
960
+ # require "google/cloud/dataform/v1beta1"
961
+ #
962
+ # # Create a client object. The client can be reused for multiple calls.
963
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
964
+ #
965
+ # # Create a request. To set request fields, pass in keyword arguments.
966
+ # request = Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest.new
967
+ #
968
+ # # Call the delete_workspace method.
969
+ # result = client.delete_workspace request
970
+ #
971
+ # # The returned object is of type Google::Protobuf::Empty.
972
+ # p result
973
+ #
806
974
  def delete_workspace request, options = nil
807
975
  raise ::ArgumentError, "request must be provided" if request.nil?
808
976
 
@@ -865,6 +1033,22 @@ module Google
865
1033
  # @return [::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse]
866
1034
  #
867
1035
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1036
+ #
1037
+ # @example Basic example
1038
+ # require "google/cloud/dataform/v1beta1"
1039
+ #
1040
+ # # Create a client object. The client can be reused for multiple calls.
1041
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1042
+ #
1043
+ # # Create a request. To set request fields, pass in keyword arguments.
1044
+ # request = Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest.new
1045
+ #
1046
+ # # Call the install_npm_packages method.
1047
+ # result = client.install_npm_packages request
1048
+ #
1049
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse.
1050
+ # p result
1051
+ #
868
1052
  def install_npm_packages request, options = nil
869
1053
  raise ::ArgumentError, "request must be provided" if request.nil?
870
1054
 
@@ -933,6 +1117,22 @@ module Google
933
1117
  # @return [::Google::Protobuf::Empty]
934
1118
  #
935
1119
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1120
+ #
1121
+ # @example Basic example
1122
+ # require "google/cloud/dataform/v1beta1"
1123
+ #
1124
+ # # Create a client object. The client can be reused for multiple calls.
1125
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1126
+ #
1127
+ # # Create a request. To set request fields, pass in keyword arguments.
1128
+ # request = Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest.new
1129
+ #
1130
+ # # Call the pull_git_commits method.
1131
+ # result = client.pull_git_commits request
1132
+ #
1133
+ # # The returned object is of type Google::Protobuf::Empty.
1134
+ # p result
1135
+ #
936
1136
  def pull_git_commits request, options = nil
937
1137
  raise ::ArgumentError, "request must be provided" if request.nil?
938
1138
 
@@ -998,6 +1198,22 @@ module Google
998
1198
  # @return [::Google::Protobuf::Empty]
999
1199
  #
1000
1200
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1201
+ #
1202
+ # @example Basic example
1203
+ # require "google/cloud/dataform/v1beta1"
1204
+ #
1205
+ # # Create a client object. The client can be reused for multiple calls.
1206
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1207
+ #
1208
+ # # Create a request. To set request fields, pass in keyword arguments.
1209
+ # request = Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest.new
1210
+ #
1211
+ # # Call the push_git_commits method.
1212
+ # result = client.push_git_commits request
1213
+ #
1214
+ # # The returned object is of type Google::Protobuf::Empty.
1215
+ # p result
1216
+ #
1001
1217
  def push_git_commits request, options = nil
1002
1218
  raise ::ArgumentError, "request must be provided" if request.nil?
1003
1219
 
@@ -1060,6 +1276,22 @@ module Google
1060
1276
  # @return [::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse]
1061
1277
  #
1062
1278
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1279
+ #
1280
+ # @example Basic example
1281
+ # require "google/cloud/dataform/v1beta1"
1282
+ #
1283
+ # # Create a client object. The client can be reused for multiple calls.
1284
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1285
+ #
1286
+ # # Create a request. To set request fields, pass in keyword arguments.
1287
+ # request = Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesRequest.new
1288
+ #
1289
+ # # Call the fetch_file_git_statuses method.
1290
+ # result = client.fetch_file_git_statuses request
1291
+ #
1292
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse.
1293
+ # p result
1294
+ #
1063
1295
  def fetch_file_git_statuses request, options = nil
1064
1296
  raise ::ArgumentError, "request must be provided" if request.nil?
1065
1297
 
@@ -1126,6 +1358,22 @@ module Google
1126
1358
  # @return [::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse]
1127
1359
  #
1128
1360
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1361
+ #
1362
+ # @example Basic example
1363
+ # require "google/cloud/dataform/v1beta1"
1364
+ #
1365
+ # # Create a client object. The client can be reused for multiple calls.
1366
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1367
+ #
1368
+ # # Create a request. To set request fields, pass in keyword arguments.
1369
+ # request = Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindRequest.new
1370
+ #
1371
+ # # Call the fetch_git_ahead_behind method.
1372
+ # result = client.fetch_git_ahead_behind request
1373
+ #
1374
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse.
1375
+ # p result
1376
+ #
1129
1377
  def fetch_git_ahead_behind request, options = nil
1130
1378
  raise ::ArgumentError, "request must be provided" if request.nil?
1131
1379
 
@@ -1195,6 +1443,22 @@ module Google
1195
1443
  # @return [::Google::Protobuf::Empty]
1196
1444
  #
1197
1445
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1446
+ #
1447
+ # @example Basic example
1448
+ # require "google/cloud/dataform/v1beta1"
1449
+ #
1450
+ # # Create a client object. The client can be reused for multiple calls.
1451
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1452
+ #
1453
+ # # Create a request. To set request fields, pass in keyword arguments.
1454
+ # request = Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest.new
1455
+ #
1456
+ # # Call the commit_workspace_changes method.
1457
+ # result = client.commit_workspace_changes request
1458
+ #
1459
+ # # The returned object is of type Google::Protobuf::Empty.
1460
+ # p result
1461
+ #
1198
1462
  def commit_workspace_changes request, options = nil
1199
1463
  raise ::ArgumentError, "request must be provided" if request.nil?
1200
1464
 
@@ -1262,6 +1526,22 @@ module Google
1262
1526
  # @return [::Google::Protobuf::Empty]
1263
1527
  #
1264
1528
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1529
+ #
1530
+ # @example Basic example
1531
+ # require "google/cloud/dataform/v1beta1"
1532
+ #
1533
+ # # Create a client object. The client can be reused for multiple calls.
1534
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1535
+ #
1536
+ # # Create a request. To set request fields, pass in keyword arguments.
1537
+ # request = Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest.new
1538
+ #
1539
+ # # Call the reset_workspace_changes method.
1540
+ # result = client.reset_workspace_changes request
1541
+ #
1542
+ # # The returned object is of type Google::Protobuf::Empty.
1543
+ # p result
1544
+ #
1265
1545
  def reset_workspace_changes request, options = nil
1266
1546
  raise ::ArgumentError, "request must be provided" if request.nil?
1267
1547
 
@@ -1326,6 +1606,22 @@ module Google
1326
1606
  # @return [::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse]
1327
1607
  #
1328
1608
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1609
+ #
1610
+ # @example Basic example
1611
+ # require "google/cloud/dataform/v1beta1"
1612
+ #
1613
+ # # Create a client object. The client can be reused for multiple calls.
1614
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1615
+ #
1616
+ # # Create a request. To set request fields, pass in keyword arguments.
1617
+ # request = Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest.new
1618
+ #
1619
+ # # Call the fetch_file_diff method.
1620
+ # result = client.fetch_file_diff request
1621
+ #
1622
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse.
1623
+ # p result
1624
+ #
1329
1625
  def fetch_file_diff request, options = nil
1330
1626
  raise ::ArgumentError, "request must be provided" if request.nil?
1331
1627
 
@@ -1402,6 +1698,26 @@ module Google
1402
1698
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>]
1403
1699
  #
1404
1700
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1701
+ #
1702
+ # @example Basic example
1703
+ # require "google/cloud/dataform/v1beta1"
1704
+ #
1705
+ # # Create a client object. The client can be reused for multiple calls.
1706
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1707
+ #
1708
+ # # Create a request. To set request fields, pass in keyword arguments.
1709
+ # request = Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsRequest.new
1710
+ #
1711
+ # # Call the query_directory_contents method.
1712
+ # result = client.query_directory_contents request
1713
+ #
1714
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1715
+ # # over elements, and API calls will be issued to fetch pages as needed.
1716
+ # result.each do |item|
1717
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry.
1718
+ # p item
1719
+ # end
1720
+ #
1405
1721
  def query_directory_contents request, options = nil
1406
1722
  raise ::ArgumentError, "request must be provided" if request.nil?
1407
1723
 
@@ -1468,6 +1784,22 @@ module Google
1468
1784
  # @return [::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse]
1469
1785
  #
1470
1786
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1787
+ #
1788
+ # @example Basic example
1789
+ # require "google/cloud/dataform/v1beta1"
1790
+ #
1791
+ # # Create a client object. The client can be reused for multiple calls.
1792
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1793
+ #
1794
+ # # Create a request. To set request fields, pass in keyword arguments.
1795
+ # request = Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest.new
1796
+ #
1797
+ # # Call the make_directory method.
1798
+ # result = client.make_directory request
1799
+ #
1800
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse.
1801
+ # p result
1802
+ #
1471
1803
  def make_directory request, options = nil
1472
1804
  raise ::ArgumentError, "request must be provided" if request.nil?
1473
1805
 
@@ -1533,6 +1865,22 @@ module Google
1533
1865
  # @return [::Google::Protobuf::Empty]
1534
1866
  #
1535
1867
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1868
+ #
1869
+ # @example Basic example
1870
+ # require "google/cloud/dataform/v1beta1"
1871
+ #
1872
+ # # Create a client object. The client can be reused for multiple calls.
1873
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1874
+ #
1875
+ # # Create a request. To set request fields, pass in keyword arguments.
1876
+ # request = Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest.new
1877
+ #
1878
+ # # Call the remove_directory method.
1879
+ # result = client.remove_directory request
1880
+ #
1881
+ # # The returned object is of type Google::Protobuf::Empty.
1882
+ # p result
1883
+ #
1536
1884
  def remove_directory request, options = nil
1537
1885
  raise ::ArgumentError, "request must be provided" if request.nil?
1538
1886
 
@@ -1602,6 +1950,22 @@ module Google
1602
1950
  # @return [::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse]
1603
1951
  #
1604
1952
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1953
+ #
1954
+ # @example Basic example
1955
+ # require "google/cloud/dataform/v1beta1"
1956
+ #
1957
+ # # Create a client object. The client can be reused for multiple calls.
1958
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
1959
+ #
1960
+ # # Create a request. To set request fields, pass in keyword arguments.
1961
+ # request = Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest.new
1962
+ #
1963
+ # # Call the move_directory method.
1964
+ # result = client.move_directory request
1965
+ #
1966
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse.
1967
+ # p result
1968
+ #
1605
1969
  def move_directory request, options = nil
1606
1970
  raise ::ArgumentError, "request must be provided" if request.nil?
1607
1971
 
@@ -1666,6 +2030,22 @@ module Google
1666
2030
  # @return [::Google::Cloud::Dataform::V1beta1::ReadFileResponse]
1667
2031
  #
1668
2032
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2033
+ #
2034
+ # @example Basic example
2035
+ # require "google/cloud/dataform/v1beta1"
2036
+ #
2037
+ # # Create a client object. The client can be reused for multiple calls.
2038
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2039
+ #
2040
+ # # Create a request. To set request fields, pass in keyword arguments.
2041
+ # request = Google::Cloud::Dataform::V1beta1::ReadFileRequest.new
2042
+ #
2043
+ # # Call the read_file method.
2044
+ # result = client.read_file request
2045
+ #
2046
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::ReadFileResponse.
2047
+ # p result
2048
+ #
1669
2049
  def read_file request, options = nil
1670
2050
  raise ::ArgumentError, "request must be provided" if request.nil?
1671
2051
 
@@ -1730,6 +2110,22 @@ module Google
1730
2110
  # @return [::Google::Protobuf::Empty]
1731
2111
  #
1732
2112
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2113
+ #
2114
+ # @example Basic example
2115
+ # require "google/cloud/dataform/v1beta1"
2116
+ #
2117
+ # # Create a client object. The client can be reused for multiple calls.
2118
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2119
+ #
2120
+ # # Create a request. To set request fields, pass in keyword arguments.
2121
+ # request = Google::Cloud::Dataform::V1beta1::RemoveFileRequest.new
2122
+ #
2123
+ # # Call the remove_file method.
2124
+ # result = client.remove_file request
2125
+ #
2126
+ # # The returned object is of type Google::Protobuf::Empty.
2127
+ # p result
2128
+ #
1733
2129
  def remove_file request, options = nil
1734
2130
  raise ::ArgumentError, "request must be provided" if request.nil?
1735
2131
 
@@ -1796,6 +2192,22 @@ module Google
1796
2192
  # @return [::Google::Cloud::Dataform::V1beta1::MoveFileResponse]
1797
2193
  #
1798
2194
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2195
+ #
2196
+ # @example Basic example
2197
+ # require "google/cloud/dataform/v1beta1"
2198
+ #
2199
+ # # Create a client object. The client can be reused for multiple calls.
2200
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2201
+ #
2202
+ # # Create a request. To set request fields, pass in keyword arguments.
2203
+ # request = Google::Cloud::Dataform::V1beta1::MoveFileRequest.new
2204
+ #
2205
+ # # Call the move_file method.
2206
+ # result = client.move_file request
2207
+ #
2208
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::MoveFileResponse.
2209
+ # p result
2210
+ #
1799
2211
  def move_file request, options = nil
1800
2212
  raise ::ArgumentError, "request must be provided" if request.nil?
1801
2213
 
@@ -1862,6 +2274,22 @@ module Google
1862
2274
  # @return [::Google::Cloud::Dataform::V1beta1::WriteFileResponse]
1863
2275
  #
1864
2276
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2277
+ #
2278
+ # @example Basic example
2279
+ # require "google/cloud/dataform/v1beta1"
2280
+ #
2281
+ # # Create a client object. The client can be reused for multiple calls.
2282
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2283
+ #
2284
+ # # Create a request. To set request fields, pass in keyword arguments.
2285
+ # request = Google::Cloud::Dataform::V1beta1::WriteFileRequest.new
2286
+ #
2287
+ # # Call the write_file method.
2288
+ # result = client.write_file request
2289
+ #
2290
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::WriteFileResponse.
2291
+ # p result
2292
+ #
1865
2293
  def write_file request, options = nil
1866
2294
  raise ::ArgumentError, "request must be provided" if request.nil?
1867
2295
 
@@ -1935,6 +2363,26 @@ module Google
1935
2363
  # @return [::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse]
1936
2364
  #
1937
2365
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2366
+ #
2367
+ # @example Basic example
2368
+ # require "google/cloud/dataform/v1beta1"
2369
+ #
2370
+ # # Create a client object. The client can be reused for multiple calls.
2371
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2372
+ #
2373
+ # # Create a request. To set request fields, pass in keyword arguments.
2374
+ # request = Google::Cloud::Dataform::V1beta1::ListCompilationResultsRequest.new
2375
+ #
2376
+ # # Call the list_compilation_results method.
2377
+ # result = client.list_compilation_results request
2378
+ #
2379
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2380
+ # # over elements, and API calls will be issued to fetch pages as needed.
2381
+ # result.each do |item|
2382
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::CompilationResult.
2383
+ # p item
2384
+ # end
2385
+ #
1938
2386
  def list_compilation_results request, options = nil
1939
2387
  raise ::ArgumentError, "request must be provided" if request.nil?
1940
2388
 
@@ -1997,6 +2445,22 @@ module Google
1997
2445
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResult]
1998
2446
  #
1999
2447
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2448
+ #
2449
+ # @example Basic example
2450
+ # require "google/cloud/dataform/v1beta1"
2451
+ #
2452
+ # # Create a client object. The client can be reused for multiple calls.
2453
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2454
+ #
2455
+ # # Create a request. To set request fields, pass in keyword arguments.
2456
+ # request = Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest.new
2457
+ #
2458
+ # # Call the get_compilation_result method.
2459
+ # result = client.get_compilation_result request
2460
+ #
2461
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CompilationResult.
2462
+ # p result
2463
+ #
2000
2464
  def get_compilation_result request, options = nil
2001
2465
  raise ::ArgumentError, "request must be provided" if request.nil?
2002
2466
 
@@ -2062,6 +2526,22 @@ module Google
2062
2526
  # @return [::Google::Cloud::Dataform::V1beta1::CompilationResult]
2063
2527
  #
2064
2528
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2529
+ #
2530
+ # @example Basic example
2531
+ # require "google/cloud/dataform/v1beta1"
2532
+ #
2533
+ # # Create a client object. The client can be reused for multiple calls.
2534
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2535
+ #
2536
+ # # Create a request. To set request fields, pass in keyword arguments.
2537
+ # request = Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest.new
2538
+ #
2539
+ # # Call the create_compilation_result method.
2540
+ # result = client.create_compilation_result request
2541
+ #
2542
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CompilationResult.
2543
+ # p result
2544
+ #
2065
2545
  def create_compilation_result request, options = nil
2066
2546
  raise ::ArgumentError, "request must be provided" if request.nil?
2067
2547
 
@@ -2138,6 +2618,26 @@ module Google
2138
2618
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>]
2139
2619
  #
2140
2620
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2621
+ #
2622
+ # @example Basic example
2623
+ # require "google/cloud/dataform/v1beta1"
2624
+ #
2625
+ # # Create a client object. The client can be reused for multiple calls.
2626
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2627
+ #
2628
+ # # Create a request. To set request fields, pass in keyword arguments.
2629
+ # request = Google::Cloud::Dataform::V1beta1::QueryCompilationResultActionsRequest.new
2630
+ #
2631
+ # # Call the query_compilation_result_actions method.
2632
+ # result = client.query_compilation_result_actions request
2633
+ #
2634
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2635
+ # # over elements, and API calls will be issued to fetch pages as needed.
2636
+ # result.each do |item|
2637
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::CompilationResultAction.
2638
+ # p item
2639
+ # end
2640
+ #
2141
2641
  def query_compilation_result_actions request, options = nil
2142
2642
  raise ::ArgumentError, "request must be provided" if request.nil?
2143
2643
 
@@ -2212,6 +2712,26 @@ module Google
2212
2712
  # @return [::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse]
2213
2713
  #
2214
2714
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2715
+ #
2716
+ # @example Basic example
2717
+ # require "google/cloud/dataform/v1beta1"
2718
+ #
2719
+ # # Create a client object. The client can be reused for multiple calls.
2720
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2721
+ #
2722
+ # # Create a request. To set request fields, pass in keyword arguments.
2723
+ # request = Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsRequest.new
2724
+ #
2725
+ # # Call the list_workflow_invocations method.
2726
+ # result = client.list_workflow_invocations request
2727
+ #
2728
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2729
+ # # over elements, and API calls will be issued to fetch pages as needed.
2730
+ # result.each do |item|
2731
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation.
2732
+ # p item
2733
+ # end
2734
+ #
2215
2735
  def list_workflow_invocations request, options = nil
2216
2736
  raise ::ArgumentError, "request must be provided" if request.nil?
2217
2737
 
@@ -2274,6 +2794,22 @@ module Google
2274
2794
  # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation]
2275
2795
  #
2276
2796
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2797
+ #
2798
+ # @example Basic example
2799
+ # require "google/cloud/dataform/v1beta1"
2800
+ #
2801
+ # # Create a client object. The client can be reused for multiple calls.
2802
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2803
+ #
2804
+ # # Create a request. To set request fields, pass in keyword arguments.
2805
+ # request = Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest.new
2806
+ #
2807
+ # # Call the get_workflow_invocation method.
2808
+ # result = client.get_workflow_invocation request
2809
+ #
2810
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowInvocation.
2811
+ # p result
2812
+ #
2277
2813
  def get_workflow_invocation request, options = nil
2278
2814
  raise ::ArgumentError, "request must be provided" if request.nil?
2279
2815
 
@@ -2339,6 +2875,22 @@ module Google
2339
2875
  # @return [::Google::Cloud::Dataform::V1beta1::WorkflowInvocation]
2340
2876
  #
2341
2877
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2878
+ #
2879
+ # @example Basic example
2880
+ # require "google/cloud/dataform/v1beta1"
2881
+ #
2882
+ # # Create a client object. The client can be reused for multiple calls.
2883
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2884
+ #
2885
+ # # Create a request. To set request fields, pass in keyword arguments.
2886
+ # request = Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest.new
2887
+ #
2888
+ # # Call the create_workflow_invocation method.
2889
+ # result = client.create_workflow_invocation request
2890
+ #
2891
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowInvocation.
2892
+ # p result
2893
+ #
2342
2894
  def create_workflow_invocation request, options = nil
2343
2895
  raise ::ArgumentError, "request must be provided" if request.nil?
2344
2896
 
@@ -2401,6 +2953,22 @@ module Google
2401
2953
  # @return [::Google::Protobuf::Empty]
2402
2954
  #
2403
2955
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2956
+ #
2957
+ # @example Basic example
2958
+ # require "google/cloud/dataform/v1beta1"
2959
+ #
2960
+ # # Create a client object. The client can be reused for multiple calls.
2961
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2962
+ #
2963
+ # # Create a request. To set request fields, pass in keyword arguments.
2964
+ # request = Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest.new
2965
+ #
2966
+ # # Call the delete_workflow_invocation method.
2967
+ # result = client.delete_workflow_invocation request
2968
+ #
2969
+ # # The returned object is of type Google::Protobuf::Empty.
2970
+ # p result
2971
+ #
2404
2972
  def delete_workflow_invocation request, options = nil
2405
2973
  raise ::ArgumentError, "request must be provided" if request.nil?
2406
2974
 
@@ -2463,6 +3031,22 @@ module Google
2463
3031
  # @return [::Google::Protobuf::Empty]
2464
3032
  #
2465
3033
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3034
+ #
3035
+ # @example Basic example
3036
+ # require "google/cloud/dataform/v1beta1"
3037
+ #
3038
+ # # Create a client object. The client can be reused for multiple calls.
3039
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
3040
+ #
3041
+ # # Create a request. To set request fields, pass in keyword arguments.
3042
+ # request = Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest.new
3043
+ #
3044
+ # # Call the cancel_workflow_invocation method.
3045
+ # result = client.cancel_workflow_invocation request
3046
+ #
3047
+ # # The returned object is of type Google::Protobuf::Empty.
3048
+ # p result
3049
+ #
2466
3050
  def cancel_workflow_invocation request, options = nil
2467
3051
  raise ::ArgumentError, "request must be provided" if request.nil?
2468
3052
 
@@ -2536,6 +3120,26 @@ module Google
2536
3120
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>]
2537
3121
  #
2538
3122
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3123
+ #
3124
+ # @example Basic example
3125
+ # require "google/cloud/dataform/v1beta1"
3126
+ #
3127
+ # # Create a client object. The client can be reused for multiple calls.
3128
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
3129
+ #
3130
+ # # Create a request. To set request fields, pass in keyword arguments.
3131
+ # request = Google::Cloud::Dataform::V1beta1::QueryWorkflowInvocationActionsRequest.new
3132
+ #
3133
+ # # Call the query_workflow_invocation_actions method.
3134
+ # result = client.query_workflow_invocation_actions request
3135
+ #
3136
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3137
+ # # over elements, and API calls will be issued to fetch pages as needed.
3138
+ # result.each do |item|
3139
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction.
3140
+ # p item
3141
+ # end
3142
+ #
2539
3143
  def query_workflow_invocation_actions request, options = nil
2540
3144
  raise ::ArgumentError, "request must be provided" if request.nil?
2541
3145
 
@@ -2610,9 +3214,9 @@ module Google
2610
3214
  # * (`String`) The path to a service account key file in JSON format
2611
3215
  # * (`Hash`) A service account key as a Hash
2612
3216
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2613
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
3217
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2614
3218
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2615
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
3219
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2616
3220
  # * (`nil`) indicating no credentials
2617
3221
  # @return [::Object]
2618
3222
  # @!attribute [rw] scope
@@ -2645,7 +3249,9 @@ module Google
2645
3249
  class Configuration
2646
3250
  extend ::Gapic::Config
2647
3251
 
2648
- config_attr :endpoint, "dataform.googleapis.com", ::String
3252
+ DEFAULT_ENDPOINT = "dataform.googleapis.com"
3253
+
3254
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2649
3255
  config_attr :credentials, nil do |value|
2650
3256
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2651
3257
  allowed.any? { |klass| klass === value }