google-cloud-dataform-v1beta1 0.10.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.
@@ -245,8 +245,9 @@ module Google
245
245
  # Optional. Page token received from a previous `ListRepositories` call.
246
246
  # Provide this to retrieve the subsequent page.
247
247
  #
248
- # When paginating, all other parameters provided to `ListRepositories`
249
- # must match the call that provided the page token.
248
+ # When paginating, all other parameters provided to `ListRepositories`,
249
+ # with the exception of `page_size`, must match the call that provided the
250
+ # page token.
250
251
  # @param order_by [::String]
251
252
  # Optional. This field only supports ordering by `name`. If unspecified, the
252
253
  # server will choose the ordering. If specified, the default order is
@@ -503,6 +504,12 @@ module Google
503
504
  ##
504
505
  # Updates a single Repository.
505
506
  #
507
+ # **Note:** This method does not fully implement
508
+ # [AIP-134](https://google.aip.dev/134); in particular:
509
+ # - The wildcard entry (**\***) is treated as a bad request
510
+ # - When the **field_mask** is omitted, instead of only updating the set
511
+ # fields, the request is treated as a full update on all modifiable fields
512
+ #
506
513
  # @overload update_repository(request, options = nil)
507
514
  # Pass arguments to `update_repository` via a request object, either of type
508
515
  # {::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest} or an equivalent Hash.
@@ -609,9 +616,9 @@ module Google
609
616
  # @param name [::String]
610
617
  # Required. The repository's name.
611
618
  # @param force [::Boolean]
612
- # If set to true, any child resources of this repository will also be
613
- # deleted. (Otherwise, the request will only succeed if the repository has no
614
- # child resources.)
619
+ # Optional. If set to true, any child resources of this repository will also
620
+ # be deleted. (Otherwise, the request will only succeed if the repository has
621
+ # no child resources.)
615
622
  #
616
623
  # @yield [response, operation] Access the result along with the RPC operation
617
624
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -705,14 +712,14 @@ module Google
705
712
  # applying this commit; otherwise this request will fail. If unset, no
706
713
  # validation on the current HEAD commit SHA is performed.
707
714
  # @param file_operations [::Hash{::String => ::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation, ::Hash}]
708
- # A map to the path of the file to the operation. The path is the full file
709
- # path including filename, from repository root.
715
+ # Optional. A map to the path of the file to the operation. The path is the
716
+ # full file path including filename, from repository root.
710
717
  #
711
718
  # @yield [response, operation] Access the result along with the RPC operation
712
- # @yieldparam response [::Google::Protobuf::Empty]
719
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse]
713
720
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
714
721
  #
715
- # @return [::Google::Protobuf::Empty]
722
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse]
716
723
  #
717
724
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
718
725
  #
@@ -728,7 +735,7 @@ module Google
728
735
  # # Call the commit_repository_changes method.
729
736
  # result = client.commit_repository_changes request
730
737
  #
731
- # # The returned object is of type Google::Protobuf::Empty.
738
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesResponse.
732
739
  # p result
733
740
  #
734
741
  def commit_repository_changes request, options = nil
@@ -900,8 +907,8 @@ module Google
900
907
  # subsequent page.
901
908
  #
902
909
  # When paginating, all other parameters provided to
903
- # `QueryRepositoryDirectoryContents` must match the call that provided the
904
- # page token.
910
+ # `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must
911
+ # match the call that provided the page token.
905
912
  #
906
913
  # @yield [response, operation] Access the result along with the RPC operation
907
914
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
@@ -1002,8 +1009,9 @@ module Google
1002
1009
  # Optional. Page token received from a previous `FetchRepositoryHistory`
1003
1010
  # call. Provide this to retrieve the subsequent page.
1004
1011
  #
1005
- # When paginating, all other parameters provided to `FetchRepositoryHistory`
1006
- # must match the call that provided the page token.
1012
+ # When paginating, all other parameters provided to `FetchRepositoryHistory`,
1013
+ # with the exception of `page_size`, must match the call that provided the
1014
+ # page token.
1007
1015
  #
1008
1016
  # @yield [response, operation] Access the result along with the RPC operation
1009
1017
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>]
@@ -1274,8 +1282,9 @@ module Google
1274
1282
  # Optional. Page token received from a previous `ListWorkspaces` call.
