google-cloud-dataform-v1beta1 0.9.0 → 0.11.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.
@@ -240,8 +240,9 @@ module Google
240
240
  # Optional. Page token received from a previous `ListRepositories` call.
241
241
  # Provide this to retrieve the subsequent page.
242
242
  #
243
- # When paginating, all other parameters provided to `ListRepositories`
244
- # must match the call that provided the page token.
243
+ # When paginating, all other parameters provided to `ListRepositories`,
244
+ # with the exception of `page_size`, must match the call that provided the
245
+ # page token.
245
246
  # @param order_by [::String]
246
247
  # Optional. This field only supports ordering by `name`. If unspecified, the
247
248
  # server will choose the ordering. If specified, the default order is
@@ -249,10 +250,10 @@ module Google
249
250
  # @param filter [::String]
250
251
  # Optional. Filter for the returned list.
251
252
  # @yield [result, operation] Access the result along with the TransportOperation object
252
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse]
253
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>]
253
254
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
254
255
  #
255
- # @return [::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse]
256
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>]
256
257
  #
257
258
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
258
259
  #
@@ -304,7 +305,9 @@ module Google
304
305
  retry_policy: @config.retry_policy
305
306
 
306
307
  @dataform_stub.list_repositories request, options do |result, operation|
308
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_repositories, "repositories", request, result, options
307
309
  yield result, operation if block_given?
310
+ throw :response, result
308
311
  end
309
312
  rescue ::Gapic::Rest::Error => e
310
313
  raise ::Google::Cloud::Error.from_error(e)
@@ -475,6 +478,12 @@ module Google
475
478
  ##
476
479
  # Updates a single Repository.
477
480
  #
481
+ # **Note:** This method does not fully implement
482
+ # [AIP-134](https://google.aip.dev/134); in particular:
483
+ # - The wildcard entry (**\***) is treated as a bad request
484
+ # - When the **field_mask** is omitted, instead of only updating the set
485
+ # fields, the request is treated as a full update on all modifiable fields
486
+ #
478
487
  # @overload update_repository(request, options = nil)
479
488
  # Pass arguments to `update_repository` via a request object, either of type
480
489
  # {::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest} or an equivalent Hash.
@@ -574,9 +583,9 @@ module Google
574
583
  # @param name [::String]
575
584
  # Required. The repository's name.
576
585
  # @param force [::Boolean]
577
- # If set to true, any child resources of this repository will also be
578
- # deleted. (Otherwise, the request will only succeed if the repository has no
579
- # child resources.)
586
+ # Optional. If set to true, any child resources of this repository will also
587
+ # be deleted. (Otherwise, the request will only succeed if the repository has
588
+ # no child resources.)
580
589
  # @yield [result, operation] Access the result along with the TransportOperation object
581
590
  # @yieldparam result [::Google::Protobuf::Empty]
582
591
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -663,13 +672,13 @@ module Google
663
672
  # applying this commit; otherwise this request will fail. If unset, no
664
673
  # validation on the current HEAD commit SHA is performed.
665
674
  # @param file_operations [::Hash{::String => ::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation, ::Hash}]
666
- # A map to the path of the file to the operation. The path is the full file
667
- # path including filename, from repository root.
675
+ # Optional. A map to the path of the file to the operation. The path is the
676
+ # full file path including filename, from repository root.
668
677
  # @yield [result, operation] Access the result along with the TransportOperation object
669
- # @yieldparam result [::Google::Protobuf::Empty]
678
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse]
670
679
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
671
680
  #
672
- # @return [::Google::Protobuf::Empty]
681
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse]
673
682
  #
674
683
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
675
684
  #
@@ -685,7 +694,7 @@ module Google
685
694
  # # Call the commit_repository_changes method.
686
695
  # result = client.commit_repository_changes request
687
696
  #
688
- # # The returned object is of type Google::Protobuf::Empty.
697
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse.
689
698
  # p result
690
699
  #
691
700
  def commit_repository_changes request, options = nil
@@ -844,8 +853,8 @@ module Google
844
853
  # subsequent page.
845
854
  #
846
855
  # When paginating, all other parameters provided to
847
- # `QueryRepositoryDirectoryContents` must match the call that provided the
848
- # page token.
856
+ # `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must
857
+ # match the call that provided the page token.
849
858
  # @yield [result, operation] Access the result along with the TransportOperation object
850
859
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
851
860
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -939,8 +948,9 @@ module Google
939
948
  # Optional. Page token received from a previous `FetchRepositoryHistory`
940
949
  # call. Provide this to retrieve the subsequent page.
941
950
  #
