google-cloud-data_catalog-lineage-v1 0.a → 0.2.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.
- checksums.yaml +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +149 -0
- data/README.md +144 -8
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb +1971 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/credentials.rb +49 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/operations.rb +770 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/paths.rb +115 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/rest/client.rb +1549 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/rest/operations.rb +795 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/rest/service_stub.rb +1001 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage/rest.rb +58 -0
- data/lib/google/cloud/data_catalog/lineage/v1/lineage.rb +61 -0
- data/lib/google/cloud/data_catalog/lineage/v1/rest.rb +39 -0
- data/lib/google/cloud/data_catalog/lineage/v1/version.rb +7 -2
- data/lib/google/cloud/data_catalog/lineage/v1.rb +47 -0
- data/lib/google/cloud/datacatalog/lineage/v1/lineage_pb.rb +241 -0
- data/lib/google/cloud/datacatalog/lineage/v1/lineage_services_pb.rb +104 -0
- data/lib/google-cloud-data_catalog-lineage-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/field_behavior.rb +71 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +222 -0
- data/proto_docs/google/cloud/datacatalog/lineage/v1/lineage.rb +707 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +141 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +129 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- metadata +192 -12
@@ -0,0 +1,1971 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/errors"
|
20
|
+
require "google/cloud/datacatalog/lineage/v1/lineage_pb"
|
21
|
+
|
22
|
+
module Google
|
23
|
+
module Cloud
|
24
|
+
module DataCatalog
|
25
|
+
module Lineage
|
26
|
+
module V1
|
27
|
+
module Lineage
|
28
|
+
##
|
29
|
+
# Client for the Lineage service.
|
30
|
+
#
|
31
|
+
# Lineage is used to track data flows between assets over time. You can
|
32
|
+
# create {::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent LineageEvents}
|
33
|
+
# to record lineage between multiple sources and a single target, for
|
34
|
+
# example, when table data is based on data from multiple tables.
|
35
|
+
#
|
36
|
+
class Client
|
37
|
+
include Paths
|
38
|
+
|
39
|
+
# @private
|
40
|
+
attr_reader :lineage_stub
|
41
|
+
|
42
|
+
##
|
43
|
+
# Configure the Lineage Client class.
|
44
|
+
#
|
45
|
+
# See {::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client::Configuration}
|
46
|
+
# for a description of the configuration fields.
|
47
|
+
#
|
48
|
+
# @example
|
49
|
+
#
|
50
|
+
# # Modify the configuration for all Lineage clients
|
51
|
+
# ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.configure do |config|
|
52
|
+
# config.timeout = 10.0
|
53
|
+
# end
|
54
|
+
#
|
55
|
+
# @yield [config] Configure the Client client.
|
56
|
+
# @yieldparam config [Client::Configuration]
|
57
|
+
#
|
58
|
+
# @return [Client::Configuration]
|
59
|
+
#
|
60
|
+
def self.configure
|
61
|
+
@configure ||= begin
|
62
|
+
namespace = ["Google", "Cloud", "DataCatalog", "Lineage", "V1"]
|
63
|
+
parent_config = while namespace.any?
|
64
|
+
parent_name = namespace.join "::"
|
65
|
+
parent_const = const_get parent_name
|
66
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
67
|
+
namespace.pop
|
68
|
+
end
|
69
|
+
default_config = Client::Configuration.new parent_config
|
70
|
+
|
71
|
+
default_config.timeout = 60.0
|
72
|
+
default_config.retry_policy = {
|
73
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
74
|
+
}
|
75
|
+
|
76
|
+
default_config
|
77
|
+
end
|
78
|
+
yield @configure if block_given?
|
79
|
+
@configure
|
80
|
+
end
|
81
|
+
|
82
|
+
##
|
83
|
+
# Configure the Lineage Client instance.
|
84
|
+
#
|
85
|
+
# The configuration is set to the derived mode, meaning that values can be changed,
|
86
|
+
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
|
87
|
+
# should be made on {Client.configure}.
|
88
|
+
#
|
89
|
+
# See {::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client::Configuration}
|
90
|
+
# for a description of the configuration fields.
|
91
|
+
#
|
92
|
+
# @yield [config] Configure the Client client.
|
93
|
+
# @yieldparam config [Client::Configuration]
|
94
|
+
#
|
95
|
+
# @return [Client::Configuration]
|
96
|
+
#
|
97
|
+
def configure
|
98
|
+
yield @config if block_given?
|
99
|
+
@config
|
100
|
+
end
|
101
|
+
|
102
|
+
##
|
103
|
+
# Create a new Lineage client object.
|
104
|
+
#
|
105
|
+
# @example
|
106
|
+
#
|
107
|
+
# # Create a client using the default configuration
|
108
|
+
# client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
109
|
+
#
|
110
|
+
# # Create a client using a custom configuration
|
111
|
+
# client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new do |config|
|
112
|
+
# config.timeout = 10.0
|
113
|
+
# end
|
114
|
+
#
|
115
|
+
# @yield [config] Configure the Lineage client.
|
116
|
+
# @yieldparam config [Client::Configuration]
|
117
|
+
#
|
118
|
+
def initialize
|
119
|
+
# These require statements are intentionally placed here to initialize
|
120
|
+
# the gRPC module only when it's required.
|
121
|
+
# See https://github.com/googleapis/toolkit/issues/446
|
122
|
+
require "gapic/grpc"
|
123
|
+
require "google/cloud/datacatalog/lineage/v1/lineage_services_pb"
|
124
|
+
|
125
|
+
# Create the configuration object
|
126
|
+
@config = Configuration.new Client.configure
|
127
|
+
|
128
|
+
# Yield the configuration if needed
|
129
|
+
yield @config if block_given?
|
130
|
+
|
131
|
+
# Create credentials
|
132
|
+
credentials = @config.credentials
|
133
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
134
|
+
# but only if the default endpoint does not have a region prefix.
|
135
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
136
|
+
!@config.endpoint.split(".").first.include?("-")
|
137
|
+
credentials ||= Credentials.default scope: @config.scope,
|
138
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
139
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
140
|
+
credentials = Credentials.new credentials, scope: @config.scope
|
141
|
+
end
|
142
|
+
@quota_project_id = @config.quota_project
|
143
|
+
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
144
|
+
|
145
|
+
@operations_client = Operations.new do |config|
|
146
|
+
config.credentials = credentials
|
147
|
+
config.quota_project = @quota_project_id
|
148
|
+
config.endpoint = @config.endpoint
|
149
|
+
end
|
150
|
+
|
151
|
+
@lineage_stub = ::Gapic::ServiceStub.new(
|
152
|
+
::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Stub,
|
153
|
+
credentials: credentials,
|
154
|
+
endpoint: @config.endpoint,
|
155
|
+
channel_args: @config.channel_args,
|
156
|
+
interceptors: @config.interceptors
|
157
|
+
)
|
158
|
+
end
|
159
|
+
|
160
|
+
##
|
161
|
+
# Get the associated client for long-running operations.
|
162
|
+
#
|
163
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Operations]
|
164
|
+
#
|
165
|
+
attr_reader :operations_client
|
166
|
+
|
167
|
+
# Service calls
|
168
|
+
|
169
|
+
##
|
170
|
+
# Creates a new process.
|
171
|
+
#
|
172
|
+
# @overload create_process(request, options = nil)
|
173
|
+
# Pass arguments to `create_process` via a request object, either of type
|
174
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest} or an equivalent Hash.
|
175
|
+
#
|
176
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest, ::Hash]
|
177
|
+
# A request object representing the call parameters. Required. To specify no
|
178
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
179
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
180
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
181
|
+
#
|
182
|
+
# @overload create_process(parent: nil, process: nil, request_id: nil)
|
183
|
+
# Pass arguments to `create_process` via keyword arguments. Note that at
|
184
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
185
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
186
|
+
#
|
187
|
+
# @param parent [::String]
|
188
|
+
# Required. The name of the project and its location that should own the
|
189
|
+
# process.
|
190
|
+
# @param process [::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash]
|
191
|
+
# Required. The process to create.
|
192
|
+
# @param request_id [::String]
|
193
|
+
# A unique identifier for this request. Restricted to 36 ASCII characters.
|
194
|
+
# A random UUID is recommended. This request is idempotent only if a
|
195
|
+
# `request_id` is provided.
|
196
|
+
#
|
197
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
198
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
199
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
200
|
+
#
|
201
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
202
|
+
#
|
203
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
204
|
+
#
|
205
|
+
# @example Basic example
|
206
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
207
|
+
#
|
208
|
+
# # Create a client object. The client can be reused for multiple calls.
|
209
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
210
|
+
#
|
211
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
212
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest.new
|
213
|
+
#
|
214
|
+
# # Call the create_process method.
|
215
|
+
# result = client.create_process request
|
216
|
+
#
|
217
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process.
|
218
|
+
# p result
|
219
|
+
#
|
220
|
+
def create_process request, options = nil
|
221
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
222
|
+
|
223
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest
|
224
|
+
|
225
|
+
# Converts hash and nil to an options object
|
226
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
227
|
+
|
228
|
+
# Customize the options with defaults
|
229
|
+
metadata = @config.rpcs.create_process.metadata.to_h
|
230
|
+
|
231
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
232
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
233
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
234
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
235
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
236
|
+
|
237
|
+
header_params = {}
|
238
|
+
if request.parent
|
239
|
+
header_params["parent"] = request.parent
|
240
|
+
end
|
241
|
+
|
242
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
243
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
244
|
+
|
245
|
+
options.apply_defaults timeout: @config.rpcs.create_process.timeout,
|
246
|
+
metadata: metadata,
|
247
|
+
retry_policy: @config.rpcs.create_process.retry_policy
|
248
|
+
|
249
|
+
options.apply_defaults timeout: @config.timeout,
|
250
|
+
metadata: @config.metadata,
|
251
|
+
retry_policy: @config.retry_policy
|
252
|
+
|
253
|
+
@lineage_stub.call_rpc :create_process, request, options: options do |response, operation|
|
254
|
+
yield response, operation if block_given?
|
255
|
+
return response
|
256
|
+
end
|
257
|
+
rescue ::GRPC::BadStatus => e
|
258
|
+
raise ::Google::Cloud::Error.from_error(e)
|
259
|
+
end
|
260
|
+
|
261
|
+
##
|
262
|
+
# Updates a process.
|
263
|
+
#
|
264
|
+
# @overload update_process(request, options = nil)
|
265
|
+
# Pass arguments to `update_process` via a request object, either of type
|
266
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest} or an equivalent Hash.
|
267
|
+
#
|
268
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest, ::Hash]
|
269
|
+
# A request object representing the call parameters. Required. To specify no
|
270
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
271
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
272
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
273
|
+
#
|
274
|
+
# @overload update_process(process: nil, update_mask: nil, allow_missing: nil)
|
275
|
+
# Pass arguments to `update_process` via keyword arguments. Note that at
|
276
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
277
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
278
|
+
#
|
279
|
+
# @param process [::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash]
|
280
|
+
# Required. The lineage process to update.
|
281
|
+
#
|
282
|
+
# The process's `name` field is used to identify the process to update.
|
283
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
284
|
+
# The list of fields to update. Currently not used. The whole message is
|
285
|
+
# updated.
|
286
|
+
# @param allow_missing [::Boolean]
|
287
|
+
# If set to true and the process is not found, the request inserts it.
|
288
|
+
#
|
289
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
290
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
291
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
292
|
+
#
|
293
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
294
|
+
#
|
295
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
296
|
+
#
|
297
|
+
# @example Basic example
|
298
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
299
|
+
#
|
300
|
+
# # Create a client object. The client can be reused for multiple calls.
|
301
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
302
|
+
#
|
303
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
304
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest.new
|
305
|
+
#
|
306
|
+
# # Call the update_process method.
|
307
|
+
# result = client.update_process request
|
308
|
+
#
|
309
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process.
|
310
|
+
# p result
|
311
|
+
#
|
312
|
+
def update_process request, options = nil
|
313
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
314
|
+
|
315
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest
|
316
|
+
|
317
|
+
# Converts hash and nil to an options object
|
318
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
319
|
+
|
320
|
+
# Customize the options with defaults
|
321
|
+
metadata = @config.rpcs.update_process.metadata.to_h
|
322
|
+
|
323
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
324
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
325
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
326
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
327
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
328
|
+
|
329
|
+
header_params = {}
|
330
|
+
if request.process&.name
|
331
|
+
header_params["process.name"] = request.process.name
|
332
|
+
end
|
333
|
+
|
334
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
335
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
336
|
+
|
337
|
+
options.apply_defaults timeout: @config.rpcs.update_process.timeout,
|
338
|
+
metadata: metadata,
|
339
|
+
retry_policy: @config.rpcs.update_process.retry_policy
|
340
|
+
|
341
|
+
options.apply_defaults timeout: @config.timeout,
|
342
|
+
metadata: @config.metadata,
|
343
|
+
retry_policy: @config.retry_policy
|
344
|
+
|
345
|
+
@lineage_stub.call_rpc :update_process, request, options: options do |response, operation|
|
346
|
+
yield response, operation if block_given?
|
347
|
+
return response
|
348
|
+
end
|
349
|
+
rescue ::GRPC::BadStatus => e
|
350
|
+
raise ::Google::Cloud::Error.from_error(e)
|
351
|
+
end
|
352
|
+
|
353
|
+
##
|
354
|
+
# Gets the details of the specified process.
|
355
|
+
#
|
356
|
+
# @overload get_process(request, options = nil)
|
357
|
+
# Pass arguments to `get_process` via a request object, either of type
|
358
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest} or an equivalent Hash.
|
359
|
+
#
|
360
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest, ::Hash]
|
361
|
+
# A request object representing the call parameters. Required. To specify no
|
362
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
363
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
364
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
365
|
+
#
|
366
|
+
# @overload get_process(name: nil)
|
367
|
+
# Pass arguments to `get_process` via keyword arguments. Note that at
|
368
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
369
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
370
|
+
#
|
371
|
+
# @param name [::String]
|
372
|
+
# Required. The name of the process to get.
|
373
|
+
#
|
374
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
375
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
376
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
377
|
+
#
|
378
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Process]
|
379
|
+
#
|
380
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
381
|
+
#
|
382
|
+
# @example Basic example
|
383
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
384
|
+
#
|
385
|
+
# # Create a client object. The client can be reused for multiple calls.
|
386
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
387
|
+
#
|
388
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
389
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest.new
|
390
|
+
#
|
391
|
+
# # Call the get_process method.
|
392
|
+
# result = client.get_process request
|
393
|
+
#
|
394
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process.
|
395
|
+
# p result
|
396
|
+
#
|
397
|
+
def get_process request, options = nil
|
398
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
399
|
+
|
400
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest
|
401
|
+
|
402
|
+
# Converts hash and nil to an options object
|
403
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
404
|
+
|
405
|
+
# Customize the options with defaults
|
406
|
+
metadata = @config.rpcs.get_process.metadata.to_h
|
407
|
+
|
408
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
409
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
410
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
411
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
412
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
413
|
+
|
414
|
+
header_params = {}
|
415
|
+
if request.name
|
416
|
+
header_params["name"] = request.name
|
417
|
+
end
|
418
|
+
|
419
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
420
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
421
|
+
|
422
|
+
options.apply_defaults timeout: @config.rpcs.get_process.timeout,
|
423
|
+
metadata: metadata,
|
424
|
+
retry_policy: @config.rpcs.get_process.retry_policy
|
425
|
+
|
426
|
+
options.apply_defaults timeout: @config.timeout,
|
427
|
+
metadata: @config.metadata,
|
428
|
+
retry_policy: @config.retry_policy
|
429
|
+
|
430
|
+
@lineage_stub.call_rpc :get_process, request, options: options do |response, operation|
|
431
|
+
yield response, operation if block_given?
|
432
|
+
return response
|
433
|
+
end
|
434
|
+
rescue ::GRPC::BadStatus => e
|
435
|
+
raise ::Google::Cloud::Error.from_error(e)
|
436
|
+
end
|
437
|
+
|
438
|
+
##
|
439
|
+
# List processes in the given project and location. List order is descending
|
440
|
+
# by insertion time.
|
441
|
+
#
|
442
|
+
# @overload list_processes(request, options = nil)
|
443
|
+
# Pass arguments to `list_processes` via a request object, either of type
|
444
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest} or an equivalent Hash.
|
445
|
+
#
|
446
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest, ::Hash]
|
447
|
+
# A request object representing the call parameters. Required. To specify no
|
448
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
449
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
450
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
451
|
+
#
|
452
|
+
# @overload list_processes(parent: nil, page_size: nil, page_token: nil)
|
453
|
+
# Pass arguments to `list_processes` via keyword arguments. Note that at
|
454
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
455
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
456
|
+
#
|
457
|
+
# @param parent [::String]
|
458
|
+
# Required. The name of the project and its location that owns this
|
459
|
+
# collection of processes.
|
460
|
+
# @param page_size [::Integer]
|
461
|
+
# The maximum number of processes to return. The service may return
|
462
|
+
# fewer than this value. If unspecified, at most 50 processes are
|
463
|
+
# returned. The maximum value is 100; values greater than 100 are cut to
|
464
|
+
# 100.
|
465
|
+
# @param page_token [::String]
|
466
|
+
# The page token received from a previous `ListProcesses` call. Specify
|
467
|
+
# it to get the next page.
|
468
|
+
#
|
469
|
+
# When paginating, all other parameters specified in this call must
|
470
|
+
# match the parameters of the call that provided the page token.
|
471
|
+
#
|
472
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
473
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>]
|
474
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
475
|
+
#
|
476
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>]
|
477
|
+
#
|
478
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
479
|
+
#
|
480
|
+
# @example Basic example
|
481
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
482
|
+
#
|
483
|
+
# # Create a client object. The client can be reused for multiple calls.
|
484
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
485
|
+
#
|
486
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
487
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest.new
|
488
|
+
#
|
489
|
+
# # Call the list_processes method.
|
490
|
+
# result = client.list_processes request
|
491
|
+
#
|
492
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
493
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
494
|
+
# result.each do |item|
|
495
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Process.
|
496
|
+
# p item
|
497
|
+
# end
|
498
|
+
#
|
499
|
+
def list_processes request, options = nil
|
500
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
501
|
+
|
502
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest
|
503
|
+
|
504
|
+
# Converts hash and nil to an options object
|
505
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
506
|
+
|
507
|
+
# Customize the options with defaults
|
508
|
+
metadata = @config.rpcs.list_processes.metadata.to_h
|
509
|
+
|
510
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
511
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
512
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
513
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
514
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
515
|
+
|
516
|
+
header_params = {}
|
517
|
+
if request.parent
|
518
|
+
header_params["parent"] = request.parent
|
519
|
+
end
|
520
|
+
|
521
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
522
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
523
|
+
|
524
|
+
options.apply_defaults timeout: @config.rpcs.list_processes.timeout,
|
525
|
+
metadata: metadata,
|
526
|
+
retry_policy: @config.rpcs.list_processes.retry_policy
|
527
|
+
|
528
|
+
options.apply_defaults timeout: @config.timeout,
|
529
|
+
metadata: @config.metadata,
|
530
|
+
retry_policy: @config.retry_policy
|
531
|
+
|
532
|
+
@lineage_stub.call_rpc :list_processes, request, options: options do |response, operation|
|
533
|
+
response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_processes, request, response, operation, options
|
534
|
+
yield response, operation if block_given?
|
535
|
+
return response
|
536
|
+
end
|
537
|
+
rescue ::GRPC::BadStatus => e
|
538
|
+
raise ::Google::Cloud::Error.from_error(e)
|
539
|
+
end
|
540
|
+
|
541
|
+
##
|
542
|
+
# Deletes the process with the specified name.
|
543
|
+
#
|
544
|
+
# @overload delete_process(request, options = nil)
|
545
|
+
# Pass arguments to `delete_process` via a request object, either of type
|
546
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest} or an equivalent Hash.
|
547
|
+
#
|
548
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest, ::Hash]
|
549
|
+
# A request object representing the call parameters. Required. To specify no
|
550
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
551
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
552
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
553
|
+
#
|
554
|
+
# @overload delete_process(name: nil, allow_missing: nil)
|
555
|
+
# Pass arguments to `delete_process` via keyword arguments. Note that at
|
556
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
557
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
558
|
+
#
|
559
|
+
# @param name [::String]
|
560
|
+
# Required. The name of the process to delete.
|
561
|
+
# @param allow_missing [::Boolean]
|
562
|
+
# If set to true and the process is not found, the request
|
563
|
+
# succeeds but the server doesn't perform any actions.
|
564
|
+
#
|
565
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
566
|
+
# @yieldparam response [::Gapic::Operation]
|
567
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
568
|
+
#
|
569
|
+
# @return [::Gapic::Operation]
|
570
|
+
#
|
571
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
572
|
+
#
|
573
|
+
# @example Basic example
|
574
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
575
|
+
#
|
576
|
+
# # Create a client object. The client can be reused for multiple calls.
|
577
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
578
|
+
#
|
579
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
580
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest.new
|
581
|
+
#
|
582
|
+
# # Call the delete_process method.
|
583
|
+
# result = client.delete_process request
|
584
|
+
#
|
585
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
586
|
+
# # check the status of an operation, cancel it, or wait for results.
|
587
|
+
# # Here is how to wait for a response.
|
588
|
+
# result.wait_until_done! timeout: 60
|
589
|
+
# if result.response?
|
590
|
+
# p result.response
|
591
|
+
# else
|
592
|
+
# puts "No response received."
|
593
|
+
# end
|
594
|
+
#
|
595
|
+
def delete_process request, options = nil
|
596
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
597
|
+
|
598
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest
|
599
|
+
|
600
|
+
# Converts hash and nil to an options object
|
601
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
602
|
+
|
603
|
+
# Customize the options with defaults
|
604
|
+
metadata = @config.rpcs.delete_process.metadata.to_h
|
605
|
+
|
606
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
607
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
608
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
609
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
610
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
611
|
+
|
612
|
+
header_params = {}
|
613
|
+
if request.name
|
614
|
+
header_params["name"] = request.name
|
615
|
+
end
|
616
|
+
|
617
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
618
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
619
|
+
|
620
|
+
options.apply_defaults timeout: @config.rpcs.delete_process.timeout,
|
621
|
+
metadata: metadata,
|
622
|
+
retry_policy: @config.rpcs.delete_process.retry_policy
|
623
|
+
|
624
|
+
options.apply_defaults timeout: @config.timeout,
|
625
|
+
metadata: @config.metadata,
|
626
|
+
retry_policy: @config.retry_policy
|
627
|
+
|
628
|
+
@lineage_stub.call_rpc :delete_process, request, options: options do |response, operation|
|
629
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
630
|
+
yield response, operation if block_given?
|
631
|
+
return response
|
632
|
+
end
|
633
|
+
rescue ::GRPC::BadStatus => e
|
634
|
+
raise ::Google::Cloud::Error.from_error(e)
|
635
|
+
end
|
636
|
+
|
637
|
+
##
|
638
|
+
# Creates a new run.
|
639
|
+
#
|
640
|
+
# @overload create_run(request, options = nil)
|
641
|
+
# Pass arguments to `create_run` via a request object, either of type
|
642
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest} or an equivalent Hash.
|
643
|
+
#
|
644
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest, ::Hash]
|
645
|
+
# A request object representing the call parameters. Required. To specify no
|
646
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
647
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
648
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
649
|
+
#
|
650
|
+
# @overload create_run(parent: nil, run: nil, request_id: nil)
|
651
|
+
# Pass arguments to `create_run` via keyword arguments. Note that at
|
652
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
653
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
654
|
+
#
|
655
|
+
# @param parent [::String]
|
656
|
+
# Required. The name of the process that should own the run.
|
657
|
+
# @param run [::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash]
|
658
|
+
# Required. The run to create.
|
659
|
+
# @param request_id [::String]
|
660
|
+
# A unique identifier for this request. Restricted to 36 ASCII characters.
|
661
|
+
# A random UUID is recommended. This request is idempotent only if a
|
662
|
+
# `request_id` is provided.
|
663
|
+
#
|
664
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
665
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
666
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
667
|
+
#
|
668
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
669
|
+
#
|
670
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
671
|
+
#
|
672
|
+
# @example Basic example
|
673
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
674
|
+
#
|
675
|
+
# # Create a client object. The client can be reused for multiple calls.
|
676
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
677
|
+
#
|
678
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
679
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest.new
|
680
|
+
#
|
681
|
+
# # Call the create_run method.
|
682
|
+
# result = client.create_run request
|
683
|
+
#
|
684
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run.
|
685
|
+
# p result
|
686
|
+
#
|
687
|
+
def create_run request, options = nil
|
688
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
689
|
+
|
690
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest
|
691
|
+
|
692
|
+
# Converts hash and nil to an options object
|
693
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
694
|
+
|
695
|
+
# Customize the options with defaults
|
696
|
+
metadata = @config.rpcs.create_run.metadata.to_h
|
697
|
+
|
698
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
699
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
700
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
701
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
702
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
703
|
+
|
704
|
+
header_params = {}
|
705
|
+
if request.parent
|
706
|
+
header_params["parent"] = request.parent
|
707
|
+
end
|
708
|
+
|
709
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
710
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
711
|
+
|
712
|
+
options.apply_defaults timeout: @config.rpcs.create_run.timeout,
|
713
|
+
metadata: metadata,
|
714
|
+
retry_policy: @config.rpcs.create_run.retry_policy
|
715
|
+
|
716
|
+
options.apply_defaults timeout: @config.timeout,
|
717
|
+
metadata: @config.metadata,
|
718
|
+
retry_policy: @config.retry_policy
|
719
|
+
|
720
|
+
@lineage_stub.call_rpc :create_run, request, options: options do |response, operation|
|
721
|
+
yield response, operation if block_given?
|
722
|
+
return response
|
723
|
+
end
|
724
|
+
rescue ::GRPC::BadStatus => e
|
725
|
+
raise ::Google::Cloud::Error.from_error(e)
|
726
|
+
end
|
727
|
+
|
728
|
+
##
|
729
|
+
# Updates a run.
|
730
|
+
#
|
731
|
+
# @overload update_run(request, options = nil)
|
732
|
+
# Pass arguments to `update_run` via a request object, either of type
|
733
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest} or an equivalent Hash.
|
734
|
+
#
|
735
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest, ::Hash]
|
736
|
+
# A request object representing the call parameters. Required. To specify no
|
737
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
738
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
739
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
740
|
+
#
|
741
|
+
# @overload update_run(run: nil, update_mask: nil)
|
742
|
+
# Pass arguments to `update_run` via keyword arguments. Note that at
|
743
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
744
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
745
|
+
#
|
746
|
+
# @param run [::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash]
|
747
|
+
# Required. The lineage run to update.
|
748
|
+
#
|
749
|
+
# The run's `name` field is used to identify the run to update.
|
750
|
+
#
|
751
|
+
# Format:
|
752
|
+
# `projects/{project}/locations/{location}/processes/{process}/runs/{run}`.
|
753
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
754
|
+
# The list of fields to update. Currently not used. The whole message is
|
755
|
+
# updated.
|
756
|
+
#
|
757
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
758
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
759
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
760
|
+
#
|
761
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
762
|
+
#
|
763
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
764
|
+
#
|
765
|
+
# @example Basic example
|
766
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
767
|
+
#
|
768
|
+
# # Create a client object. The client can be reused for multiple calls.
|
769
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
770
|
+
#
|
771
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
772
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest.new
|
773
|
+
#
|
774
|
+
# # Call the update_run method.
|
775
|
+
# result = client.update_run request
|
776
|
+
#
|
777
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run.
|
778
|
+
# p result
|
779
|
+
#
|
780
|
+
def update_run request, options = nil
|
781
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
782
|
+
|
783
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest
|
784
|
+
|
785
|
+
# Converts hash and nil to an options object
|
786
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
787
|
+
|
788
|
+
# Customize the options with defaults
|
789
|
+
metadata = @config.rpcs.update_run.metadata.to_h
|
790
|
+
|
791
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
792
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
793
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
794
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
795
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
796
|
+
|
797
|
+
header_params = {}
|
798
|
+
if request.run&.name
|
799
|
+
header_params["run.name"] = request.run.name
|
800
|
+
end
|
801
|
+
|
802
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
803
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
804
|
+
|
805
|
+
options.apply_defaults timeout: @config.rpcs.update_run.timeout,
|
806
|
+
metadata: metadata,
|
807
|
+
retry_policy: @config.rpcs.update_run.retry_policy
|
808
|
+
|
809
|
+
options.apply_defaults timeout: @config.timeout,
|
810
|
+
metadata: @config.metadata,
|
811
|
+
retry_policy: @config.retry_policy
|
812
|
+
|
813
|
+
@lineage_stub.call_rpc :update_run, request, options: options do |response, operation|
|
814
|
+
yield response, operation if block_given?
|
815
|
+
return response
|
816
|
+
end
|
817
|
+
rescue ::GRPC::BadStatus => e
|
818
|
+
raise ::Google::Cloud::Error.from_error(e)
|
819
|
+
end
|
820
|
+
|
821
|
+
##
|
822
|
+
# Gets the details of the specified run.
|
823
|
+
#
|
824
|
+
# @overload get_run(request, options = nil)
|
825
|
+
# Pass arguments to `get_run` via a request object, either of type
|
826
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest} or an equivalent Hash.
|
827
|
+
#
|
828
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest, ::Hash]
|
829
|
+
# A request object representing the call parameters. Required. To specify no
|
830
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
831
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
832
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
833
|
+
#
|
834
|
+
# @overload get_run(name: nil)
|
835
|
+
# Pass arguments to `get_run` via keyword arguments. Note that at
|
836
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
837
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
838
|
+
#
|
839
|
+
# @param name [::String]
|
840
|
+
# Required. The name of the run to get.
|
841
|
+
#
|
842
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
843
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
844
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
845
|
+
#
|
846
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::Run]
|
847
|
+
#
|
848
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
849
|
+
#
|
850
|
+
# @example Basic example
|
851
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
852
|
+
#
|
853
|
+
# # Create a client object. The client can be reused for multiple calls.
|
854
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
855
|
+
#
|
856
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
857
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest.new
|
858
|
+
#
|
859
|
+
# # Call the get_run method.
|
860
|
+
# result = client.get_run request
|
861
|
+
#
|
862
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run.
|
863
|
+
# p result
|
864
|
+
#
|
865
|
+
def get_run request, options = nil
|
866
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
867
|
+
|
868
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest
|
869
|
+
|
870
|
+
# Converts hash and nil to an options object
|
871
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
872
|
+
|
873
|
+
# Customize the options with defaults
|
874
|
+
metadata = @config.rpcs.get_run.metadata.to_h
|
875
|
+
|
876
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
877
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
878
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
879
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
880
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
881
|
+
|
882
|
+
header_params = {}
|
883
|
+
if request.name
|
884
|
+
header_params["name"] = request.name
|
885
|
+
end
|
886
|
+
|
887
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
888
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
889
|
+
|
890
|
+
options.apply_defaults timeout: @config.rpcs.get_run.timeout,
|
891
|
+
metadata: metadata,
|
892
|
+
retry_policy: @config.rpcs.get_run.retry_policy
|
893
|
+
|
894
|
+
options.apply_defaults timeout: @config.timeout,
|
895
|
+
metadata: @config.metadata,
|
896
|
+
retry_policy: @config.retry_policy
|
897
|
+
|
898
|
+
@lineage_stub.call_rpc :get_run, request, options: options do |response, operation|
|
899
|
+
yield response, operation if block_given?
|
900
|
+
return response
|
901
|
+
end
|
902
|
+
rescue ::GRPC::BadStatus => e
|
903
|
+
raise ::Google::Cloud::Error.from_error(e)
|
904
|
+
end
|
905
|
+
|
906
|
+
##
|
907
|
+
# Lists runs in the given project and location. List order is descending by
|
908
|
+
# `start_time`.
|
909
|
+
#
|
910
|
+
# @overload list_runs(request, options = nil)
|
911
|
+
# Pass arguments to `list_runs` via a request object, either of type
|
912
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest} or an equivalent Hash.
|
913
|
+
#
|
914
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest, ::Hash]
|
915
|
+
# A request object representing the call parameters. Required. To specify no
|
916
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
917
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
918
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
919
|
+
#
|
920
|
+
# @overload list_runs(parent: nil, page_size: nil, page_token: nil)
|
921
|
+
# Pass arguments to `list_runs` via keyword arguments. Note that at
|
922
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
923
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
924
|
+
#
|
925
|
+
# @param parent [::String]
|
926
|
+
# Required. The name of process that owns this collection of runs.
|
927
|
+
# @param page_size [::Integer]
|
928
|
+
# The maximum number of runs to return. The service may return
|
929
|
+
# fewer than this value. If unspecified, at most 50 runs are
|
930
|
+
# returned. The maximum value is 100; values greater than 100 are cut to
|
931
|
+
# 100.
|
932
|
+
# @param page_token [::String]
|
933
|
+
# The page token received from a previous `ListRuns` call. Specify
|
934
|
+
# it to get the next page.
|
935
|
+
#
|
936
|
+
# When paginating, all other parameters specified in this call must
|
937
|
+
# match the parameters of the call that provided the page token.
|
938
|
+
#
|
939
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
940
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>]
|
941
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
942
|
+
#
|
943
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>]
|
944
|
+
#
|
945
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
946
|
+
#
|
947
|
+
# @example Basic example
|
948
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
949
|
+
#
|
950
|
+
# # Create a client object. The client can be reused for multiple calls.
|
951
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
952
|
+
#
|
953
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
954
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest.new
|
955
|
+
#
|
956
|
+
# # Call the list_runs method.
|
957
|
+
# result = client.list_runs request
|
958
|
+
#
|
959
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
960
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
961
|
+
# result.each do |item|
|
962
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Run.
|
963
|
+
# p item
|
964
|
+
# end
|
965
|
+
#
|
966
|
+
def list_runs request, options = nil
|
967
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
968
|
+
|
969
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest
|
970
|
+
|
971
|
+
# Converts hash and nil to an options object
|
972
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
973
|
+
|
974
|
+
# Customize the options with defaults
|
975
|
+
metadata = @config.rpcs.list_runs.metadata.to_h
|
976
|
+
|
977
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
978
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
979
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
980
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
981
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
982
|
+
|
983
|
+
header_params = {}
|
984
|
+
if request.parent
|
985
|
+
header_params["parent"] = request.parent
|
986
|
+
end
|
987
|
+
|
988
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
989
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
990
|
+
|
991
|
+
options.apply_defaults timeout: @config.rpcs.list_runs.timeout,
|
992
|
+
metadata: metadata,
|
993
|
+
retry_policy: @config.rpcs.list_runs.retry_policy
|
994
|
+
|
995
|
+
options.apply_defaults timeout: @config.timeout,
|
996
|
+
metadata: @config.metadata,
|
997
|
+
retry_policy: @config.retry_policy
|
998
|
+
|
999
|
+
@lineage_stub.call_rpc :list_runs, request, options: options do |response, operation|
|
1000
|
+
response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_runs, request, response, operation, options
|
1001
|
+
yield response, operation if block_given?
|
1002
|
+
return response
|
1003
|
+
end
|
1004
|
+
rescue ::GRPC::BadStatus => e
|
1005
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
##
|
1009
|
+
# Deletes the run with the specified name.
|
1010
|
+
#
|
1011
|
+
# @overload delete_run(request, options = nil)
|
1012
|
+
# Pass arguments to `delete_run` via a request object, either of type
|
1013
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest} or an equivalent Hash.
|
1014
|
+
#
|
1015
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest, ::Hash]
|
1016
|
+
# A request object representing the call parameters. Required. To specify no
|
1017
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1018
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1019
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1020
|
+
#
|
1021
|
+
# @overload delete_run(name: nil, allow_missing: nil)
|
1022
|
+
# Pass arguments to `delete_run` via keyword arguments. Note that at
|
1023
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1024
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1025
|
+
#
|
1026
|
+
# @param name [::String]
|
1027
|
+
# Required. The name of the run to delete.
|
1028
|
+
# @param allow_missing [::Boolean]
|
1029
|
+
# If set to true and the run is not found, the request
|
1030
|
+
# succeeds but the server doesn't perform any actions.
|
1031
|
+
#
|
1032
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1033
|
+
# @yieldparam response [::Gapic::Operation]
|
1034
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1035
|
+
#
|
1036
|
+
# @return [::Gapic::Operation]
|
1037
|
+
#
|
1038
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1039
|
+
#
|
1040
|
+
# @example Basic example
|
1041
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1042
|
+
#
|
1043
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1044
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1045
|
+
#
|
1046
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1047
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest.new
|
1048
|
+
#
|
1049
|
+
# # Call the delete_run method.
|
1050
|
+
# result = client.delete_run request
|
1051
|
+
#
|
1052
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
1053
|
+
# # check the status of an operation, cancel it, or wait for results.
|
1054
|
+
# # Here is how to wait for a response.
|
1055
|
+
# result.wait_until_done! timeout: 60
|
1056
|
+
# if result.response?
|
1057
|
+
# p result.response
|
1058
|
+
# else
|
1059
|
+
# puts "No response received."
|
1060
|
+
# end
|
1061
|
+
#
|
1062
|
+
def delete_run request, options = nil
|
1063
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1064
|
+
|
1065
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest
|
1066
|
+
|
1067
|
+
# Converts hash and nil to an options object
|
1068
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1069
|
+
|
1070
|
+
# Customize the options with defaults
|
1071
|
+
metadata = @config.rpcs.delete_run.metadata.to_h
|
1072
|
+
|
1073
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1074
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1075
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1076
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1077
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1078
|
+
|
1079
|
+
header_params = {}
|
1080
|
+
if request.name
|
1081
|
+
header_params["name"] = request.name
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1085
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1086
|
+
|
1087
|
+
options.apply_defaults timeout: @config.rpcs.delete_run.timeout,
|
1088
|
+
metadata: metadata,
|
1089
|
+
retry_policy: @config.rpcs.delete_run.retry_policy
|
1090
|
+
|
1091
|
+
options.apply_defaults timeout: @config.timeout,
|
1092
|
+
metadata: @config.metadata,
|
1093
|
+
retry_policy: @config.retry_policy
|
1094
|
+
|
1095
|
+
@lineage_stub.call_rpc :delete_run, request, options: options do |response, operation|
|
1096
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
1097
|
+
yield response, operation if block_given?
|
1098
|
+
return response
|
1099
|
+
end
|
1100
|
+
rescue ::GRPC::BadStatus => e
|
1101
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
##
|
1105
|
+
# Creates a new lineage event.
|
1106
|
+
#
|
1107
|
+
# @overload create_lineage_event(request, options = nil)
|
1108
|
+
# Pass arguments to `create_lineage_event` via a request object, either of type
|
1109
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest} or an equivalent Hash.
|
1110
|
+
#
|
1111
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest, ::Hash]
|
1112
|
+
# A request object representing the call parameters. Required. To specify no
|
1113
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1114
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1115
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1116
|
+
#
|
1117
|
+
# @overload create_lineage_event(parent: nil, lineage_event: nil, request_id: nil)
|
1118
|
+
# Pass arguments to `create_lineage_event` via keyword arguments. Note that at
|
1119
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1120
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1121
|
+
#
|
1122
|
+
# @param parent [::String]
|
1123
|
+
# Required. The name of the run that should own the lineage event.
|
1124
|
+
# @param lineage_event [::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent, ::Hash]
|
1125
|
+
# Required. The lineage event to create.
|
1126
|
+
# @param request_id [::String]
|
1127
|
+
# A unique identifier for this request. Restricted to 36 ASCII characters.
|
1128
|
+
# A random UUID is recommended. This request is idempotent only if a
|
1129
|
+
# `request_id` is provided.
|
1130
|
+
#
|
1131
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1132
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent]
|
1133
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1134
|
+
#
|
1135
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent]
|
1136
|
+
#
|
1137
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1138
|
+
#
|
1139
|
+
# @example Basic example
|
1140
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1141
|
+
#
|
1142
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1143
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1144
|
+
#
|
1145
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1146
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest.new
|
1147
|
+
#
|
1148
|
+
# # Call the create_lineage_event method.
|
1149
|
+
# result = client.create_lineage_event request
|
1150
|
+
#
|
1151
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::LineageEvent.
|
1152
|
+
# p result
|
1153
|
+
#
|
1154
|
+
def create_lineage_event request, options = nil
|
1155
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1156
|
+
|
1157
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest
|
1158
|
+
|
1159
|
+
# Converts hash and nil to an options object
|
1160
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1161
|
+
|
1162
|
+
# Customize the options with defaults
|
1163
|
+
metadata = @config.rpcs.create_lineage_event.metadata.to_h
|
1164
|
+
|
1165
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1166
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1167
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1168
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1169
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1170
|
+
|
1171
|
+
header_params = {}
|
1172
|
+
if request.parent
|
1173
|
+
header_params["parent"] = request.parent
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1177
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1178
|
+
|
1179
|
+
options.apply_defaults timeout: @config.rpcs.create_lineage_event.timeout,
|
1180
|
+
metadata: metadata,
|
1181
|
+
retry_policy: @config.rpcs.create_lineage_event.retry_policy
|
1182
|
+
|
1183
|
+
options.apply_defaults timeout: @config.timeout,
|
1184
|
+
metadata: @config.metadata,
|
1185
|
+
retry_policy: @config.retry_policy
|
1186
|
+
|
1187
|
+
@lineage_stub.call_rpc :create_lineage_event, request, options: options do |response, operation|
|
1188
|
+
yield response, operation if block_given?
|
1189
|
+
return response
|
1190
|
+
end
|
1191
|
+
rescue ::GRPC::BadStatus => e
|
1192
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1193
|
+
end
|
1194
|
+
|
1195
|
+
##
|
1196
|
+
# Gets details of a specified lineage event.
|
1197
|
+
#
|
1198
|
+
# @overload get_lineage_event(request, options = nil)
|
1199
|
+
# Pass arguments to `get_lineage_event` via a request object, either of type
|
1200
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest} or an equivalent Hash.
|
1201
|
+
#
|
1202
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest, ::Hash]
|
1203
|
+
# A request object representing the call parameters. Required. To specify no
|
1204
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1205
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1206
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1207
|
+
#
|
1208
|
+
# @overload get_lineage_event(name: nil)
|
1209
|
+
# Pass arguments to `get_lineage_event` via keyword arguments. Note that at
|
1210
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1211
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1212
|
+
#
|
1213
|
+
# @param name [::String]
|
1214
|
+
# Required. The name of the lineage event to get.
|
1215
|
+
#
|
1216
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1217
|
+
# @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent]
|
1218
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1219
|
+
#
|
1220
|
+
# @return [::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent]
|
1221
|
+
#
|
1222
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1223
|
+
#
|
1224
|
+
# @example Basic example
|
1225
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1226
|
+
#
|
1227
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1228
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1229
|
+
#
|
1230
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1231
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest.new
|
1232
|
+
#
|
1233
|
+
# # Call the get_lineage_event method.
|
1234
|
+
# result = client.get_lineage_event request
|
1235
|
+
#
|
1236
|
+
# # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::LineageEvent.
|
1237
|
+
# p result
|
1238
|
+
#
|
1239
|
+
def get_lineage_event request, options = nil
|
1240
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1241
|
+
|
1242
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest
|
1243
|
+
|
1244
|
+
# Converts hash and nil to an options object
|
1245
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1246
|
+
|
1247
|
+
# Customize the options with defaults
|
1248
|
+
metadata = @config.rpcs.get_lineage_event.metadata.to_h
|
1249
|
+
|
1250
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1251
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1252
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1253
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1254
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1255
|
+
|
1256
|
+
header_params = {}
|
1257
|
+
if request.name
|
1258
|
+
header_params["name"] = request.name
|
1259
|
+
end
|
1260
|
+
|
1261
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1262
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1263
|
+
|
1264
|
+
options.apply_defaults timeout: @config.rpcs.get_lineage_event.timeout,
|
1265
|
+
metadata: metadata,
|
1266
|
+
retry_policy: @config.rpcs.get_lineage_event.retry_policy
|
1267
|
+
|
1268
|
+
options.apply_defaults timeout: @config.timeout,
|
1269
|
+
metadata: @config.metadata,
|
1270
|
+
retry_policy: @config.retry_policy
|
1271
|
+
|
1272
|
+
@lineage_stub.call_rpc :get_lineage_event, request, options: options do |response, operation|
|
1273
|
+
yield response, operation if block_given?
|
1274
|
+
return response
|
1275
|
+
end
|
1276
|
+
rescue ::GRPC::BadStatus => e
|
1277
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1278
|
+
end
|
1279
|
+
|
1280
|
+
##
|
1281
|
+
# Lists lineage events in the given project and location. The list order is
|
1282
|
+
# not defined.
|
1283
|
+
#
|
1284
|
+
# @overload list_lineage_events(request, options = nil)
|
1285
|
+
# Pass arguments to `list_lineage_events` via a request object, either of type
|
1286
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest} or an equivalent Hash.
|
1287
|
+
#
|
1288
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest, ::Hash]
|
1289
|
+
# A request object representing the call parameters. Required. To specify no
|
1290
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1291
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1292
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1293
|
+
#
|
1294
|
+
# @overload list_lineage_events(parent: nil, page_size: nil, page_token: nil)
|
1295
|
+
# Pass arguments to `list_lineage_events` via keyword arguments. Note that at
|
1296
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1297
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1298
|
+
#
|
1299
|
+
# @param parent [::String]
|
1300
|
+
# Required. The name of the run that owns the collection of lineage events to
|
1301
|
+
# get.
|
1302
|
+
# @param page_size [::Integer]
|
1303
|
+
# The maximum number of lineage events to return.
|
1304
|
+
#
|
1305
|
+
# The service may return fewer events than this value.
|
1306
|
+
# If unspecified, at most 50 events are returned. The maximum value is 100;
|
1307
|
+
# values greater than 100 are cut to 100.
|
1308
|
+
# @param page_token [::String]
|
1309
|
+
# The page token received from a previous `ListLineageEvents` call. Specify
|
1310
|
+
# it to get the next page.
|
1311
|
+
#
|
1312
|
+
# When paginating, all other parameters specified in this call must
|
1313
|
+
# match the parameters of the call that provided the page token.
|
1314
|
+
#
|
1315
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1316
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>]
|
1317
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1318
|
+
#
|
1319
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>]
|
1320
|
+
#
|
1321
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1322
|
+
#
|
1323
|
+
# @example Basic example
|
1324
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1325
|
+
#
|
1326
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1327
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1328
|
+
#
|
1329
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1330
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest.new
|
1331
|
+
#
|
1332
|
+
# # Call the list_lineage_events method.
|
1333
|
+
# result = client.list_lineage_events request
|
1334
|
+
#
|
1335
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1336
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1337
|
+
# result.each do |item|
|
1338
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent.
|
1339
|
+
# p item
|
1340
|
+
# end
|
1341
|
+
#
|
1342
|
+
def list_lineage_events request, options = nil
|
1343
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1344
|
+
|
1345
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest
|
1346
|
+
|
1347
|
+
# Converts hash and nil to an options object
|
1348
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1349
|
+
|
1350
|
+
# Customize the options with defaults
|
1351
|
+
metadata = @config.rpcs.list_lineage_events.metadata.to_h
|
1352
|
+
|
1353
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1354
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1355
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1356
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1357
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1358
|
+
|
1359
|
+
header_params = {}
|
1360
|
+
if request.parent
|
1361
|
+
header_params["parent"] = request.parent
|
1362
|
+
end
|
1363
|
+
|
1364
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1365
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1366
|
+
|
1367
|
+
options.apply_defaults timeout: @config.rpcs.list_lineage_events.timeout,
|
1368
|
+
metadata: metadata,
|
1369
|
+
retry_policy: @config.rpcs.list_lineage_events.retry_policy
|
1370
|
+
|
1371
|
+
options.apply_defaults timeout: @config.timeout,
|
1372
|
+
metadata: @config.metadata,
|
1373
|
+
retry_policy: @config.retry_policy
|
1374
|
+
|
1375
|
+
@lineage_stub.call_rpc :list_lineage_events, request, options: options do |response, operation|
|
1376
|
+
response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_lineage_events, request, response, operation, options
|
1377
|
+
yield response, operation if block_given?
|
1378
|
+
return response
|
1379
|
+
end
|
1380
|
+
rescue ::GRPC::BadStatus => e
|
1381
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1382
|
+
end
|
1383
|
+
|
1384
|
+
##
|
1385
|
+
# Deletes the lineage event with the specified name.
|
1386
|
+
#
|
1387
|
+
# @overload delete_lineage_event(request, options = nil)
|
1388
|
+
# Pass arguments to `delete_lineage_event` via a request object, either of type
|
1389
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest} or an equivalent Hash.
|
1390
|
+
#
|
1391
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest, ::Hash]
|
1392
|
+
# A request object representing the call parameters. Required. To specify no
|
1393
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1394
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1395
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1396
|
+
#
|
1397
|
+
# @overload delete_lineage_event(name: nil, allow_missing: nil)
|
1398
|
+
# Pass arguments to `delete_lineage_event` via keyword arguments. Note that at
|
1399
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1400
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1401
|
+
#
|
1402
|
+
# @param name [::String]
|
1403
|
+
# Required. The name of the lineage event to delete.
|
1404
|
+
# @param allow_missing [::Boolean]
|
1405
|
+
# If set to true and the lineage event is not found, the request
|
1406
|
+
# succeeds but the server doesn't perform any actions.
|
1407
|
+
#
|
1408
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1409
|
+
# @yieldparam response [::Google::Protobuf::Empty]
|
1410
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1411
|
+
#
|
1412
|
+
# @return [::Google::Protobuf::Empty]
|
1413
|
+
#
|
1414
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1415
|
+
#
|
1416
|
+
# @example Basic example
|
1417
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1418
|
+
#
|
1419
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1420
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1421
|
+
#
|
1422
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1423
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest.new
|
1424
|
+
#
|
1425
|
+
# # Call the delete_lineage_event method.
|
1426
|
+
# result = client.delete_lineage_event request
|
1427
|
+
#
|
1428
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1429
|
+
# p result
|
1430
|
+
#
|
1431
|
+
def delete_lineage_event request, options = nil
|
1432
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1433
|
+
|
1434
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest
|
1435
|
+
|
1436
|
+
# Converts hash and nil to an options object
|
1437
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1438
|
+
|
1439
|
+
# Customize the options with defaults
|
1440
|
+
metadata = @config.rpcs.delete_lineage_event.metadata.to_h
|
1441
|
+
|
1442
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1443
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1444
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1445
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1446
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1447
|
+
|
1448
|
+
header_params = {}
|
1449
|
+
if request.name
|
1450
|
+
header_params["name"] = request.name
|
1451
|
+
end
|
1452
|
+
|
1453
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1454
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1455
|
+
|
1456
|
+
options.apply_defaults timeout: @config.rpcs.delete_lineage_event.timeout,
|
1457
|
+
metadata: metadata,
|
1458
|
+
retry_policy: @config.rpcs.delete_lineage_event.retry_policy
|
1459
|
+
|
1460
|
+
options.apply_defaults timeout: @config.timeout,
|
1461
|
+
metadata: @config.metadata,
|
1462
|
+
retry_policy: @config.retry_policy
|
1463
|
+
|
1464
|
+
@lineage_stub.call_rpc :delete_lineage_event, request, options: options do |response, operation|
|
1465
|
+
yield response, operation if block_given?
|
1466
|
+
return response
|
1467
|
+
end
|
1468
|
+
rescue ::GRPC::BadStatus => e
|
1469
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1470
|
+
end
|
1471
|
+
|
1472
|
+
##
|
1473
|
+
# Retrieve a list of links connected to a specific asset.
|
1474
|
+
# Links represent the data flow between **source** (upstream)
|
1475
|
+
# and **target** (downstream) assets in transformation pipelines.
|
1476
|
+
# Links are stored in the same project as the Lineage Events that create
|
1477
|
+
# them.
|
1478
|
+
#
|
1479
|
+
# You can retrieve links in every project where you have the
|
1480
|
+
# `datalineage.events.get` permission. The project provided in the URL
|
1481
|
+
# is used for Billing and Quota.
|
1482
|
+
#
|
1483
|
+
# @overload search_links(request, options = nil)
|
1484
|
+
# Pass arguments to `search_links` via a request object, either of type
|
1485
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest} or an equivalent Hash.
|
1486
|
+
#
|
1487
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest, ::Hash]
|
1488
|
+
# A request object representing the call parameters. Required. To specify no
|
1489
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1490
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1491
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1492
|
+
#
|
1493
|
+
# @overload search_links(parent: nil, source: nil, target: nil, page_size: nil, page_token: nil)
|
1494
|
+
# Pass arguments to `search_links` via keyword arguments. Note that at
|
1495
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1496
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1497
|
+
#
|
1498
|
+
# @param parent [::String]
|
1499
|
+
# Required. The project and location you want search in.
|
1500
|
+
# @param source [::Google::Cloud::DataCatalog::Lineage::V1::EntityReference, ::Hash]
|
1501
|
+
# Optional. Send asset information in the **source** field to retrieve all
|
1502
|
+
# links that lead from the specified asset to downstream assets.
|
1503
|
+
# @param target [::Google::Cloud::DataCatalog::Lineage::V1::EntityReference, ::Hash]
|
1504
|
+
# Optional. Send asset information in the **target** field to retrieve all
|
1505
|
+
# links that lead from upstream assets to the specified asset.
|
1506
|
+
# @param page_size [::Integer]
|
1507
|
+
# Optional. The maximum number of links to return in a single page of the
|
1508
|
+
# response. A page may contain fewer links than this value. If unspecified,
|
1509
|
+
# at most 10 links are returned.
|
1510
|
+
#
|
1511
|
+
# Maximum value is 100; values greater than 100 are reduced to 100.
|
1512
|
+
# @param page_token [::String]
|
1513
|
+
# Optional. The page token received from a previous `SearchLinksRequest`
|
1514
|
+
# call. Use it to get the next page.
|
1515
|
+
#
|
1516
|
+
# When requesting subsequent pages of a response, remember that
|
1517
|
+
# all parameters must match the values you provided
|
1518
|
+
# in the original request.
|
1519
|
+
#
|
1520
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1521
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>]
|
1522
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1523
|
+
#
|
1524
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>]
|
1525
|
+
#
|
1526
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1527
|
+
#
|
1528
|
+
# @example Basic example
|
1529
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1530
|
+
#
|
1531
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1532
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1533
|
+
#
|
1534
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1535
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest.new
|
1536
|
+
#
|
1537
|
+
# # Call the search_links method.
|
1538
|
+
# result = client.search_links request
|
1539
|
+
#
|
1540
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1541
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1542
|
+
# result.each do |item|
|
1543
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Link.
|
1544
|
+
# p item
|
1545
|
+
# end
|
1546
|
+
#
|
1547
|
+
def search_links request, options = nil
|
1548
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1549
|
+
|
1550
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest
|
1551
|
+
|
1552
|
+
# Converts hash and nil to an options object
|
1553
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1554
|
+
|
1555
|
+
# Customize the options with defaults
|
1556
|
+
metadata = @config.rpcs.search_links.metadata.to_h
|
1557
|
+
|
1558
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1559
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1560
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1561
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1562
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1563
|
+
|
1564
|
+
header_params = {}
|
1565
|
+
if request.parent
|
1566
|
+
header_params["parent"] = request.parent
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1570
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1571
|
+
|
1572
|
+
options.apply_defaults timeout: @config.rpcs.search_links.timeout,
|
1573
|
+
metadata: metadata,
|
1574
|
+
retry_policy: @config.rpcs.search_links.retry_policy
|
1575
|
+
|
1576
|
+
options.apply_defaults timeout: @config.timeout,
|
1577
|
+
metadata: @config.metadata,
|
1578
|
+
retry_policy: @config.retry_policy
|
1579
|
+
|
1580
|
+
@lineage_stub.call_rpc :search_links, request, options: options do |response, operation|
|
1581
|
+
response = ::Gapic::PagedEnumerable.new @lineage_stub, :search_links, request, response, operation, options
|
1582
|
+
yield response, operation if block_given?
|
1583
|
+
return response
|
1584
|
+
end
|
1585
|
+
rescue ::GRPC::BadStatus => e
|
1586
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1587
|
+
end
|
1588
|
+
|
1589
|
+
##
|
1590
|
+
# Retrieve information about LineageProcesses associated with specific
|
1591
|
+
# links. LineageProcesses are transformation pipelines that result in data
|
1592
|
+
# flowing from **source** to **target** assets. Links between assets
|
1593
|
+
# represent this operation.
|
1594
|
+
#
|
1595
|
+
# If you have specific link names, you can use this method to
|
1596
|
+
# verify which LineageProcesses contribute to creating those links.
|
1597
|
+
# See the
|
1598
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client#search_links SearchLinks}
|
1599
|
+
# method for more information on how to retrieve link name.
|
1600
|
+
#
|
1601
|
+
# You can retrieve the LineageProcess information in every project where you
|
1602
|
+
# have the `datalineage.events.get` permission. The project provided in the
|
1603
|
+
# URL is used for Billing and Quota.
|
1604
|
+
#
|
1605
|
+
# @overload batch_search_link_processes(request, options = nil)
|
1606
|
+
# Pass arguments to `batch_search_link_processes` via a request object, either of type
|
1607
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest} or an equivalent Hash.
|
1608
|
+
#
|
1609
|
+
# @param request [::Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest, ::Hash]
|
1610
|
+
# A request object representing the call parameters. Required. To specify no
|
1611
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1612
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1613
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1614
|
+
#
|
1615
|
+
# @overload batch_search_link_processes(parent: nil, links: nil, page_size: nil, page_token: nil)
|
1616
|
+
# Pass arguments to `batch_search_link_processes` via keyword arguments. Note that at
|
1617
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1618
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1619
|
+
#
|
1620
|
+
# @param parent [::String]
|
1621
|
+
# Required. The project and location where you want to search.
|
1622
|
+
# @param links [::Array<::String>]
|
1623
|
+
# Required. An array of links to check for their associated LineageProcesses.
|
1624
|
+
#
|
1625
|
+
# The maximum number of items in this array is 100.
|
1626
|
+
# If the request contains more than 100 links, it returns the
|
1627
|
+
# `INVALID_ARGUMENT` error.
|
1628
|
+
#
|
1629
|
+
# Format: `projects/{project}/locations/{location}/links/{link}`.
|
1630
|
+
# @param page_size [::Integer]
|
1631
|
+
# The maximum number of processes to return in a single page of the response.
|
1632
|
+
# A page may contain fewer results than this value.
|
1633
|
+
# @param page_token [::String]
|
1634
|
+
# The page token received from a previous `BatchSearchLinkProcesses` call.
|
1635
|
+
# Use it to get the next page.
|
1636
|
+
#
|
1637
|
+
# When requesting subsequent pages of a response, remember that
|
1638
|
+
# all parameters must match the values you provided
|
1639
|
+
# in the original request.
|
1640
|
+
#
|
1641
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
1642
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>]
|
1643
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
1644
|
+
#
|
1645
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>]
|
1646
|
+
#
|
1647
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
1648
|
+
#
|
1649
|
+
# @example Basic example
|
1650
|
+
# require "google/cloud/data_catalog/lineage/v1"
|
1651
|
+
#
|
1652
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1653
|
+
# client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
|
1654
|
+
#
|
1655
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1656
|
+
# request = Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest.new
|
1657
|
+
#
|
1658
|
+
# # Call the batch_search_link_processes method.
|
1659
|
+
# result = client.batch_search_link_processes request
|
1660
|
+
#
|
1661
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1662
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1663
|
+
# result.each do |item|
|
1664
|
+
# # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks.
|
1665
|
+
# p item
|
1666
|
+
# end
|
1667
|
+
#
|
1668
|
+
def batch_search_link_processes request, options = nil
|
1669
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1670
|
+
|
1671
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest
|
1672
|
+
|
1673
|
+
# Converts hash and nil to an options object
|
1674
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1675
|
+
|
1676
|
+
# Customize the options with defaults
|
1677
|
+
metadata = @config.rpcs.batch_search_link_processes.metadata.to_h
|
1678
|
+
|
1679
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1680
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1681
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1682
|
+
gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
|
1683
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1684
|
+
|
1685
|
+
header_params = {}
|
1686
|
+
if request.parent
|
1687
|
+
header_params["parent"] = request.parent
|
1688
|
+
end
|
1689
|
+
|
1690
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
1691
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
1692
|
+
|
1693
|
+
options.apply_defaults timeout: @config.rpcs.batch_search_link_processes.timeout,
|
1694
|
+
metadata: metadata,
|
1695
|
+
retry_policy: @config.rpcs.batch_search_link_processes.retry_policy
|
1696
|
+
|
1697
|
+
options.apply_defaults timeout: @config.timeout,
|
1698
|
+
metadata: @config.metadata,
|
1699
|
+
retry_policy: @config.retry_policy
|
1700
|
+
|
1701
|
+
@lineage_stub.call_rpc :batch_search_link_processes, request, options: options do |response, operation|
|
1702
|
+
response = ::Gapic::PagedEnumerable.new @lineage_stub, :batch_search_link_processes, request, response, operation, options
|
1703
|
+
yield response, operation if block_given?
|
1704
|
+
return response
|
1705
|
+
end
|
1706
|
+
rescue ::GRPC::BadStatus => e
|
1707
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1708
|
+
end
|
1709
|
+
|
1710
|
+
##
|
1711
|
+
# Configuration class for the Lineage API.
|
1712
|
+
#
|
1713
|
+
# This class represents the configuration for Lineage,
|
1714
|
+
# providing control over timeouts, retry behavior, logging, transport
|
1715
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
1716
|
+
# applied individually to specific RPCs. See
|
1717
|
+
# {::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client::Configuration::Rpcs}
|
1718
|
+
# for a list of RPCs that can be configured independently.
|
1719
|
+
#
|
1720
|
+
# Configuration can be applied globally to all clients, or to a single client
|
1721
|
+
# on construction.
|
1722
|
+
#
|
1723
|
+
# @example
|
1724
|
+
#
|
1725
|
+
# # Modify the global config, setting the timeout for
|
1726
|
+
# # create_process to 20 seconds,
|
1727
|
+
# # and all remaining timeouts to 10 seconds.
|
1728
|
+
# ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.configure do |config|
|
1729
|
+
# config.timeout = 10.0
|
1730
|
+
# config.rpcs.create_process.timeout = 20.0
|
1731
|
+
# end
|
1732
|
+
#
|
1733
|
+
# # Apply the above configuration only to a new client.
|
1734
|
+
# client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new do |config|
|
1735
|
+
# config.timeout = 10.0
|
1736
|
+
# config.rpcs.create_process.timeout = 20.0
|
1737
|
+
# end
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] endpoint
|
1740
|
+
# The hostname or hostname:port of the service endpoint.
|
1741
|
+
# Defaults to `"datalineage.googleapis.com"`.
|
1742
|
+
# @return [::String]
|
1743
|
+
# @!attribute [rw] credentials
|
1744
|
+
# Credentials to send with calls. You may provide any of the following types:
|
1745
|
+
# * (`String`) The path to a service account key file in JSON format
|
1746
|
+
# * (`Hash`) A service account key as a Hash
|
1747
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1748
|
+
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
|
1749
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1750
|
+
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
|
1751
|
+
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
1752
|
+
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
1753
|
+
# * (`nil`) indicating no credentials
|
1754
|
+
# @return [::Object]
|
1755
|
+
# @!attribute [rw] scope
|
1756
|
+
# The OAuth scopes
|
1757
|
+
# @return [::Array<::String>]
|
1758
|
+
# @!attribute [rw] lib_name
|
1759
|
+
# The library name as recorded in instrumentation and logging
|
1760
|
+
# @return [::String]
|
1761
|
+
# @!attribute [rw] lib_version
|
1762
|
+
# The library version as recorded in instrumentation and logging
|
1763
|
+
# @return [::String]
|
1764
|
+
# @!attribute [rw] channel_args
|
1765
|
+
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
|
1766
|
+
# `GRPC::Core::Channel` object is provided as the credential.
|
1767
|
+
# @return [::Hash]
|
1768
|
+
# @!attribute [rw] interceptors
|
1769
|
+
# An array of interceptors that are run before calls are executed.
|
1770
|
+
# @return [::Array<::GRPC::ClientInterceptor>]
|
1771
|
+
# @!attribute [rw] timeout
|
1772
|
+
# The call timeout in seconds.
|
1773
|
+
# @return [::Numeric]
|
1774
|
+
# @!attribute [rw] metadata
|
1775
|
+
# Additional gRPC headers to be sent with the call.
|
1776
|
+
# @return [::Hash{::Symbol=>::String}]
|
1777
|
+
# @!attribute [rw] retry_policy
|
1778
|
+
# The retry policy. The value is a hash with the following keys:
|
1779
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
1780
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
1781
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
1782
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
1783
|
+
# trigger a retry.
|
1784
|
+
# @return [::Hash]
|
1785
|
+
# @!attribute [rw] quota_project
|
1786
|
+
# A separate project against which to charge quota.
|
1787
|
+
# @return [::String]
|
1788
|
+
#
|
1789
|
+
class Configuration
|
1790
|
+
extend ::Gapic::Config
|
1791
|
+
|
1792
|
+
config_attr :endpoint, "datalineage.googleapis.com", ::String
|
1793
|
+
config_attr :credentials, nil do |value|
|
1794
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1795
|
+
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
1796
|
+
allowed.any? { |klass| klass === value }
|
1797
|
+
end
|
1798
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
1799
|
+
config_attr :lib_name, nil, ::String, nil
|
1800
|
+
config_attr :lib_version, nil, ::String, nil
|
1801
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
1802
|
+
config_attr :interceptors, nil, ::Array, nil
|
1803
|
+
config_attr :timeout, nil, ::Numeric, nil
|
1804
|
+
config_attr :metadata, nil, ::Hash, nil
|
1805
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1806
|
+
config_attr :quota_project, nil, ::String, nil
|
1807
|
+
|
1808
|
+
# @private
|
1809
|
+
def initialize parent_config = nil
|
1810
|
+
@parent_config = parent_config unless parent_config.nil?
|
1811
|
+
|
1812
|
+
yield self if block_given?
|
1813
|
+
end
|
1814
|
+
|
1815
|
+
##
|
1816
|
+
# Configurations for individual RPCs
|
1817
|
+
# @return [Rpcs]
|
1818
|
+
#
|
1819
|
+
def rpcs
|
1820
|
+
@rpcs ||= begin
|
1821
|
+
parent_rpcs = nil
|
1822
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
1823
|
+
Rpcs.new parent_rpcs
|
1824
|
+
end
|
1825
|
+
end
|
1826
|
+
|
1827
|
+
##
|
1828
|
+
# Configuration RPC class for the Lineage API.
|
1829
|
+
#
|
1830
|
+
# Includes fields providing the configuration for each RPC in this service.
|
1831
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
1832
|
+
# the following configuration fields:
|
1833
|
+
#
|
1834
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
1835
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
1836
|
+
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
1837
|
+
# include the following keys:
|
1838
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
1839
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
1840
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
1841
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
1842
|
+
# trigger a retry.
|
1843
|
+
#
|
1844
|
+
class Rpcs
|
1845
|
+
##
|
1846
|
+
# RPC-specific configuration for `create_process`
|
1847
|
+
# @return [::Gapic::Config::Method]
|
1848
|
+
#
|
1849
|
+
attr_reader :create_process
|
1850
|
+
##
|
1851
|
+
# RPC-specific configuration for `update_process`
|
1852
|
+
# @return [::Gapic::Config::Method]
|
1853
|
+
#
|
1854
|
+
attr_reader :update_process
|
1855
|
+
##
|
1856
|
+
# RPC-specific configuration for `get_process`
|
1857
|
+
# @return [::Gapic::Config::Method]
|
1858
|
+
#
|
1859
|
+
attr_reader :get_process
|
1860
|
+
##
|
1861
|
+
# RPC-specific configuration for `list_processes`
|
1862
|
+
# @return [::Gapic::Config::Method]
|
1863
|
+
#
|
1864
|
+
attr_reader :list_processes
|
1865
|
+
##
|
1866
|
+
# RPC-specific configuration for `delete_process`
|
1867
|
+
# @return [::Gapic::Config::Method]
|
1868
|
+
#
|
1869
|
+
attr_reader :delete_process
|
1870
|
+
##
|
1871
|
+
# RPC-specific configuration for `create_run`
|
1872
|
+
# @return [::Gapic::Config::Method]
|
1873
|
+
#
|
1874
|
+
attr_reader :create_run
|
1875
|
+
##
|
1876
|
+
# RPC-specific configuration for `update_run`
|
1877
|
+
# @return [::Gapic::Config::Method]
|
1878
|
+
#
|
1879
|
+
attr_reader :update_run
|
1880
|
+
##
|
1881
|
+
# RPC-specific configuration for `get_run`
|
1882
|
+
# @return [::Gapic::Config::Method]
|
1883
|
+
#
|
1884
|
+
attr_reader :get_run
|
1885
|
+
##
|
1886
|
+
# RPC-specific configuration for `list_runs`
|
1887
|
+
# @return [::Gapic::Config::Method]
|
1888
|
+
#
|
1889
|
+
attr_reader :list_runs
|
1890
|
+
##
|
1891
|
+
# RPC-specific configuration for `delete_run`
|
1892
|
+
# @return [::Gapic::Config::Method]
|
1893
|
+
#
|
1894
|
+
attr_reader :delete_run
|
1895
|
+
##
|
1896
|
+
# RPC-specific configuration for `create_lineage_event`
|
1897
|
+
# @return [::Gapic::Config::Method]
|
1898
|
+
#
|
1899
|
+
attr_reader :create_lineage_event
|
1900
|
+
##
|
1901
|
+
# RPC-specific configuration for `get_lineage_event`
|
1902
|
+
# @return [::Gapic::Config::Method]
|
1903
|
+
#
|
1904
|
+
attr_reader :get_lineage_event
|
1905
|
+
##
|
1906
|
+
# RPC-specific configuration for `list_lineage_events`
|
1907
|
+
# @return [::Gapic::Config::Method]
|
1908
|
+
#
|
1909
|
+
attr_reader :list_lineage_events
|
1910
|
+
##
|
1911
|
+
# RPC-specific configuration for `delete_lineage_event`
|
1912
|
+
# @return [::Gapic::Config::Method]
|
1913
|
+
#
|
1914
|
+
attr_reader :delete_lineage_event
|
1915
|
+
##
|
1916
|
+
# RPC-specific configuration for `search_links`
|
1917
|
+
# @return [::Gapic::Config::Method]
|
1918
|
+
#
|
1919
|
+
attr_reader :search_links
|
1920
|
+
##
|
1921
|
+
# RPC-specific configuration for `batch_search_link_processes`
|
1922
|
+
# @return [::Gapic::Config::Method]
|
1923
|
+
#
|
1924
|
+
attr_reader :batch_search_link_processes
|
1925
|
+
|
1926
|
+
# @private
|
1927
|
+
def initialize parent_rpcs = nil
|
1928
|
+
create_process_config = parent_rpcs.create_process if parent_rpcs.respond_to? :create_process
|
1929
|
+
@create_process = ::Gapic::Config::Method.new create_process_config
|
1930
|
+
update_process_config = parent_rpcs.update_process if parent_rpcs.respond_to? :update_process
|
1931
|
+
@update_process = ::Gapic::Config::Method.new update_process_config
|
1932
|
+
get_process_config = parent_rpcs.get_process if parent_rpcs.respond_to? :get_process
|
1933
|
+
@get_process = ::Gapic::Config::Method.new get_process_config
|
1934
|
+
list_processes_config = parent_rpcs.list_processes if parent_rpcs.respond_to? :list_processes
|
1935
|
+
@list_processes = ::Gapic::Config::Method.new list_processes_config
|
1936
|
+
delete_process_config = parent_rpcs.delete_process if parent_rpcs.respond_to? :delete_process
|
1937
|
+
@delete_process = ::Gapic::Config::Method.new delete_process_config
|
1938
|
+
create_run_config = parent_rpcs.create_run if parent_rpcs.respond_to? :create_run
|
1939
|
+
@create_run = ::Gapic::Config::Method.new create_run_config
|
1940
|
+
update_run_config = parent_rpcs.update_run if parent_rpcs.respond_to? :update_run
|
1941
|
+
@update_run = ::Gapic::Config::Method.new update_run_config
|
1942
|
+
get_run_config = parent_rpcs.get_run if parent_rpcs.respond_to? :get_run
|
1943
|
+
@get_run = ::Gapic::Config::Method.new get_run_config
|
1944
|
+
list_runs_config = parent_rpcs.list_runs if parent_rpcs.respond_to? :list_runs
|
1945
|
+
@list_runs = ::Gapic::Config::Method.new list_runs_config
|
1946
|
+
delete_run_config = parent_rpcs.delete_run if parent_rpcs.respond_to? :delete_run
|
1947
|
+
@delete_run = ::Gapic::Config::Method.new delete_run_config
|
1948
|
+
create_lineage_event_config = parent_rpcs.create_lineage_event if parent_rpcs.respond_to? :create_lineage_event
|
1949
|
+
@create_lineage_event = ::Gapic::Config::Method.new create_lineage_event_config
|
1950
|
+
get_lineage_event_config = parent_rpcs.get_lineage_event if parent_rpcs.respond_to? :get_lineage_event
|
1951
|
+
@get_lineage_event = ::Gapic::Config::Method.new get_lineage_event_config
|
1952
|
+
list_lineage_events_config = parent_rpcs.list_lineage_events if parent_rpcs.respond_to? :list_lineage_events
|
1953
|
+
@list_lineage_events = ::Gapic::Config::Method.new list_lineage_events_config
|
1954
|
+
delete_lineage_event_config = parent_rpcs.delete_lineage_event if parent_rpcs.respond_to? :delete_lineage_event
|
1955
|
+
@delete_lineage_event = ::Gapic::Config::Method.new delete_lineage_event_config
|
1956
|
+
search_links_config = parent_rpcs.search_links if parent_rpcs.respond_to? :search_links
|
1957
|
+
@search_links = ::Gapic::Config::Method.new search_links_config
|
1958
|
+
batch_search_link_processes_config = parent_rpcs.batch_search_link_processes if parent_rpcs.respond_to? :batch_search_link_processes
|
1959
|
+
@batch_search_link_processes = ::Gapic::Config::Method.new batch_search_link_processes_config
|
1960
|
+
|
1961
|
+
yield self if block_given?
|
1962
|
+
end
|
1963
|
+
end
|
1964
|
+
end
|
1965
|
+
end
|
1966
|
+
end
|
1967
|
+
end
|
1968
|
+
end
|
1969
|
+
end
|
1970
|
+
end
|
1971
|
+
end
|