1275
1283
  # Provide this to retrieve the subsequent page.
1276
1284
  #
1277
- # When paginating, all other parameters provided to `ListWorkspaces`
1278
- # must match the call that provided the page token.
1285
+ # When paginating, all other parameters provided to `ListWorkspaces`, with
1286
+ # the exception of `page_size`, must match the call that provided the page
1287
+ # token.
1279
1288
  # @param order_by [::String]
1280
1289
  # Optional. This field only supports ordering by `name`. If unspecified, the
1281
1290
  # server will choose the ordering. If specified, the default order is
@@ -1727,10 +1736,10 @@ module Google
1727
1736
  # of merging fetched Git commits into this workspace.
1728
1737
  #
1729
1738
  # @yield [response, operation] Access the result along with the RPC operation
1730
- # @yieldparam response [::Google::Protobuf::Empty]
1739
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse]
1731
1740
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
1732
1741
  #
1733
- # @return [::Google::Protobuf::Empty]
1742
+ # @return [::Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse]
1734
1743
  #
1735
1744
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1736
1745
  #
@@ -1746,7 +1755,7 @@ module Google
1746
1755
  # # Call the pull_git_commits method.
1747
1756
  # result = client.pull_git_commits request
1748
1757
  #
1749
- # # The returned object is of type Google::Protobuf::Empty.
1758
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::PullGitCommitsResponse.
1750
1759
  # p result
1751
1760
  #
1752
1761
  def pull_git_commits request, options = nil
@@ -1816,10 +1825,10 @@ module Google
1816
1825
  # used.
1817
1826
  #
1818
1827
  # @yield [response, operation] Access the result along with the RPC operation
1819
- # @yieldparam response [::Google::Protobuf::Empty]
1828
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse]
1820
1829
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
1821
1830
  #
1822
- # @return [::Google::Protobuf::Empty]
1831
+ # @return [::Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse]
1823
1832
  #
1824
1833
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
1825
1834
  #
@@ -1835,7 +1844,7 @@ module Google
1835
1844
  # # Call the push_git_commits method.
1836
1845
  # result = client.push_git_commits request
1837
1846
  #
1838
- # # The returned object is of type Google::Protobuf::Empty.
1847
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::PushGitCommitsResponse.
1839
1848
  # p result
1840
1849
  #
1841
1850
  def push_git_commits request, options = nil
@@ -2082,10 +2091,10 @@ module Google
2082
2091
  # root. If left empty, all files will be committed.
2083
2092
  #
2084
2093
  # @yield [response, operation] Access the result along with the RPC operation
2085
- # @yieldparam response [::Google::Protobuf::Empty]
2094
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse]
2086
2095
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2087
2096
  #
2088
- # @return [::Google::Protobuf::Empty]
2097
+ # @return [::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse]
2089
2098
  #
2090
2099
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2091
2100
  #
@@ -2101,7 +2110,7 @@ module Google
2101
2110
  # # Call the commit_workspace_changes method.
2102
2111
  # result = client.commit_workspace_changes request
2103
2112
  #
2104
- # # The returned object is of type Google::Protobuf::Empty.
2113
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesResponse.
2105
2114
  # p result
2106
2115
  #
2107
2116
  def commit_workspace_changes request, options = nil
@@ -2172,10 +2181,10 @@ module Google
2172
2181
  # Optional. If set to true, untracked files will be deleted.
2173
2182
  #
2174
2183
  # @yield [response, operation] Access the result along with the RPC operation
2175
- # @yieldparam response [::Google::Protobuf::Empty]
2184
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse]
2176
2185
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2177
2186
  #
2178
- # @return [::Google::Protobuf::Empty]
2187
+ # @return [::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse]
2179
2188
  #
2180
2189
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2181
2190
  #
@@ -2191,7 +2200,7 @@ module Google
2191
2200
  # # Call the reset_workspace_changes method.
2192
2201
  # result = client.reset_workspace_changes request
2193
2202
  #
2194
- # # The returned object is of type Google::Protobuf::Empty.
2203
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesResponse.
2195
2204
  # p result
2196
2205
  #
2197
2206
  def reset_workspace_changes request, options = nil