942
- # When paginating, all other parameters provided to `FetchRepositoryHistory`
943
- # must match the call that provided the page token.
951
+ # When paginating, all other parameters provided to `FetchRepositoryHistory`,
952
+ # with the exception of `page_size`, must match the call that provided the
953
+ # page token.
944
954
  # @yield [result, operation] Access the result along with the TransportOperation object
945
955
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>]
946
956
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1190,8 +1200,9 @@ module Google
1190
1200
  # Optional. Page token received from a previous `ListWorkspaces` call.
1191
1201
  # Provide this to retrieve the subsequent page.
1192
1202
  #
1193
- # When paginating, all other parameters provided to `ListWorkspaces`
1194
- # must match the call that provided the page token.
1203
+ # When paginating, all other parameters provided to `ListWorkspaces`, with
1204
+ # the exception of `page_size`, must match the call that provided the page
1205
+ # token.
1195
1206
  # @param order_by [::String]
1196
1207
  # Optional. This field only supports ordering by `name`. If unspecified, the
1197
1208
  # server will choose the ordering. If specified, the default order is
@@ -1199,10 +1210,10 @@ module Google
1199
1210
  # @param filter [::String]
1200
1211
  # Optional. Filter for the returned list.
1201
1212
  # @yield [result, operation] Access the result along with the TransportOperation object
1202
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse]
1213
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>]
1203
1214
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
1204
1215
  #
1205
- # @return [::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse]
1216
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>]
1206
1217
  #
1207
1218
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1208
1219
  #
@@ -1254,7 +1265,9 @@ module Google
1254
1265
  retry_policy: @config.retry_policy
1255
1266
 
1256
1267
  @dataform_stub.list_workspaces request, options do |result, operation|
1268
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workspaces, "workspaces", request, result, options
1257
1269
  yield result, operation if block_given?
1270
+ throw :response, result
1258
1271
  end
1259
1272
  rescue ::Gapic::Rest::Error => e
1260
1273
  raise ::Google::Cloud::Error.from_error(e)
@@ -1605,10 +1618,10 @@ module Google
1605
1618
  # Required. The author of any merge commit which may be created as a result
1606
1619
  # of merging fetched Git commits into this workspace.
1607
1620
  # @yield [result, operation] Access the result along with the TransportOperation object
1608
- # @yieldparam result [::Google::Protobuf::Empty]
1621
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse]
1609
1622
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
1610
1623
  #
1611
- # @return [::Google::Protobuf::Empty]
1624
+ # @return [::Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse]
1612
1625
  #
1613
1626
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1614
1627
  #
@@ -1624,7 +1637,7 @@ module Google
1624
1637
  # # Call the pull_git_commits method.
1625
1638
  # result = client.pull_git_commits request
1626
1639
  #
1627
- # # The returned object is of type Google::Protobuf::Empty.
1640
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse.
1628
1641
  # p result
1629
1642
  #
1630
1643
  def pull_git_commits request, options = nil
@@ -1687,10 +1700,10 @@ module Google
1687
1700
  # be pushed. If left unset, the repository's default branch name will be
1688
1701
  # used.
1689
1702
  # @yield [result, operation] Access the result along with the TransportOperation object
1690
- # @yieldparam result [::Google::Protobuf::Empty]
1703
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse]
1691
1704
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
1692
1705
  #
1693
- # @return [::Google::Protobuf::Empty]
1706
+ # @return [::Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse]
1694
1707
  #
1695
1708
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1696
1709
  #
@@ -1706,7 +1719,7 @@ module Google
1706
1719
  # # Call the push_git_commits method.
1707
1720
  # result = client.push_git_commits request
1708
1721
  #
1709
- # # The returned object is of type Google::Protobuf::Empty.
1722
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse.
1710
1723
  # p result
1711
1724
  #
1712
1725
  def push_git_commits request, options = nil
@@ -1932,10 +1945,10 @@ module Google
1932
1945
  # Optional. Full file paths to commit including filename, rooted at workspace
1933
1946
  # root. If left empty, all files will be committed.
1934
1947
  # @yield [result, operation] Access the result along with the TransportOperation object
1935
- # @yieldparam result [::Google::Protobuf::Empty]
1948
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse]
1936
1949
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
1937
1950
  #
1938
- # @return [::Google::Protobuf::Empty]
1951
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse]
1939
1952
  #
1940
1953
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1941
1954
  #
@@ -1951,7 +1964,7 @@ module Google
1951
1964
  # # Call the commit_workspace_changes method.
1952
1965
  # result = client.commit_workspace_changes request
1953
1966
  #
1954
- # # The returned object is of type Google::Protobuf::Empty.
1967
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse.
1955
1968
  # p result
1956
1969
  #
1957
1970
  def commit_workspace_changes request, options = nil
