google-cloud-dataplex-v1 2.9.0 → 2.10.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.
Files changed (100) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/dataplex/v1/analyze_pb.rb +2 -25
  4. data/lib/google/cloud/dataplex/v1/approval_workflow_pb.rb +33 -0
  5. data/lib/google/cloud/dataplex/v1/bindings_override.rb +24 -24
  6. data/lib/google/cloud/dataplex/v1/business_glossary_pb.rb +3 -26
  7. data/lib/google/cloud/dataplex/v1/business_glossary_service/client.rb +2 -0
  8. data/lib/google/cloud/dataplex/v1/business_glossary_service/credentials.rb +4 -1
  9. data/lib/google/cloud/dataplex/v1/business_glossary_service/operations.rb +2 -0
  10. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/client.rb +2 -0
  11. data/lib/google/cloud/dataplex/v1/business_glossary_service/rest/operations.rb +2 -0
  12. data/lib/google/cloud/dataplex/v1/catalog_pb.rb +20 -27
  13. data/lib/google/cloud/dataplex/v1/catalog_service/client.rb +1074 -73
  14. data/lib/google/cloud/dataplex/v1/catalog_service/credentials.rb +4 -1
  15. data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb +2 -0
  16. data/lib/google/cloud/dataplex/v1/catalog_service/paths.rb +19 -0
  17. data/lib/google/cloud/dataplex/v1/catalog_service/rest/client.rb +1020 -82
  18. data/lib/google/cloud/dataplex/v1/catalog_service/rest/operations.rb +2 -0
  19. data/lib/google/cloud/dataplex/v1/catalog_service/rest/service_stub.rb +554 -0
  20. data/lib/google/cloud/dataplex/v1/catalog_services_pb.rb +18 -15
  21. data/lib/google/cloud/dataplex/v1/cmek_pb.rb +3 -26
  22. data/lib/google/cloud/dataplex/v1/cmek_service/client.rb +2 -0
  23. data/lib/google/cloud/dataplex/v1/cmek_service/credentials.rb +2 -1
  24. data/lib/google/cloud/dataplex/v1/cmek_service/operations.rb +2 -0
  25. data/lib/google/cloud/dataplex/v1/cmek_service/rest/client.rb +2 -0
  26. data/lib/google/cloud/dataplex/v1/cmek_service/rest/operations.rb +2 -0
  27. data/lib/google/cloud/dataplex/v1/content_pb.rb +3 -38
  28. data/lib/google/cloud/dataplex/v1/content_services_pb.rb +0 -49
  29. data/lib/google/cloud/dataplex/v1/data_discovery_pb.rb +4 -24
  30. data/lib/google/cloud/dataplex/v1/data_documentation_pb.rb +10 -24
  31. data/lib/google/cloud/dataplex/v1/data_product_service/client.rb +1644 -0
  32. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/credentials.rb +7 -4
  33. data/lib/google/cloud/dataplex/v1/data_product_service/operations.rb +843 -0
  34. data/lib/google/cloud/dataplex/v1/data_product_service/paths.rb +231 -0
  35. data/lib/google/cloud/dataplex/v1/data_product_service/rest/client.rb +1533 -0
  36. data/lib/google/cloud/dataplex/v1/data_product_service/rest/operations.rb +956 -0
  37. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest/service_stub.rb +284 -160
  38. data/lib/google/cloud/dataplex/v1/{content_service → data_product_service}/rest.rb +11 -10
  39. data/lib/google/cloud/dataplex/v1/{content_service.rb → data_product_service.rb} +15 -14
  40. data/lib/google/cloud/dataplex/v1/data_products_pb.rb +52 -0
  41. data/lib/google/cloud/dataplex/v1/data_products_services_pb.rb +69 -0
  42. data/lib/google/cloud/dataplex/v1/data_profile_pb.rb +4 -26
  43. data/lib/google/cloud/dataplex/v1/data_quality_pb.rb +13 -26
  44. data/lib/google/cloud/dataplex/v1/data_quality_rule_template_pb.rb +25 -0
  45. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +99 -1
  46. data/lib/google/cloud/dataplex/v1/data_scan_service/credentials.rb +4 -1
  47. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +2 -0
  48. data/lib/google/cloud/dataplex/v1/data_scan_service/paths.rb +21 -0
  49. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +92 -1
  50. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +2 -0
  51. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +62 -0
  52. data/lib/google/cloud/dataplex/v1/data_taxonomy_pb.rb +3 -27
  53. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +2 -0
  54. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/credentials.rb +2 -1
  55. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +2 -0
  56. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +2 -0
  57. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +2 -0
  58. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +2 -664
  59. data/lib/google/cloud/dataplex/v1/dataplex_service/credentials.rb +4 -1
  60. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +2 -0
  61. data/lib/google/cloud/dataplex/v1/dataplex_service/paths.rb +0 -21
  62. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +2 -622
  63. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +2 -0
  64. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +0 -368
  65. data/lib/google/cloud/dataplex/v1/datascans_common_pb.rb +3 -24
  66. data/lib/google/cloud/dataplex/v1/datascans_pb.rb +9 -31
  67. data/lib/google/cloud/dataplex/v1/datascans_services_pb.rb +2 -0
  68. data/lib/google/cloud/dataplex/v1/logs_pb.rb +3 -27
  69. data/lib/google/cloud/dataplex/v1/metadata_pb.rb +3 -25
  70. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +2 -0
  71. data/lib/google/cloud/dataplex/v1/metadata_service/credentials.rb +2 -1
  72. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +2 -0
  73. data/lib/google/cloud/dataplex/v1/processing_pb.rb +5 -24
  74. data/lib/google/cloud/dataplex/v1/resources_pb.rb +2 -25
  75. data/lib/google/cloud/dataplex/v1/rest.rb +1 -1
  76. data/lib/google/cloud/dataplex/v1/security_pb.rb +2 -23
  77. data/lib/google/cloud/dataplex/v1/service_pb.rb +3 -38
  78. data/lib/google/cloud/dataplex/v1/service_services_pb.rb +0 -13
  79. data/lib/google/cloud/dataplex/v1/tasks_pb.rb +2 -25
  80. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  81. data/lib/google/cloud/dataplex/v1.rb +1 -0
  82. data/proto_docs/google/api/client.rb +149 -29
  83. data/proto_docs/google/cloud/dataplex/v1/approval_workflow.rb +263 -0
  84. data/proto_docs/google/cloud/dataplex/v1/catalog.rb +427 -3
  85. data/proto_docs/google/cloud/dataplex/v1/data_discovery.rb +13 -0
  86. data/proto_docs/google/cloud/dataplex/v1/data_documentation.rb +118 -2
  87. data/proto_docs/google/cloud/dataplex/v1/data_products.rb +567 -0
  88. data/proto_docs/google/cloud/dataplex/v1/data_profile.rb +21 -0
  89. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +240 -10
  90. data/proto_docs/google/cloud/dataplex/v1/data_quality_rule_template.rb +88 -0
  91. data/proto_docs/google/cloud/dataplex/v1/datascans.rb +82 -5
  92. data/proto_docs/google/cloud/dataplex/v1/datascans_common.rb +7 -3
  93. data/proto_docs/google/cloud/dataplex/v1/logs.rb +7 -0
  94. data/proto_docs/google/cloud/dataplex/v1/processing.rb +27 -3
  95. data/proto_docs/google/cloud/dataplex/v1/service.rb +0 -148
  96. metadata +20 -12
  97. data/lib/google/cloud/dataplex/v1/content_service/client.rb +0 -1261
  98. data/lib/google/cloud/dataplex/v1/content_service/paths.rb +0 -73
  99. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +0 -1171
  100. data/proto_docs/google/cloud/dataplex/v1/content.rb +0 -142