@@ -2355,8 +2364,8 @@ module Google
2355
2364
  # call. Provide this to retrieve the subsequent page.
2356
2365
  #
2357
2366
  # When paginating, all other parameters provided to
2358
- # `QueryDirectoryContents` must match the call that provided the page
2359
- # token.
2367
+ # `QueryDirectoryContents`, with the exception of `page_size`, must match the
2368
+ # call that provided the page token.
2360
2369
  #
2361
2370
  # @yield [response, operation] Access the result along with the RPC operation
2362
2371
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>]
@@ -2428,6 +2437,112 @@ module Google
2428
2437
  raise ::Google::Cloud::Error.from_error(e)
2429
2438
  end
2430
2439
 
2440
+ ##
2441
+ # Finds the contents of a given Workspace directory by filter.
2442
+ #
2443
+ # @overload search_files(request, options = nil)
2444
+ # Pass arguments to `search_files` via a request object, either of type
2445
+ # {::Google::Cloud::Dataform::V1beta1::SearchFilesRequest} or an equivalent Hash.
2446
+ #
2447
+ # @param request [::Google::Cloud::Dataform::V1beta1::SearchFilesRequest, ::Hash]
2448
+ # A request object representing the call parameters. Required. To specify no
2449
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2450
+ # @param options [::Gapic::CallOptions, ::Hash]
2451
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2452
+ #
2453
+ # @overload search_files(workspace: nil, page_size: nil, page_token: nil, filter: nil)
2454
+ # Pass arguments to `search_files` via keyword arguments. Note that at
2455
+ # least one keyword argument is required. To specify no parameters, or to keep all
2456
+ # the default parameter values, pass an empty Hash as a request object (see above).
2457
+ #
2458
+ # @param workspace [::String]
2459
+ # Required. The workspace's name.
2460
+ # @param page_size [::Integer]
2461
+ # Optional. Maximum number of search results to return. The server may return
2462
+ # fewer items than requested. If unspecified, the server will pick an
2463
+ # appropriate default.
2464
+ # @param page_token [::String]
2465
+ # Optional. Page token received from a previous `SearchFilesRequest`
2466
+ # call. Provide this to retrieve the subsequent page.
2467
+ #
2468
+ # When paginating, all other parameters provided to `SearchFilesRequest`,
2469
+ # with the exception of `page_size`, must match the call that provided the
2470
+ # page token.
2471
+ # @param filter [::String]
2472
+ # Optional. Optional filter for the returned list in filtering format.
2473
+ # Filtering is only currently supported on the `path` field.
2474
+ # See https://google.aip.dev/160 for details.
2475
+ #
2476
+ # @yield [response, operation] Access the result along with the RPC operation
2477
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::SearchResult>]
2478
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2479
+ #
2480
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::SearchResult>]
2481
+ #
2482
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2483
+ #
2484
+ # @example Basic example
2485
+ # require "google/cloud/dataform/v1beta1"
2486
+ #
2487
+ # # Create a client object. The client can be reused for multiple calls.
2488
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new
2489
+ #
2490
+ # # Create a request. To set request fields, pass in keyword arguments.
2491
+ # request = Google::Cloud::Dataform::V1beta1::SearchFilesRequest.new
2492
+ #
2493
+ # # Call the search_files method.
2494
+ # result = client.search_files request
2495
+ #
2496
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2497
+ # # over elements, and API calls will be issued to fetch pages as needed.
2498
+ # result.each do |item|
2499
+ # # Each element is of type ::Google::Cloud::Dataform::V1beta1::SearchResult.
2500
+ # p item
2501
+ # end
2502
+ #
2503
+ def search_files request, options = nil
2504
+ raise ::ArgumentError, "request must be provided" if request.nil?
2505
+
2506
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::SearchFilesRequest
2507
+
2508
+ # Converts hash and nil to an options object
2509
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2510
+
2511
+ # Customize the options with defaults
2512
+ metadata = @config.rpcs.search_files.metadata.to_h
2513
+
2514
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2515
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2516
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2517
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
2518
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2519
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2520
+
2521
+ header_params = {}
2522
+ if request.workspace
2523
+ header_params["workspace"] = request.workspace
2524
+ end
2525
+
2526
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2527
+ metadata[:"x-goog-request-params"] ||= request_params_header
2528
+
2529
+ options.apply_defaults timeout: @config.rpcs.search_files.timeout,
2530
+ metadata: metadata,
2531
+ retry_policy: @config.rpcs.search_files.retry_policy
2532
+
2533
+ options.apply_defaults timeout: @config.timeout,
2534
+ metadata: @config.metadata,
2535
+ retry_policy: @config.retry_policy
2536
+
2537
+ @dataform_stub.call_rpc :search_files, request, options: options do |response, operation|
2538
+ response = ::Gapic::PagedEnumerable.new @dataform_stub, :search_files, request, response, operation, options
2539
+ yield response, operation if block_given?
2540
+ throw :response, response
2541
+ end
2542
+ rescue ::GRPC::BadStatus => e
2543
+ raise ::Google::Cloud::Error.from_error(e)
2544
+ end
2545
+
2431
2546
  ##