@@ -2015,10 +2028,10 @@ module Google
2015
2028
  # @param clean [::Boolean]
2016
2029
  # Optional. If set to true, untracked files will be deleted.
2017
2030
  # @yield [result, operation] Access the result along with the TransportOperation object
2018
- # @yieldparam result [::Google::Protobuf::Empty]
2031
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse]
2019
2032
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2020
2033
  #
2021
- # @return [::Google::Protobuf::Empty]
2034
+ # @return [::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse]
2022
2035
  #
2023
2036
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2024
2037
  #
@@ -2034,7 +2047,7 @@ module Google
2034
2047
  # # Call the reset_workspace_changes method.
2035
2048
  # result = client.reset_workspace_changes request
2036
2049
  #
2037
- # # The returned object is of type Google::Protobuf::Empty.
2050
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse.
2038
2051
  # p result
2039
2052
  #
2040
2053
  def reset_workspace_changes request, options = nil
@@ -2185,8 +2198,8 @@ module Google
2185
2198
  # call. Provide this to retrieve the subsequent page.
2186
2199
  #
2187
2200
  # When paginating, all other parameters provided to
2188
- # `QueryDirectoryContents` must match the call that provided the page
2189
- # token.
2201
+ # `QueryDirectoryContents`, with the exception of `page_size`, must match the
2202
+ # call that provided the page token.
2190
2203
  # @yield [result, operation] Access the result along with the TransportOperation object
2191
2204
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
2192
2205
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2251,6 +2264,105 @@ module Google
2251
2264
  raise ::Google::Cloud::Error.from_error(e)
2252
2265
  end
2253
2266
 
2267
+ ##
2268
+ # Finds the contents of a given Workspace directory by filter.
2269
+ #
2270
+ # @overload search_files(request, options = nil)
2271
+ # Pass arguments to `search_files` via a request object, either of type
2272
+ # {::Google::Cloud::Dataform::V1beta1::SearchFilesRequest} or an equivalent Hash.
2273
+ #
2274
+ # @param request [::Google::Cloud::Dataform::V1beta1::SearchFilesRequest, ::Hash]
2275
+ # A request object representing the call parameters. Required. To specify no
2276
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2277
+ # @param options [::Gapic::CallOptions, ::Hash]
2278
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2279
+ #
2280
+ # @overload search_files(workspace: nil, page_size: nil, page_token: nil, filter: nil)
2281
+ # Pass arguments to `search_files` via keyword arguments. Note that at
2282
+ # least one keyword argument is required. To specify no parameters, or to keep all
2283
+ # the default parameter values, pass an empty Hash as a request object (see above).
2284
+ #
2285
+ # @param workspace [::String]
2286
+ # Required. The workspace's name.
2287
+ # @param page_size [::Integer]
2288
+ # Optional. Maximum number of search results to return. The server may return
2289
+ # fewer items than requested. If unspecified, the server will pick an
2290
+ # appropriate default.
2291
+ # @param page_token [::String]
2292
+ # Optional. Page token received from a previous `SearchFilesRequest`
2293
+ # call. Provide this to retrieve the subsequent page.
2294
+ #
2295
+ # When paginating, all other parameters provided to `SearchFilesRequest`,
2296
+ # with the exception of `page_size`, must match the call that provided the
2297
+ # page token.
2298
+ # @param filter [::String]
2299
+ # Optional. Optional filter for the returned list in filtering format.
2300
+ # Filtering is only currently supported on the `path` field.
2301
+ # See https://google.aip.dev/160 for details.
2302
+ # @yield [result, operation] Access the result along with the TransportOperation object
2303
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::SearchResult>]
2304
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2305
+ #
2306
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::SearchResult>]
2307
+ #
2308
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2309
+ #
2310
+ # @example Basic example
2311
+ # require "google/cloud/dataform/v1beta1"
2312
+ #
2313
+ # # Create a client object. The client can be reused for multiple calls.
2314
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
2315
+ #
2316
+ # # Create a request. To set request fields, pass in keyword arguments.
2317
+ # request = Google::Cloud::Dataform::V1beta1::SearchFilesRequest.new
2318
+ #
2319
+ # # Call the search_files method.
2320
+ # result = client.search_files request
2321
+ #
2322
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2323
+ # # over elements, and API calls will be issued to fetch pages as needed.
2324
+ # result.each do |item|
2325
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::SearchResult.
2326
+ # p item
2327
+ # end
2328
+ #
2329
+ def search_files request, options = nil
2330
+ raise ::ArgumentError, "request must be provided" if request.nil?
2331
+
2332
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::SearchFilesRequest
2333
+
2334
+ # Converts hash and nil to an options object
2335
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2336
+
2337
+ # Customize the options with defaults
2338
+ call_metadata = @config.rpcs.search_files.metadata.to_h
2339
+
2340
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2341
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2342
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2343
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION,
2344
+ transports_version_send: [:rest]
2345
+
2346
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2347
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2348
+
2349
+ options.apply_defaults timeout: @config.rpcs.search_files.timeout,
2350
+ metadata: call_metadata,
2351
+ retry_policy: @config.rpcs.search_files.retry_policy
2352
+
2353
+ options.apply_defaults timeout: @config.timeout,
2354
+ metadata: @config.metadata,
2355
+ retry_policy: @config.retry_policy
2356
+
2357
+ @dataform_stub.search_files request, options do |result, operation|
2358
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :search_files, "search_results", request, result, options
2359
+ yield result, operation if block_given?
2360
+ throw :response, result
2361
+ end
2362
+ rescue ::Gapic::Rest::Error => e
2363
+ raise ::Google::Cloud::Error.from_error(e)
2364
+ end
2365
+
2254
2366
  ##