@@ -169,22 +169,6 @@ module Google
169
169
 
170
170
  default_config.rpcs.cancel_job.timeout = 60.0
171
171
 
172
- default_config.rpcs.create_environment.timeout = 60.0
173
-
174
- default_config.rpcs.update_environment.timeout = 60.0
175
-
176
- default_config.rpcs.delete_environment.timeout = 60.0
177
-
178
- default_config.rpcs.list_environments.timeout = 60.0
179
- default_config.rpcs.list_environments.retry_policy = {
180
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
181
- }
182
-
183
- default_config.rpcs.get_environment.timeout = 60.0
184
- default_config.rpcs.get_environment.retry_policy = {
185
- initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
186
- }
187
-
188
172
  default_config
189
173
  end
190
174
  yield @configure if block_given?
@@ -2800,570 +2784,6 @@ module Google
2800
2784
  raise ::Google::Cloud::Error.from_error(e)
2801
2785
  end
2802
2786
 
2803
- ##
2804
- # Create an environment resource.
2805
- #
2806
- # @overload create_environment(request, options = nil)
2807
- # Pass arguments to `create_environment` via a request object, either of type
2808
- # {::Google::Cloud::Dataplex::V1::CreateEnvironmentRequest} or an equivalent Hash.
2809
- #
2810
- # @param request [::Google::Cloud::Dataplex::V1::CreateEnvironmentRequest, ::Hash]
2811
- # A request object representing the call parameters. Required. To specify no
2812
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2813
- # @param options [::Gapic::CallOptions, ::Hash]
2814
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2815
- #
2816
- # @overload create_environment(parent: nil, environment_id: nil, environment: nil, validate_only: nil)
2817
- # Pass arguments to `create_environment` via keyword arguments. Note that at
2818
- # least one keyword argument is required. To specify no parameters, or to keep all
2819
- # the default parameter values, pass an empty Hash as a request object (see above).
2820
- #
2821
- # @param parent [::String]
2822
- # Required. The resource name of the parent lake:
2823
- # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
2824
- # @param environment_id [::String]
2825
- # Required. Environment identifier.
2826
- # * Must contain only lowercase letters, numbers and hyphens.
2827
- # * Must start with a letter.
2828
- # * Must be between 1-63 characters.
2829
- # * Must end with a number or a letter.
2830
- # * Must be unique within the lake.
2831
- # @param environment [::Google::Cloud::Dataplex::V1::Environment, ::Hash]
2832
- # Required. Environment resource.
2833
- # @param validate_only [::Boolean]
2834
- # Optional. Only validate the request, but do not perform mutations.
2835
- # The default is false.
2836
- # @yield [result, operation] Access the result along with the TransportOperation object
2837
- # @yieldparam result [::Gapic::Operation]
2838
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
2839
- #
2840
- # @return [::Gapic::Operation]
2841
- #
2842
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
2843
- #
2844
- # @example Basic example
2845
- # require "google/cloud/dataplex/v1"
2846
- #
2847
- # # Create a client object. The client can be reused for multiple calls.
2848
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
2849
- #
2850
- # # Create a request. To set request fields, pass in keyword arguments.
2851
- # request = Google::Cloud::Dataplex::V1::CreateEnvironmentRequest.new
2852
- #
2853
- # # Call the create_environment method.
2854
- # result = client.create_environment request
2855
- #
2856
- # # The returned object is of type Gapic::Operation. You can use it to
2857
- # # check the status of an operation, cancel it, or wait for results.
2858
- # # Here is how to wait for a response.
2859
- # result.wait_until_done! timeout: 60
2860
- # if result.response?
2861
- # p result.response
2862
- # else
2863
- # puts "No response received."
2864
- # end
2865
- #
2866
- def create_environment request, options = nil
2867
- raise ::ArgumentError, "request must be provided" if request.nil?
2868
-
2869
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateEnvironmentRequest
2870
-
2871
- # Converts hash and nil to an options object
2872
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2873
-
2874
- # Customize the options with defaults
2875
- call_metadata = @config.rpcs.create_environment.metadata.to_h
2876
-
2877
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2878
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2879
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2880
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2881
- transports_version_send: [:rest]
2882
-
2883
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2884
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2885
-
2886
- options.apply_defaults timeout: @config.rpcs.create_environment.timeout,
2887
- metadata: call_metadata,
2888
- retry_policy: @config.rpcs.create_environment.retry_policy
2889
-
2890
- options.apply_defaults timeout: @config.timeout,
2891
- metadata: @config.metadata,
2892
- retry_policy: @config.retry_policy
2893
-
2894
- @dataplex_service_stub.create_environment request, options do |result, operation|
2895
- result = ::Gapic::Operation.new result, @operations_client, options: options
2896
- yield result, operation if block_given?
2897
- throw :response, result
2898
- end
2899
- rescue ::Gapic::Rest::Error => e
2900
- raise ::Google::Cloud::Error.from_error(e)
2901
- end
2902
-
2903
- ##
2904
- # Update the environment resource.
2905
- #
2906
- # @overload update_environment(request, options = nil)
2907
- # Pass arguments to `update_environment` via a request object, either of type
2908
- # {::Google::Cloud::Dataplex::V1::UpdateEnvironmentRequest} or an equivalent Hash.
2909
- #
2910
- # @param request [::Google::Cloud::Dataplex::V1::UpdateEnvironmentRequest, ::Hash]
2911
- # A request object representing the call parameters. Required. To specify no
2912
- # parameters, or to keep all the default parameter values, pass an empty Hash.
2913
- # @param options [::Gapic::CallOptions, ::Hash]
2914
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2915
- #
2916
- # @overload update_environment(update_mask: nil, environment: nil, validate_only: nil)
2917
- # Pass arguments to `update_environment` via keyword arguments. Note that at
2918
- # least one keyword argument is required. To specify no parameters, or to keep all
2919
- # the default parameter values, pass an empty Hash as a request object (see above).
2920
- #
2921
- # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2922
- # Required. Mask of fields to update.
2923
- # @param environment [::Google::Cloud::Dataplex::V1::Environment, ::Hash]
2924
- # Required. Update description.
2925
- # Only fields specified in `update_mask` are updated.
2926
- # @param validate_only [::Boolean]
2927
- # Optional. Only validate the request, but do not perform mutations.
2928
- # The default is false.
2929
- # @yield [result, operation] Access the result along with the TransportOperation object
2930
- # @yieldparam result [::Gapic::Operation]
2931
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
2932
- #
2933
- # @return [::Gapic::Operation]
2934
- #
2935
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
2936
- #
2937
- # @example Basic example
2938
- # require "google/cloud/dataplex/v1"
2939
- #
2940
- # # Create a client object. The client can be reused for multiple calls.
2941
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
2942
- #
2943
- # # Create a request. To set request fields, pass in keyword arguments.
2944
- # request = Google::Cloud::Dataplex::V1::UpdateEnvironmentRequest.new
2945
- #
2946
- # # Call the update_environment method.
2947
- # result = client.update_environment request
2948
- #
2949
- # # The returned object is of type Gapic::Operation. You can use it to
2950
- # # check the status of an operation, cancel it, or wait for results.
2951
- # # Here is how to wait for a response.
2952
- # result.wait_until_done! timeout: 60
2953
- # if result.response?
2954
- # p result.response
2955
- # else
2956
- # puts "No response received."
2957
- # end
2958
- #
2959
- def update_environment request, options = nil
2960
- raise ::ArgumentError, "request must be provided" if request.nil?
2961
-
2962
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateEnvironmentRequest
2963
-
2964
- # Converts hash and nil to an options object
2965
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2966
-
2967
- # Customize the options with defaults
2968
- call_metadata = @config.rpcs.update_environment.metadata.to_h
2969
-
2970
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2971
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2972
- lib_name: @config.lib_name, lib_version: @config.lib_version,
2973
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
2974
- transports_version_send: [:rest]
2975
-
2976
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2977
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2978
-
2979
- options.apply_defaults timeout: @config.rpcs.update_environment.timeout,
2980
- metadata: call_metadata,
2981
- retry_policy: @config.rpcs.update_environment.retry_policy
2982
-
2983
- options.apply_defaults timeout: @config.timeout,
2984
- metadata: @config.metadata,
2985
- retry_policy: @config.retry_policy
2986
-
2987
- @dataplex_service_stub.update_environment request, options do |result, operation|
2988
- result = ::Gapic::Operation.new result, @operations_client, options: options
2989
- yield result, operation if block_given?
2990
- throw :response, result
2991
- end
2992
- rescue ::Gapic::Rest::Error => e
2993
- raise ::Google::Cloud::Error.from_error(e)
2994
- end
2995
-
2996
- ##
2997
- # Delete the environment resource. All the child resources must have been
2998
- # deleted before environment deletion can be initiated.
2999
- #
3000
- # @overload delete_environment(request, options = nil)
3001
- # Pass arguments to `delete_environment` via a request object, either of type
3002
- # {::Google::Cloud::Dataplex::V1::DeleteEnvironmentRequest} or an equivalent Hash.
3003
- #
3004
- # @param request [::Google::Cloud::Dataplex::V1::DeleteEnvironmentRequest, ::Hash]
3005
- # A request object representing the call parameters. Required. To specify no
3006
- # parameters, or to keep all the default parameter values, pass an empty Hash.
3007
- # @param options [::Gapic::CallOptions, ::Hash]
3008
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3009
- #
3010
- # @overload delete_environment(name: nil)
3011
- # Pass arguments to `delete_environment` via keyword arguments. Note that at
3012
- # least one keyword argument is required. To specify no parameters, or to keep all
3013
- # the default parameter values, pass an empty Hash as a request object (see above).
3014
- #
3015
- # @param name [::String]
3016
- # Required. The resource name of the environment:
3017
- # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`.
3018
- # @yield [result, operation] Access the result along with the TransportOperation object
3019
- # @yieldparam result [::Gapic::Operation]
3020
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
3021
- #
3022
- # @return [::Gapic::Operation]
3023
- #
3024
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
3025
- #
3026
- # @example Basic example
3027
- # require "google/cloud/dataplex/v1"
3028
- #
3029
- # # Create a client object. The client can be reused for multiple calls.
3030
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
3031
- #
3032
- # # Create a request. To set request fields, pass in keyword arguments.
3033
- # request = Google::Cloud::Dataplex::V1::DeleteEnvironmentRequest.new
3034
- #
3035
- # # Call the delete_environment method.
3036
- # result = client.delete_environment request
3037
- #
3038
- # # The returned object is of type Gapic::Operation. You can use it to
3039
- # # check the status of an operation, cancel it, or wait for results.
3040
- # # Here is how to wait for a response.
3041
- # result.wait_until_done! timeout: 60
3042
- # if result.response?
3043
- # p result.response
3044
- # else
3045
- # puts "No response received."
3046
- # end
3047
- #
3048
- def delete_environment request, options = nil
3049
- raise ::ArgumentError, "request must be provided" if request.nil?
3050
-
3051
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteEnvironmentRequest
3052
-
3053
- # Converts hash and nil to an options object
3054
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3055
-
3056
- # Customize the options with defaults
3057
- call_metadata = @config.rpcs.delete_environment.metadata.to_h
3058
-
3059
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
3060
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3061
- lib_name: @config.lib_name, lib_version: @config.lib_version,
3062
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
3063
- transports_version_send: [:rest]
3064
-
3065
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
3066
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3067
-
3068
- options.apply_defaults timeout: @config.rpcs.delete_environment.timeout,
3069
- metadata: call_metadata,
3070
- retry_policy: @config.rpcs.delete_environment.retry_policy
3071
-
3072
- options.apply_defaults timeout: @config.timeout,
3073
- metadata: @config.metadata,
3074
- retry_policy: @config.retry_policy
3075
-
3076
- @dataplex_service_stub.delete_environment request, options do |result, operation|
3077
- result = ::Gapic::Operation.new result, @operations_client, options: options
3078
- yield result, operation if block_given?
3079
- throw :response, result
3080
- end
3081
- rescue ::Gapic::Rest::Error => e
3082
- raise ::Google::Cloud::Error.from_error(e)
3083
- end
3084
-
3085
- ##
3086
- # Lists environments under the given lake.
3087
- #
3088
- # @overload list_environments(request, options = nil)
3089
- # Pass arguments to `list_environments` via a request object, either of type
3090
- # {::Google::Cloud::Dataplex::V1::ListEnvironmentsRequest} or an equivalent Hash.
3091
- #
3092
- # @param request [::Google::Cloud::Dataplex::V1::ListEnvironmentsRequest, ::Hash]
3093
- # A request object representing the call parameters. Required. To specify no
3094
- # parameters, or to keep all the default parameter values, pass an empty Hash.
3095
- # @param options [::Gapic::CallOptions, ::Hash]
3096
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3097
- #
3098
- # @overload list_environments(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
3099
- # Pass arguments to `list_environments` via keyword arguments. Note that at
3100
- # least one keyword argument is required. To specify no parameters, or to keep all
3101
- # the default parameter values, pass an empty Hash as a request object (see above).
3102
- #
3103
- # @param parent [::String]
3104
- # Required. The resource name of the parent lake:
3105
- # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}`.
3106
- # @param page_size [::Integer]
3107
- # Optional. Maximum number of environments to return. The service may return
3108
- # fewer than this value. If unspecified, at most 10 environments will be
3109
- # returned. The maximum value is 1000; values above 1000 will be coerced to
3110
- # 1000.
3111
- # @param page_token [::String]
3112
- # Optional. Page token received from a previous `ListEnvironments` call.
3113
- # Provide this to retrieve the subsequent page. When paginating, all other
3114
- # parameters provided to `ListEnvironments` must match the call that provided
3115
- # the page token.
3116
- # @param filter [::String]
3117
- # Optional. Filter request.
3118
- # @param order_by [::String]
3119
- # Optional. Order by fields for the result.
3120
- # @yield [result, operation] Access the result along with the TransportOperation object
3121
- # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Environment>]
3122
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
3123
- #
3124
- # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Environment>]
3125
- #
3126
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
3127
- #
3128
- # @example Basic example
3129
- # require "google/cloud/dataplex/v1"
3130
- #
3131
- # # Create a client object. The client can be reused for multiple calls.
3132
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
3133
- #
3134
- # # Create a request. To set request fields, pass in keyword arguments.
3135
- # request = Google::Cloud::Dataplex::V1::ListEnvironmentsRequest.new
3136
- #
3137
- # # Call the list_environments method.
3138
- # result = client.list_environments request
3139
- #
3140
- # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3141
- # # over elements, and API calls will be issued to fetch pages as needed.
3142
- # result.each do |item|
3143
- # # Each element is of type ::Google::Cloud::Dataplex::V1::Environment.
3144
- # p item
3145
- # end
3146
- #
3147
- def list_environments request, options = nil
3148
- raise ::ArgumentError, "request must be provided" if request.nil?
3149
-
3150
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListEnvironmentsRequest
3151
-
3152
- # Converts hash and nil to an options object
3153
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3154
-
3155
- # Customize the options with defaults
3156
- call_metadata = @config.rpcs.list_environments.metadata.to_h
3157
-
3158
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
3159
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3160
- lib_name: @config.lib_name, lib_version: @config.lib_version,
3161
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
3162
- transports_version_send: [:rest]
3163
-
3164
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
3165
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3166
-
3167
- options.apply_defaults timeout: @config.rpcs.list_environments.timeout,
3168
- metadata: call_metadata,
3169
- retry_policy: @config.rpcs.list_environments.retry_policy
3170
-
3171
- options.apply_defaults timeout: @config.timeout,
3172
- metadata: @config.metadata,
3173
- retry_policy: @config.retry_policy
3174
-
3175
- @dataplex_service_stub.list_environments request, options do |result, operation|
3176
- result = ::Gapic::Rest::PagedEnumerable.new @dataplex_service_stub, :list_environments, "environments", request, result, options
3177
- yield result, operation if block_given?
3178
- throw :response, result
3179
- end
3180
- rescue ::Gapic::Rest::Error => e
3181
- raise ::Google::Cloud::Error.from_error(e)
3182
- end
3183
-
3184
- ##
3185
- # Get environment resource.
3186
- #
3187
- # @overload get_environment(request, options = nil)
3188
- # Pass arguments to `get_environment` via a request object, either of type
3189
- # {::Google::Cloud::Dataplex::V1::GetEnvironmentRequest} or an equivalent Hash.
3190
- #
3191
- # @param request [::Google::Cloud::Dataplex::V1::GetEnvironmentRequest, ::Hash]
3192
- # A request object representing the call parameters. Required. To specify no
3193
- # parameters, or to keep all the default parameter values, pass an empty Hash.
3194
- # @param options [::Gapic::CallOptions, ::Hash]
3195
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3196
- #
3197
- # @overload get_environment(name: nil)
3198
- # Pass arguments to `get_environment` via keyword arguments. Note that at
3199
- # least one keyword argument is required. To specify no parameters, or to keep all
3200
- # the default parameter values, pass an empty Hash as a request object (see above).
3201
- #
3202
- # @param name [::String]
3203
- # Required. The resource name of the environment:
3204
- # `projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environments/{environment_id}`.
3205
- # @yield [result, operation] Access the result along with the TransportOperation object
3206
- # @yieldparam result [::Google::Cloud::Dataplex::V1::Environment]
3207
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
3208
- #
3209
- # @return [::Google::Cloud::Dataplex::V1::Environment]
3210
- #
3211
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
3212
- #
3213
- # @example Basic example
3214
- # require "google/cloud/dataplex/v1"
3215
- #
3216
- # # Create a client object. The client can be reused for multiple calls.
3217
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
3218
- #
3219
- # # Create a request. To set request fields, pass in keyword arguments.
3220
- # request = Google::Cloud::Dataplex::V1::GetEnvironmentRequest.new
3221
- #
3222
- # # Call the get_environment method.
3223
- # result = client.get_environment request
3224
- #
3225
- # # The returned object is of type Google::Cloud::Dataplex::V1::Environment.
3226
- # p result
3227
- #
3228
- def get_environment request, options = nil
3229
- raise ::ArgumentError, "request must be provided" if request.nil?
3230
-
3231
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetEnvironmentRequest
3232
-
3233
- # Converts hash and nil to an options object
3234
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3235
-
3236
- # Customize the options with defaults
3237
- call_metadata = @config.rpcs.get_environment.metadata.to_h
3238
-
3239
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
3240
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3241
- lib_name: @config.lib_name, lib_version: @config.lib_version,
3242
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
3243
- transports_version_send: [:rest]
3244
-
3245
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
3246
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3247
-
3248
- options.apply_defaults timeout: @config.rpcs.get_environment.timeout,
3249
- metadata: call_metadata,
3250
- retry_policy: @config.rpcs.get_environment.retry_policy
3251
-
3252
- options.apply_defaults timeout: @config.timeout,
3253
- metadata: @config.metadata,
3254
- retry_policy: @config.retry_policy
3255
-
3256
- @dataplex_service_stub.get_environment request, options do |result, operation|
3257
- yield result, operation if block_given?
3258
- end
3259
- rescue ::Gapic::Rest::Error => e
3260
- raise ::Google::Cloud::Error.from_error(e)
3261
- end
3262
-
3263
- ##
3264
- # Lists session resources in an environment.
3265
- #
3266
- # @overload list_sessions(request, options = nil)
3267
- # Pass arguments to `list_sessions` via a request object, either of type
3268
- # {::Google::Cloud::Dataplex::V1::ListSessionsRequest} or an equivalent Hash.
3269
- #
3270
- # @param request [::Google::Cloud::Dataplex::V1::ListSessionsRequest, ::Hash]
3271
- # A request object representing the call parameters. Required. To specify no
3272
- # parameters, or to keep all the default parameter values, pass an empty Hash.
3273
- # @param options [::Gapic::CallOptions, ::Hash]
3274
- # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3275
- #
3276
- # @overload list_sessions(parent: nil, page_size: nil, page_token: nil, filter: nil)
3277
- # Pass arguments to `list_sessions` via keyword arguments. Note that at
3278
- # least one keyword argument is required. To specify no parameters, or to keep all
3279
- # the default parameter values, pass an empty Hash as a request object (see above).
3280
- #
3281
- # @param parent [::String]
3282
- # Required. The resource name of the parent environment:
3283
- # `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}`.
3284
- # @param page_size [::Integer]
3285
- # Optional. Maximum number of sessions to return. The service may return
3286
- # fewer than this value. If unspecified, at most 10 sessions will be
3287
- # returned. The maximum value is 1000; values above 1000 will be coerced to
3288
- # 1000.
3289
- # @param page_token [::String]
3290
- # Optional. Page token received from a previous `ListSessions` call. Provide
3291
- # this to retrieve the subsequent page. When paginating, all other parameters
3292
- # provided to `ListSessions` must match the call that provided the page
3293
- # token.
3294
- # @param filter [::String]
3295
- # Optional. Filter request. The following `mode` filter is supported to
3296
- # return only the sessions belonging to the requester when the mode is USER
3297
- # and return sessions of all the users when the mode is ADMIN. When no filter
3298
- # is sent default to USER mode. NOTE: When the mode is ADMIN, the requester
3299
- # should have `dataplex.environments.listAllSessions` permission to list all
3300
- # sessions, in absence of the permission, the request fails.
3301
- #
3302
- # mode = ADMIN | USER
3303
- # @yield [result, operation] Access the result along with the TransportOperation object
3304
- # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Session>]
3305
- # @yieldparam operation [::Gapic::Rest::TransportOperation]
3306
- #
3307
- # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::Session>]
3308
- #
3309
- # @raise [::Google::Cloud::Error] if the REST call is aborted.
3310
- #
3311
- # @example Basic example
3312
- # require "google/cloud/dataplex/v1"
3313
- #
3314
- # # Create a client object. The client can be reused for multiple calls.
3315
- # client = Google::Cloud::Dataplex::V1::DataplexService::Rest::Client.new
3316
- #
3317
- # # Create a request. To set request fields, pass in keyword arguments.
3318
- # request = Google::Cloud::Dataplex::V1::ListSessionsRequest.new
3319
- #
3320
- # # Call the list_sessions method.
3321
- # result = client.list_sessions request
3322
- #
3323
- # # The returned object is of type Gapic::PagedEnumerable. You can iterate
3324
- # # over elements, and API calls will be issued to fetch pages as needed.
3325
- # result.each do |item|
3326
- # # Each element is of type ::Google::Cloud::Dataplex::V1::Session.
3327
- # p item
3328
- # end
3329
- #
3330
- def list_sessions request, options = nil
3331
- raise ::ArgumentError, "request must be provided" if request.nil?
3332
-
3333
- request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListSessionsRequest
3334
-
3335
- # Converts hash and nil to an options object
3336
- options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
3337
-
3338
- # Customize the options with defaults
3339
- call_metadata = @config.rpcs.list_sessions.metadata.to_h
3340
-
3341
- # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
3342
- call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
3343
- lib_name: @config.lib_name, lib_version: @config.lib_version,
3344
- gapic_version: ::Google::Cloud::Dataplex::V1::VERSION,
3345
- transports_version_send: [:rest]
3346
-
3347
- call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
3348
- call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
3349
-
3350
- options.apply_defaults timeout: @config.rpcs.list_sessions.timeout,
3351
- metadata: call_metadata,
3352
- retry_policy: @config.rpcs.list_sessions.retry_policy
3353
-
3354
- options.apply_defaults timeout: @config.timeout,
3355
- metadata: @config.metadata,
3356
- retry_policy: @config.retry_policy
3357
-
3358
- @dataplex_service_stub.list_sessions request, options do |result, operation|
3359
- result = ::Gapic::Rest::PagedEnumerable.new @dataplex_service_stub, :list_sessions, "sessions", request, result, options
3360
- yield result, operation if block_given?
3361
- throw :response, result
3362
- end
3363
- rescue ::Gapic::Rest::Error => e
3364
- raise ::Google::Cloud::Error.from_error(e)
3365
- end
3366
-
3367
2787
  ##