2432
2547
  # Creates a directory inside a Workspace.
2433
2548
  #
@@ -2541,10 +2656,10 @@ module Google
2541
2656
  # the workspace root.
2542
2657
  #
2543
2658
  # @yield [response, operation] Access the result along with the RPC operation
2544
- # @yieldparam response [::Google::Protobuf::Empty]
2659
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse]
2545
2660
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2546
2661
  #
2547
- # @return [::Google::Protobuf::Empty]
2662
+ # @return [::Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse]
2548
2663
  #
2549
2664
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2550
2665
  #
@@ -2560,7 +2675,7 @@ module Google
2560
2675
  # # Call the remove_directory method.
2561
2676
  # result = client.remove_directory request
2562
2677
  #
2563
- # # The returned object is of type Google::Protobuf::Empty.
2678
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::RemoveDirectoryResponse.
2564
2679
  # p result
2565
2680
  #
2566
2681
  def remove_directory request, options = nil
@@ -2709,7 +2824,7 @@ module Google
2709
2824
  # @param options [::Gapic::CallOptions, ::Hash]
2710
2825
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2711
2826
  #
2712
- # @overload read_file(workspace: nil, path: nil)
2827
+ # @overload read_file(workspace: nil, path: nil, revision: nil)
2713
2828
  # Pass arguments to `read_file` via keyword arguments. Note that at
2714
2829
  # least one keyword argument is required. To specify no parameters, or to keep all
2715
2830
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2719,6 +2834,9 @@ module Google
2719
2834
  # @param path [::String]
2720
2835
  # Required. The file's full path including filename, relative to the
2721
2836
  # workspace root.
2837
+ # @param revision [::String]
2838
+ # Optional. The Git revision of the file to return. If left empty, the
2839
+ # current contents of `path` will be returned.
2722
2840
  #
2723
2841
  # @yield [response, operation] Access the result along with the RPC operation
2724
2842
  # @yieldparam response [::Google::Cloud::Dataform::V1beta1::ReadFileResponse]
@@ -2809,10 +2927,10 @@ module Google
2809
2927
  # workspace root.
2810
2928
  #
2811
2929
  # @yield [response, operation] Access the result along with the RPC operation
2812
- # @yieldparam response [::Google::Protobuf::Empty]
2930
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::RemoveFileResponse]
2813
2931
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
2814
2932
  #
2815
- # @return [::Google::Protobuf::Empty]
2933
+ # @return [::Google::Cloud::Dataform::V1beta1::RemoveFileResponse]
2816
2934
  #
2817
2935
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
2818
2936
  #
@@ -2828,7 +2946,7 @@ module Google
2828
2946
  # # Call the remove_file method.
2829
2947
  # result = client.remove_file request
2830
2948
  #
2831
- # # The returned object is of type Google::Protobuf::Empty.
2949
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::RemoveFileResponse.
2832
2950
  # p result
2833
2951
  #
2834
2952
  def remove_file request, options = nil
@@ -3081,8 +3199,9 @@ module Google
3081
3199
  # Optional. Page token received from a previous `ListReleaseConfigs` call.
3082
3200
  # Provide this to retrieve the subsequent page.
3083
3201
  #