2255
2367
  # Creates a directory inside a Workspace.
2256
2368
  #
@@ -2356,10 +2468,10 @@ module Google
2356
2468
  # Required. The directory's full path including directory name, relative to
2357
2469
  # the workspace root.
2358
2470
  # @yield [result, operation] Access the result along with the TransportOperation object
2359
- # @yieldparam result [::Google::Protobuf::Empty]
2471
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse]
2360
2472
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2361
2473
  #
2362
- # @return [::Google::Protobuf::Empty]
2474
+ # @return [::Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse]
2363
2475
  #
2364
2476
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2365
2477
  #
@@ -2375,7 +2487,7 @@ module Google
2375
2487
  # # Call the remove_directory method.
2376
2488
  # result = client.remove_directory request
2377
2489
  #
2378
- # # The returned object is of type Google::Protobuf::Empty.
2490
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse.
2379
2491
  # p result
2380
2492
  #
2381
2493
  def remove_directory request, options = nil
@@ -2511,7 +2623,7 @@ module Google
2511
2623
  # @param options [::Gapic::CallOptions, ::Hash]
2512
2624
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2513
2625
  #
2514
- # @overload read_file(workspace: nil, path: nil)
2626
+ # @overload read_file(workspace: nil, path: nil, revision: nil)
2515
2627
  # Pass arguments to `read_file` via keyword arguments. Note that at
2516
2628
  # least one keyword argument is required. To specify no parameters, or to keep all
2517
2629
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2521,6 +2633,9 @@ module Google
2521
2633
  # @param path [::String]
2522
2634
  # Required. The file's full path including filename, relative to the
2523
2635
  # workspace root.
2636
+ # @param revision [::String]
2637
+ # Optional. The Git revision of the file to return. If left empty, the
2638
+ # current contents of `path` will be returned.
2524
2639
  # @yield [result, operation] Access the result along with the TransportOperation object
2525
2640
  # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ReadFileResponse]
2526
2641
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2603,10 +2718,10 @@ module Google
2603
2718
  # Required. The file's full path including filename, relative to the
2604
2719
  # workspace root.
2605
2720
  # @yield [result, operation] Access the result along with the TransportOperation object
2606
- # @yieldparam result [::Google::Protobuf::Empty]
2721
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::RemoveFileResponse]
2607
2722
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2608
2723
  #
2609
- # @return [::Google::Protobuf::Empty]
2724
+ # @return [::Google::Cloud::Dataform::V1beta1::RemoveFileResponse]
2610
2725
  #
2611
2726
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2612
2727
  #
@@ -2622,7 +2737,7 @@ module Google
2622
2737
  # # Call the remove_file method.
2623
2738
  # result = client.remove_file request
2624
2739
  #
2625
- # # The returned object is of type Google::Protobuf::Empty.
2740
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::RemoveFileResponse.
2626
2741
  # p result
2627
2742
  #
2628
2743
  def remove_file request, options = nil
@@ -2855,13 +2970,14 @@ module Google
2855
2970
  # Optional. Page token received from a previous `ListReleaseConfigs` call.
2856
2971
  # Provide this to retrieve the subsequent page.
2857
2972
  #
2858
- # When paginating, all other parameters provided to `ListReleaseConfigs`
2859
- # must match the call that provided the page token.
2973
+ # When paginating, all other parameters provided to `ListReleaseConfigs`,
2974
+ # with the exception of `page_size`, must match the call that provided the
2975
+ # page token.
2860
2976
  # @yield [result, operation] Access the result along with the TransportOperation object
2861
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse]
2977
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>]
2862
2978
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
2863
2979
  #
2864
- # @return [::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse]
2980
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>]
2865
2981
  #
2866
2982
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2867
2983
  #