3368
2788
  # Configuration class for the DataplexService REST API.
3369
2789
  #
@@ -3434,6 +2854,7 @@ module Google
3434
2854
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
3435
2855
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
3436
2856
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
2857
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
3437
2858
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
3438
2859
  # trigger a retry.
3439
2860
  # @return [::Hash]
@@ -3513,6 +2934,7 @@ module Google
3513
2934
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
3514
2935
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
3515
2936
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
2937
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
3516
2938
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
3517
2939
  # trigger a retry.
3518
2940
  #
@@ -3652,36 +3074,6 @@ module Google
3652
3074
  # @return [::Gapic::Config::Method]
3653
3075
  #
3654
3076
  attr_reader :cancel_job
3655
- ##
3656
- # RPC-specific configuration for `create_environment`
3657
- # @return [::Gapic::Config::Method]
3658
- #
3659
- attr_reader :create_environment
3660
- ##
3661
- # RPC-specific configuration for `update_environment`
3662
- # @return [::Gapic::Config::Method]
3663
- #
3664
- attr_reader :update_environment
3665
- ##
3666
- # RPC-specific configuration for `delete_environment`
3667
- # @return [::Gapic::Config::Method]
3668
- #
3669
- attr_reader :delete_environment
3670
- ##
3671
- # RPC-specific configuration for `list_environments`
3672
- # @return [::Gapic::Config::Method]
3673
- #
3674
- attr_reader :list_environments
3675
- ##
3676
- # RPC-specific configuration for `get_environment`
3677
- # @return [::Gapic::Config::Method]
3678
- #
3679
- attr_reader :get_environment
3680
- ##
3681
- # RPC-specific configuration for `list_sessions`
3682
- # @return [::Gapic::Config::Method]
3683
- #
3684
- attr_reader :list_sessions
3685
3077
 
3686
3078
  # @private
3687
3079
  def initialize parent_rpcs = nil
@@ -3739,18 +3131,6 @@ module Google
3739
3131
  @get_job = ::Gapic::Config::Method.new get_job_config
3740
3132
  cancel_job_config = parent_rpcs.cancel_job if parent_rpcs.respond_to? :cancel_job
3741
3133
  @cancel_job = ::Gapic::Config::Method.new cancel_job_config
3742
- create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
3743
- @create_environment = ::Gapic::Config::Method.new create_environment_config
3744
- update_environment_config = parent_rpcs.update_environment if parent_rpcs.respond_to? :update_environment
3745
- @update_environment = ::Gapic::Config::Method.new update_environment_config
3746
- delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
3747
- @delete_environment = ::Gapic::Config::Method.new delete_environment_config
3748
- list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
3749
- @list_environments = ::Gapic::Config::Method.new list_environments_config
3750
- get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
3751
- @get_environment = ::Gapic::Config::Method.new get_environment_config
3752
- list_sessions_config = parent_rpcs.list_sessions if parent_rpcs.respond_to? :list_sessions
3753
- @list_sessions = ::Gapic::Config::Method.new list_sessions_config
3754
3134
 
3755
3135
  yield self if block_given?
3756
3136
  end