3084
- # When paginating, all other parameters provided to `ListReleaseConfigs`
3085
- # must match the call that provided the page token.
3202
+ # When paginating, all other parameters provided to `ListReleaseConfigs`,
3203
+ # with the exception of `page_size`, must match the call that provided the
3204
+ # page token.
3086
3205
  #
3087
3206
  # @yield [response, operation] Access the result along with the RPC operation
3088
3207
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>]
@@ -3333,6 +3452,12 @@ module Google
3333
3452
  ##
3334
3453
  # Updates a single ReleaseConfig.
3335
3454
  #
3455
+ # **Note:** This method does not fully implement
3456
+ # [AIP-134](https://google.aip.dev/134); in particular:
3457
+ # - The wildcard entry (**\***) is treated as a bad request
3458
+ # - When the **field_mask** is omitted, instead of only updating the set
3459
+ # fields, the request is treated as a full update on all modifiable fields
3460
+ #
3336
3461
  # @overload update_release_config(request, options = nil)
3337
3462
  # Pass arguments to `update_release_config` via a request object, either of type
3338
3463
  # {::Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest} or an equivalent Hash.
@@ -3516,7 +3641,7 @@ module Google
3516
3641
  # @param options [::Gapic::CallOptions, ::Hash]
3517
3642
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
3518
3643
  #
3519
- # @overload list_compilation_results(parent: nil, page_size: nil, page_token: nil)
3644
+ # @overload list_compilation_results(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil)
3520
3645
  # Pass arguments to `list_compilation_results` via keyword arguments. Note that at
3521
3646
  # least one keyword argument is required. To specify no parameters, or to keep all
3522
3647
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3532,8 +3657,15 @@ module Google
3532
3657
  # Optional. Page token received from a previous `ListCompilationResults`
3533
3658
  # call. Provide this to retrieve the subsequent page.
3534
3659
  #
3535
- # When paginating, all other parameters provided to `ListCompilationResults`
3536
- # must match the call that provided the page token.
3660
+ # When paginating, all other parameters provided to `ListCompilationResults`,
3661
+ # with the exception of `page_size`, must match the call that provided the
3662
+ # page token.
3663
+ # @param order_by [::String]
3664
+ # Optional. This field only supports ordering by `name` and `create_time`.
3665
+ # If unspecified, the server will choose the ordering.
3666
+ # If specified, the default order is ascending for the `name` field.
3667
+ # @param filter [::String]
3668
+ # Optional. Filter for the returned list.
3537
3669
  #
3538
3670
  # @yield [response, operation] Access the result along with the RPC operation
3539
3671
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>]
@@ -3808,8 +3940,8 @@ module Google
3808
3940
  # subsequent page.
3809
3941
  #
3810
3942
  # When paginating, all other parameters provided to
3811
- # `QueryCompilationResultActions` must match the call that provided the page
3812
- # token.
3943
+ # `QueryCompilationResultActions`, with the exception of `page_size`, must
3944
+ # match the call that provided the page token.
3813
3945
  # @param filter [::String]
3814
3946
  # Optional. Optional filter for the returned list. Filtering is only
3815
3947
  # currently supported on the `file_path` field.
@@ -3913,8 +4045,9 @@ module Google
3913
4045
  # Optional. Page token received from a previous `ListWorkflowConfigs` call.
3914
4046
  # Provide this to retrieve the subsequent page.
3915
4047
  #
3916
- # When paginating, all other parameters provided to `ListWorkflowConfigs`
3917
- # must match the call that provided the page token.
4048
+ # When paginating, all other parameters provided to `ListWorkflowConfigs`,
4049
+ # with the exception of `page_size`, must match the call that provided the
4050
+ # page token.
3918
4051
  #
3919
4052
  # @yield [response, operation] Access the result along with the RPC operation
3920
4053
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>]
@@ -4165,6 +4298,12 @@ module Google
4165
4298
  ##
4166
4299
  # Updates a single WorkflowConfig.
4167
4300
  #
4301
+ # **Note:** This method does not fully implement
4302
+ # [AIP-134](https://google.aip.dev/134); in particular:
4303
+ # - The wildcard entry (**\***) is treated as a bad request
4304
+ # - When the **field_mask** is omitted, instead of only updating the set
4305
+ # fields, the request is treated as a full update on all modifiable fields
4306
+ #
4168
4307
  # @overload update_workflow_config(request, options = nil)