@@ -2913,7 +3029,9 @@ module Google
2913
3029
  retry_policy: @config.retry_policy
2914
3030
 
2915
3031
  @dataform_stub.list_release_configs request, options do |result, operation|
3032
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_release_configs, "release_configs", request, result, options
2916
3033
  yield result, operation if block_given?
3034
+ throw :response, result
2917
3035
  end
2918
3036
  rescue ::Gapic::Rest::Error => e
2919
3037
  raise ::Google::Cloud::Error.from_error(e)
@@ -3084,6 +3202,12 @@ module Google
3084
3202
  ##
3085
3203
  # Updates a single ReleaseConfig.
3086
3204
  #
3205
+ # **Note:** This method does not fully implement
3206
+ # [AIP-134](https://google.aip.dev/134); in particular:
3207
+ # - The wildcard entry (**\***) is treated as a bad request
3208
+ # - When the **field_mask** is omitted, instead of only updating the set
3209
+ # fields, the request is treated as a full update on all modifiable fields
3210
+ #
3087
3211
  # @overload update_release_config(request, options = nil)
3088
3212
  # Pass arguments to `update_release_config` via a request object, either of type
3089
3213
  # {::Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest} or an equivalent Hash.
@@ -3253,7 +3377,7 @@ module Google
3253
3377
  # @param options [::Gapic::CallOptions, ::Hash]
3254
3378
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3255
3379
  #
3256
- # @overload list_compilation_results(parent: nil, page_size: nil, page_token: nil)
3380
+ # @overload list_compilation_results(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
3257
3381
  # Pass arguments to `list_compilation_results` via keyword arguments. Note that at
3258
3382
  # least one keyword argument is required. To specify no parameters, or to keep all
3259
3383
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3269,13 +3393,20 @@ module Google
3269
3393
  # Optional. Page token received from a previous `ListCompilationResults`
3270
3394
  # call. Provide this to retrieve the subsequent page.
3271
3395
  #
3272
- # When paginating, all other parameters provided to `ListCompilationResults`
3273
- # must match the call that provided the page token.
3396
+ # When paginating, all other parameters provided to `ListCompilationResults`,
3397
+ # with the exception of `page_size`, must match the call that provided the
3398
+ # page token.
3399
+ # @param order_by [::String]
3400
+ # Optional. This field only supports ordering by `name` and `create_time`.
3401
+ # If unspecified, the server will choose the ordering.
3402
+ # If specified, the default order is ascending for the `name` field.
3403
+ # @param filter [::String]
3404
+ # Optional. Filter for the returned list.
3274
3405
  # @yield [result, operation] Access the result along with the TransportOperation object
3275
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse]
3406
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>]
3276
3407
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
3277
3408
  #
3278
- # @return [::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse]
3409
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>]
3279
3410
  #
3280
3411
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3281
3412
  #
@@ -3327,7 +3458,9 @@ module Google
3327
3458
  retry_policy: @config.retry_policy
3328
3459
 
3329
3460
  @dataform_stub.list_compilation_results request, options do |result, operation|
3461
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_compilation_results, "compilation_results", request, result, options
3330
3462
  yield result, operation if block_given?
3463
+ throw :response, result
3331
3464
  end
3332
3465
  rescue ::Gapic::Rest::Error => e
3333
3466
  raise ::Google::Cloud::Error.from_error(e)
@@ -3522,8 +3655,8 @@ module Google
3522
3655
  # subsequent page.
3523
3656
  #
3524
3657
  # When paginating, all other parameters provided to
3525
- # `QueryCompilationResultActions` must match the call that provided the page
3526
- # token.
3658
+ # `QueryCompilationResultActions`, with the exception of `page_size`, must
3659
+ # match the call that provided the page token.
3527
3660
  # @param filter [::String]
3528
3661
  # Optional. Optional filter for the returned list. Filtering is only
3529
3662
  # currently supported on the `file_path` field.
@@ -3620,13 +3753,14 @@ module Google
3620
3753
  # Optional. Page token received from a previous `ListWorkflowConfigs` call.
3621
3754
  # Provide this to retrieve the subsequent page.
3622
3755
  #
3623
- # When paginating, all other parameters provided to `ListWorkflowConfigs`
3624
- # must match the call that provided the page token.
3756
+ # When paginating, all other parameters provided to `ListWorkflowConfigs`,
3757
+ # with the exception of `page_size`, must match the call that provided the
3758
+ # page token.
3625
3759
  # @yield [result, operation] Access the result along with the TransportOperation object
3626
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse]
3760
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>]
3627
3761
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
3628
3762
  #
3629
- # @return [::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse]
3763
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>]
3630
3764
  #
3631
3765
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3632
3766
  #
@@ -3678,7 +3812,9 @@ module Google
3678
3812
  retry_policy: @config.retry_policy
3679
3813
 
3680
3814
  @dataform_stub.list_workflow_configs request, options do |result, operation|
3815
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workflow_configs, "workflow_configs", request, result, options
3681
3816
  yield result, operation if block_given?
3817
+ throw :response, result
3682
3818
  end
3683
3819
  rescue ::Gapic::Rest::Error => e
3684
3820
  raise ::Google::Cloud::Error.from_error(e)
@@ -3849,6 +3985,12 @@ module Google
3849
3985
  ##
3850
3986
  # Updates a single WorkflowConfig.
3851
3987
  #
3988
+ # **Note:** This method does not fully implement
3989
+ # [AIP-134](https://google.aip.dev/134); in particular:
3990
+ # - The wildcard entry (**\***) is treated as a bad request
3991
+ # - When the **field_mask** is omitted, instead of only updating the set
3992
+ # fields, the request is treated as a full update on all modifiable fields
3993
+ #
3852
3994
  # @overload update_workflow_config(request, options = nil)
3853
3995
  # Pass arguments to `update_workflow_config` via a request object, either of type
3854
3996
  # {::Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest} or an equivalent Hash.
@@ -4034,8 +4176,9 @@ module Google
4034
4176
  # Optional. Page token received from a previous `ListWorkflowInvocations`
4035
4177
  # call. Provide this to retrieve the subsequent page.
4036
4178
  #
4037
- # When paginating, all other parameters provided to `ListWorkflowInvocations`
4038
- # must match the call that provided the page token.
4179
+ # When paginating, all other parameters provided to
4180
+ # `ListWorkflowInvocations`, with the exception of `page_size`, must match
4181
+ # the call that provided the page token.
4039
4182
  # @param order_by [::String]
4040
4183
  # Optional. This field only supports ordering by `name`. If unspecified, the
4041
4184
  # server will choose the ordering. If specified, the default order is
@@ -4043,10 +4186,10 @@ module Google
4043
4186
  # @param filter [::String]
4044
4187
  # Optional. Filter for the returned list.
4045
4188
  # @yield [result, operation] Access the result along with the TransportOperation object
4046
- # @yieldparam result [::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse]
4189
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>]
4047
4190
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
4048
4191
  #
4049
- # @return [::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse]
4192
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>]
4050
4193
  #
4051
4194
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
4052
4195
  #
@@ -4098,7 +4241,9 @@ module Google
4098
4241
  retry_policy: @config.retry_policy
4099
4242
 
4100
4243
  @dataform_stub.list_workflow_invocations request, options do |result, operation|
4244
+ result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workflow_invocations, "workflow_invocations", request, result, options
4101
4245
  yield result, operation if block_given?
4246
+ throw :response, result
4102
4247
  end
4103
4248
  rescue ::Gapic::Rest::Error => e
4104
4249
  raise ::Google::Cloud::Error.from_error(e)
@@ -4362,10 +4507,10 @@ module Google
4362
4507
  # @param name [::String]
4363
4508
  # Required. The workflow invocation resource's name.
4364
4509
  # @yield [result, operation] Access the result along with the TransportOperation object
4365
- # @yieldparam result [::Google::Protobuf::Empty]
4510
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse]
4366
4511
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
4367
4512
  #
4368
- # @return [::Google::Protobuf::Empty]
4513
+ # @return [::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse]
4369
4514
  #
4370
4515
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
4371
4516
  #
@@ -4381,7 +4526,7 @@ module Google
4381
4526
  # # Call the cancel_workflow_invocation method.
4382
4527
  # result = client.cancel_workflow_invocation request
4383
4528
  #
4384
- # # The returned object is of type Google::Protobuf::Empty.
4529
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse.
4385
4530
  # p result
4386
4531
  #
4387
4532
  def cancel_workflow_invocation request, options = nil
@@ -4449,8 +4594,8 @@ module Google
4449
4594
  # subsequent page.
4450
4595
  #
4451
4596
  # When paginating, all other parameters provided to
4452
- # `QueryWorkflowInvocationActions` must match the call that provided the page
4453
- # token.
4597
+ # `QueryWorkflowInvocationActions`, with the exception of `page_size`, must
4598
+ # match the call that provided the page token.
4454
4599
  # @yield [result, operation] Access the result along with the TransportOperation object
4455
4600
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>]
4456
4601
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -4515,6 +4660,170 @@ module Google
4515
4660
  raise ::Google::Cloud::Error.from_error(e)
4516
4661
  end
4517
4662
 