4169
4308
  # Pass arguments to `update_workflow_config` via a request object, either of type
4170
4309
  # {::Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest} or an equivalent Hash.
@@ -4364,8 +4503,9 @@ module Google
4364
4503
  # Optional. Page token received from a previous `ListWorkflowInvocations`
4365
4504
  # call. Provide this to retrieve the subsequent page.
4366
4505
  #
4367
- # When paginating, all other parameters provided to `ListWorkflowInvocations`
4368
- # must match the call that provided the page token.
4506
+ # When paginating, all other parameters provided to
4507
+ # `ListWorkflowInvocations`, with the exception of `page_size`, must match
4508
+ # the call that provided the page token.
4369
4509
  # @param order_by [::String]
4370
4510
  # Optional. This field only supports ordering by `name`. If unspecified, the
4371
4511
  # server will choose the ordering. If specified, the default order is
@@ -4723,10 +4863,10 @@ module Google
4723
4863
  # Required. The workflow invocation resource's name.
4724
4864
  #
4725
4865
  # @yield [response, operation] Access the result along with the RPC operation
4726
- # @yieldparam response [::Google::Protobuf::Empty]
4866
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse]
4727
4867
  # @yieldparam operation [::GRPC::ActiveCall::Operation]
4728
4868
  #
4729
- # @return [::Google::Protobuf::Empty]
4869
+ # @return [::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse]
4730
4870
  #
4731
4871
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
4732
4872
  #
@@ -4742,7 +4882,7 @@ module Google
4742
4882
  # # Call the cancel_workflow_invocation method.
4743
4883
  # result = client.cancel_workflow_invocation request
4744
4884
  #
4745
- # # The returned object is of type Google::Protobuf::Empty.
4885
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationResponse.
4746
4886
  # p result
4747
4887
  #
4748
4888
  def cancel_workflow_invocation request, options = nil
@@ -4816,8 +4956,8 @@ module Google
4816
4956
  # subsequent page.
4817
4957
  #
4818
4958
  # When paginating, all other parameters provided to
4819
- # `QueryWorkflowInvocationActions` must match the call that provided the page
4820
- # token.
4959
+ # `QueryWorkflowInvocationActions`, with the exception of `page_size`, must
4960
+ # match the call that provided the page token.
4821
4961
  #
4822
4962
  # @yield [response, operation] Access the result along with the RPC operation
4823
4963
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>]
@@ -4889,6 +5029,184 @@ module Google
4889
5029
  raise ::Google::Cloud::Error.from_error(e)
4890
5030
  end
4891
5031
 
5032
+ ##
5033
+ # Get default config for a given project and location.
5034
+ #
5035
+ # @overload get_config(request, options = nil)
5036
+ # Pass arguments to `get_config` via a request object, either of type
5037
+ # {::Google::Cloud::Dataform::V1beta1::GetConfigRequest} or an equivalent Hash.
5038
+ #
5039
+ # @param request [::Google::Cloud::Dataform::V1beta1::GetConfigRequest, ::Hash]
5040
+ # A request object representing the call parameters. Required. To specify no
5041
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5042
+ # @param options [::Gapic::CallOptions, ::Hash]
5043
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5044
+ #
5045
+ # @overload get_config(name: nil)
5046
+ # Pass arguments to `get_config` via keyword arguments. Note that at
5047
+ # least one keyword argument is required. To specify no parameters, or to keep all
5048
+ # the default parameter values, pass an empty Hash as a request object (see above).
5049
+ #
5050
+ # @param name [::String]
5051
+ # Required. The config name.
5052
+ #
5053
+ # @yield [response, operation] Access the result along with the RPC operation
5054
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::Config]
5055
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5056
+ #
5057
+ # @return [::Google::Cloud::Dataform::V1beta1::Config]
5058
+ #
5059
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5060
+ #
5061
+ # @example Basic example
5062
+ # require "google/cloud/dataform/v1beta1"
5063
+ #
5064
+ # # Create a client object. The client can be reused for multiple calls.
5065
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new
5066
+ #
5067
+ # # Create a request. To set request fields, pass in keyword arguments.
5068
+ # request = Google::Cloud::Dataform::V1beta1::GetConfigRequest.new
5069
+ #
5070
+ # # Call the get_config method.
5071
+ # result = client.get_config request
5072
+ #
5073
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Config.
5074
+ # p result
5075
+ #
5076
+ def get_config request, options = nil
5077
+ raise ::ArgumentError, "request must be provided" if request.nil?
5078
+
5079
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetConfigRequest
5080
+
5081
+ # Converts hash and nil to an options object
5082
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5083
+
5084
+ # Customize the options with defaults
5085
+ metadata = @config.rpcs.get_config.metadata.to_h
5086
+
5087
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5088
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5089
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5090
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
5091
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5092
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5093
+
5094
+ header_params = {}
5095
+ if request.name
5096
+ header_params["name"] = request.name
5097
+ end
5098
+
5099
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5100
+ metadata[:"x-goog-request-params"] ||= request_params_header
5101
+
5102
+ options.apply_defaults timeout: @config.rpcs.get_config.timeout,
5103
+ metadata: metadata,
5104
+ retry_policy: @config.rpcs.get_config.retry_policy
5105
+
5106
+ options.apply_defaults timeout: @config.timeout,
5107
+ metadata: @config.metadata,
5108
+ retry_policy: @config.retry_policy
5109
+
5110
+ @dataform_stub.call_rpc :get_config, request, options: options do |response, operation|
5111
+ yield response, operation if block_given?
5112
+ end
5113
+ rescue ::GRPC::BadStatus => e
5114
+ raise ::Google::Cloud::Error.from_error(e)
5115
+ end
5116
+
5117
+ ##
5118
+ # Update default config for a given project and location.
5119
+ #
5120
+ # **Note:** This method does not fully implement
5121
+ # [AIP-134](https://google.aip.dev/134); in particular:
5122
+ # - The wildcard entry (**\***) is treated as a bad request
5123
+ # - When the **field_mask** is omitted, instead of only updating the set
5124
+ # fields, the request is treated as a full update on all modifiable fields
5125
+ #
5126
+ # @overload update_config(request, options = nil)
5127
+ # Pass arguments to `update_config` via a request object, either of type
5128
+ # {::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest} or an equivalent Hash.
5129
+ #
5130
+ # @param request [::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest, ::Hash]
5131
+ # A request object representing the call parameters. Required. To specify no
5132
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5133
+ # @param options [::Gapic::CallOptions, ::Hash]
5134
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5135
+ #
5136
+ # @overload update_config(config: nil, update_mask: nil)
5137
+ # Pass arguments to `update_config` via keyword arguments. Note that at
5138
+ # least one keyword argument is required. To specify no parameters, or to keep all
5139
+ # the default parameter values, pass an empty Hash as a request object (see above).
5140
+ #
5141
+ # @param config [::Google::Cloud::Dataform::V1beta1::Config, ::Hash]
5142
+ # Required. The config to update.
5143
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
5144
+ # Optional. Specifies the fields to be updated in the config.
5145
+ #
5146
+ # @yield [response, operation] Access the result along with the RPC operation
5147
+ # @yieldparam response [::Google::Cloud::Dataform::V1beta1::Config]
5148
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5149
+ #
5150
+ # @return [::Google::Cloud::Dataform::V1beta1::Config]
5151
+ #
5152
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5153
+ #
5154
+ # @example Basic example
5155
+ # require "google/cloud/dataform/v1beta1"
5156
+ #
5157
+ # # Create a client object. The client can be reused for multiple calls.
5158
+ # client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new
5159
+ #
5160
+ # # Create a request. To set request fields, pass in keyword arguments.
5161
+ # request = Google::Cloud::Dataform::V1beta1::UpdateConfigRequest.new
5162
+ #
5163
+ # # Call the update_config method.
5164
+ # result = client.update_config request
5165
+ #
5166
+ # # The returned object is of type Google::Cloud::Dataform::V1beta1::Config.
5167
+ # p result
5168
+ #
5169
+ def update_config request, options = nil
5170
+ raise ::ArgumentError, "request must be provided" if request.nil?
5171
+
5172
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateConfigRequest
5173
+
5174
+ # Converts hash and nil to an options object
5175
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5176
+
5177
+ # Customize the options with defaults
5178
+ metadata = @config.rpcs.update_config.metadata.to_h
5179
+
5180
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5181
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5182
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5183
+ gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
5184
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5185
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5186
+
5187
+ header_params = {}
5188
+ if request.config&.name
5189
+ header_params["config.name"] = request.config.name
5190
+ end
5191
+
5192
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5193
+ metadata[:"x-goog-request-params"] ||= request_params_header
5194
+
5195
+ options.apply_defaults timeout: @config.rpcs.update_config.timeout,
5196
+ metadata: metadata,
5197
+ retry_policy: @config.rpcs.update_config.retry_policy
5198
+
5199
+ options.apply_defaults timeout: @config.timeout,
5200
+ metadata: @config.metadata,
5201
+ retry_policy: @config.retry_policy
5202
+
5203
+ @dataform_stub.call_rpc :update_config, request, options: options do |response, operation|
5204
+ yield response, operation if block_given?
5205
+ end
5206
+ rescue ::GRPC::BadStatus => e
5207
+ raise ::Google::Cloud::Error.from_error(e)
5208
+ end
5209
+
4892
5210
  ##