4663
+ ##
4664
+ # Get default config for a given project and location.
4665
+ #
4666
+ # @overload get_config(request, options = nil)
4667
+ # Pass arguments to `get_config` via a request object, either of type
4668
+ # {::Google::Cloud::Dataform::V1beta1::GetConfigRequest} or an equivalent Hash.
4669
+ #
4670
+ # @param request [::Google::Cloud::Dataform::V1beta1::GetConfigRequest, ::Hash]
4671
+ # A request object representing the call parameters. Required. To specify no
4672
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4673
+ # @param options [::Gapic::CallOptions, ::Hash]
4674
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
4675
+ #
4676
+ # @overload get_config(name: nil)
4677
+ # Pass arguments to `get_config` via keyword arguments. Note that at
4678
+ # least one keyword argument is required. To specify no parameters, or to keep all
4679
+ # the default parameter values, pass an empty Hash as a request object (see above).
4680
+ #
4681
+ # @param name [::String]
4682
+ # Required. The config name.
4683
+ # @yield [result, operation] Access the result along with the TransportOperation object
4684
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::Config]
4685
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
4686
+ #
4687
+ # @return [::Google::Cloud::Dataform::V1beta1::Config]
4688
+ #
4689
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
4690
+ #
4691
+ # @example Basic example
4692
+ # require "google/cloud/dataform/v1beta1"
4693
+ #
4694
+ # # Create a client object. The client can be reused for multiple calls.
4695
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
4696
+ #
4697
+ # # Create a request. To set request fields, pass in keyword arguments.
4698
+ # request = Google::Cloud::Dataform::V1beta1::GetConfigRequest.new
4699
+ #
4700
+ # # Call the get_config method.
4701
+ # result = client.get_config request
4702
+ #
4703
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Config.
4704
+ # p result
4705
+ #
4706
+ def get_config request, options = nil
4707
+ raise ::ArgumentError, "request must be provided" if request.nil?
4708
+
4709
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetConfigRequest
4710
+
4711
+ # Converts hash and nil to an options object
4712
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4713
+
4714
+ # Customize the options with defaults
4715
+ call_metadata = @config.rpcs.get_config.metadata.to_h
4716
+
4717
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
4718
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4719
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4720
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION,
4721
+ transports_version_send: [:rest]
4722
+
4723
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
4724
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4725
+
4726
+ options.apply_defaults timeout: @config.rpcs.get_config.timeout,
4727
+ metadata: call_metadata,
4728
+ retry_policy: @config.rpcs.get_config.retry_policy
4729
+
4730
+ options.apply_defaults timeout: @config.timeout,
4731
+ metadata: @config.metadata,
4732
+ retry_policy: @config.retry_policy
4733
+
4734
+ @dataform_stub.get_config request, options do |result, operation|
4735
+ yield result, operation if block_given?
4736
+ end
4737
+ rescue ::Gapic::Rest::Error => e
4738
+ raise ::Google::Cloud::Error.from_error(e)
4739
+ end
4740
+
4741
+ ##
4742
+ # Update default config for a given project and location.
4743
+ #
4744
+ # **Note:** This method does not fully implement
4745
+ # [AIP-134](https://google.aip.dev/134); in particular:
4746
+ # - The wildcard entry (**\***) is treated as a bad request
4747
+ # - When the **field_mask** is omitted, instead of only updating the set
4748
+ # fields, the request is treated as a full update on all modifiable fields
4749
+ #
4750
+ # @overload update_config(request, options = nil)
4751
+ # Pass arguments to `update_config` via a request object, either of type
4752
+ # {::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest} or an equivalent Hash.
4753
+ #
4754
+ # @param request [::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest, ::Hash]
4755
+ # A request object representing the call parameters. Required. To specify no
4756
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4757
+ # @param options [::Gapic::CallOptions, ::Hash]
4758
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
4759
+ #
4760
+ # @overload update_config(config: nil, update_mask: nil)
4761
+ # Pass arguments to `update_config` via keyword arguments. Note that at
4762
+ # least one keyword argument is required. To specify no parameters, or to keep all
4763
+ # the default parameter values, pass an empty Hash as a request object (see above).
4764
+ #
4765
+ # @param config [::Google::Cloud::Dataform::V1beta1::Config, ::Hash]
4766
+ # Required. The config to update.
4767
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
4768
+ # Optional. Specifies the fields to be updated in the config.
4769
+ # @yield [result, operation] Access the result along with the TransportOperation object
4770
+ # @yieldparam result [::Google::Cloud::Dataform::V1beta1::Config]
4771
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
4772
+ #
4773
+ # @return [::Google::Cloud::Dataform::V1beta1::Config]
4774
+ #
4775
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
4776
+ #
4777
+ # @example Basic example
4778
+ # require "google/cloud/dataform/v1beta1"
4779
+ #
4780
+ # # Create a client object. The client can be reused for multiple calls.
4781
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new
4782
+ #
4783
+ # # Create a request. To set request fields, pass in keyword arguments.
4784
+ # request = Google::Cloud::Dataform::V1beta1::UpdateConfigRequest.new
4785
+ #
4786
+ # # Call the update_config method.
4787
+ # result = client.update_config request
4788
+ #
4789
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Config.
4790
+ # p result
4791
+ #
4792
+ def update_config request, options = nil
4793
+ raise ::ArgumentError, "request must be provided" if request.nil?
4794
+
4795
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest
4796
+
4797
+ # Converts hash and nil to an options object
4798
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4799
+
4800
+ # Customize the options with defaults
4801
+ call_metadata = @config.rpcs.update_config.metadata.to_h
4802
+
4803
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
4804
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4805
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4806
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION,
4807
+ transports_version_send: [:rest]
4808
+
4809
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
4810
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4811
+
4812
+ options.apply_defaults timeout: @config.rpcs.update_config.timeout,
4813
+ metadata: call_metadata,
4814
+ retry_policy: @config.rpcs.update_config.retry_policy
4815
+
4816
+ options.apply_defaults timeout: @config.timeout,
4817
+ metadata: @config.metadata,
4818
+ retry_policy: @config.retry_policy
4819
+
4820
+ @dataform_stub.update_config request, options do |result, operation|
4821
+ yield result, operation if block_given?
4822
+ end
4823
+ rescue ::Gapic::Rest::Error => e
4824
+ raise ::Google::Cloud::Error.from_error(e)
4825
+ end
4826
+
4518
4827
  ##