4893
5211
  # Configuration class for the Dataform API.
4894
5212
  #
@@ -5176,6 +5494,11 @@ module Google
5176
5494
  #
5177
5495
  attr_reader :query_directory_contents
5178
5496
  ##
5497
+ # RPC-specific configuration for `search_files`
5498
+ # @return [::Gapic::Config::Method]
5499
+ #
5500
+ attr_reader :search_files
5501
+ ##
5179
5502
  # RPC-specific configuration for `make_directory`
5180
5503
  # @return [::Gapic::Config::Method]
5181
5504
  #
@@ -5310,6 +5633,16 @@ module Google
5310
5633
  # @return [::Gapic::Config::Method]
5311
5634
  #
5312
5635
  attr_reader :query_workflow_invocation_actions
5636
+ ##
5637
+ # RPC-specific configuration for `get_config`
5638
+ # @return [::Gapic::Config::Method]
5639
+ #
5640
+ attr_reader :get_config
5641
+ ##
5642
+ # RPC-specific configuration for `update_config`
5643
+ # @return [::Gapic::Config::Method]
5644
+ #
5645
+ attr_reader :update_config
5313
5646
 
5314
5647
  # @private
5315
5648
  def initialize parent_rpcs = nil
@@ -5361,6 +5694,8 @@ module Google
5361
5694
  @fetch_file_diff = ::Gapic::Config::Method.new fetch_file_diff_config
5362
5695
  query_directory_contents_config = parent_rpcs.query_directory_contents if parent_rpcs.respond_to? :query_directory_contents
5363
5696
  @query_directory_contents = ::Gapic::Config::Method.new query_directory_contents_config
5697
+ search_files_config = parent_rpcs.search_files if parent_rpcs.respond_to? :search_files
5698
+ @search_files = ::Gapic::Config::Method.new search_files_config
5364
5699
  make_directory_config = parent_rpcs.make_directory if parent_rpcs.respond_to? :make_directory
5365
5700
  @make_directory = ::Gapic::Config::Method.new make_directory_config
5366
5701
  remove_directory_config = parent_rpcs.remove_directory if parent_rpcs.respond_to? :remove_directory
@@ -5415,6 +5750,10 @@ module Google
5415
5750
  @cancel_workflow_invocation = ::Gapic::Config::Method.new cancel_workflow_invocation_config
5416
5751
  query_workflow_invocation_actions_config = parent_rpcs.query_workflow_invocation_actions if parent_rpcs.respond_to? :query_workflow_invocation_actions
5417
5752
  @query_workflow_invocation_actions = ::Gapic::Config::Method.new query_workflow_invocation_actions_config
5753
+ get_config_config = parent_rpcs.get_config if parent_rpcs.respond_to? :get_config
5754
+ @get_config = ::Gapic::Config::Method.new get_config_config
5755
+ update_config_config = parent_rpcs.update_config if parent_rpcs.respond_to? :update_config
5756
+ @update_config = ::Gapic::Config::Method.new update_config_config
5418
5757
 
5419
5758
  yield self if block_given?
5420
5759
  end