4519
4828
  # Configuration class for the Dataform REST API.
4520
4829
  #
@@ -4789,6 +5098,11 @@ module Google
4789
5098
  #
4790
5099
  attr_reader :query_directory_contents
4791
5100
  ##
5101
+ # RPC-specific configuration for `search_files`
5102
+ # @return [::Gapic::Config::Method]
5103
+ #
5104
+ attr_reader :search_files
5105
+ ##
4792
5106
  # RPC-specific configuration for `make_directory`
4793
5107
  # @return [::Gapic::Config::Method]
4794
5108
  #
@@ -4923,6 +5237,16 @@ module Google
4923
5237
  # @return [::Gapic::Config::Method]
4924
5238
  #
4925
5239
  attr_reader :query_workflow_invocation_actions
5240
+ ##
5241
+ # RPC-specific configuration for `get_config`
5242
+ # @return [::Gapic::Config::Method]
5243
+ #
5244
+ attr_reader :get_config
5245
+ ##
5246
+ # RPC-specific configuration for `update_config`
5247
+ # @return [::Gapic::Config::Method]
5248
+ #
5249
+ attr_reader :update_config
4926
5250
 
4927
5251
  # @private
4928
5252
  def initialize parent_rpcs = nil
@@ -4974,6 +5298,8 @@ module Google
4974
5298
  @fetch_file_diff = ::Gapic::Config::Method.new fetch_file_diff_config
4975
5299
  query_directory_contents_config = parent_rpcs.query_directory_contents if parent_rpcs.respond_to? :query_directory_contents
4976
5300
  @query_directory_contents = ::Gapic::Config::Method.new query_directory_contents_config
5301
+ search_files_config = parent_rpcs.search_files if parent_rpcs.respond_to? :search_files
5302
+ @search_files = ::Gapic::Config::Method.new search_files_config
4977
5303
  make_directory_config = parent_rpcs.make_directory if parent_rpcs.respond_to? :make_directory
4978
5304
  @make_directory = ::Gapic::Config::Method.new make_directory_config
4979
5305
  remove_directory_config = parent_rpcs.remove_directory if parent_rpcs.respond_to? :remove_directory
@@ -5028,6 +5354,10 @@ module Google
5028
5354
  @cancel_workflow_invocation = ::Gapic::Config::Method.new cancel_workflow_invocation_config
5029
5355
  query_workflow_invocation_actions_config = parent_rpcs.query_workflow_invocation_actions if parent_rpcs.respond_to? :query_workflow_invocation_actions
5030
5356
  @query_workflow_invocation_actions = ::Gapic::Config::Method.new query_workflow_invocation_actions_config
5357
+ get_config_config = parent_rpcs.get_config if parent_rpcs.respond_to? :get_config
5358
+ @get_config = ::Gapic::Config::Method.new get_config_config
5359
+ update_config_config = parent_rpcs.update_config if parent_rpcs.respond_to? :update_config
5360
+ @update_config = ::Gapic::Config::Method.new update_config_config
5031
5361
 
5032
5362
  yield self if block_given?
5033
5363
  end