class Google::Cloud::Dataplex::V1::DataScanService::Client
Data Profile, Data Quality) for the data source.
various types of data scanning workload and generate enriched metadata (e.g.
DataScanService manages DataScan resources which can be configured to run
Client for the DataScanService service.
#
def self.configure
-
(Client::Configuration)-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dataplex", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end
def configure
-
(Client::Configuration)-
Other tags:
- Yieldparam: config -
Other tags:
- Yield: - Configure the Client client.
def configure yield @config if block_given? @config end
def create_data_scan request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Gapic::Operation)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
validate_only(::Boolean) -- -
data_scan_id(::String) -- -
data_scan(::Google::Cloud::Dataplex::V1::DataScan, ::Hash) -- -
parent(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::CreateDataScanRequest, ::Hash) --
Overloads:
-
create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil, validate_only: nil) -
create_data_scan(request, options = nil)
def create_data_scan request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::CreateDataScanRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_data_scan.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_data_scan.timeout, metadata: metadata, retry_policy: @config.rpcs.create_data_scan.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :create_data_scan, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def delete_data_scan request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Gapic::Operation)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
name(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::DeleteDataScanRequest, ::Hash) --
Overloads:
-
delete_data_scan(name: nil) -
delete_data_scan(request, options = nil)
def delete_data_scan request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::DeleteDataScanRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_data_scan.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_data_scan.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_data_scan.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :delete_data_scan, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def get_data_scan request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Google::Cloud::Dataplex::V1::DataScan)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
view(::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView) -- -
name(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::GetDataScanRequest, ::Hash) --
Overloads:
-
get_data_scan(name: nil, view: nil) -
get_data_scan(request, options = nil)
def get_data_scan request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetDataScanRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_data_scan.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_data_scan.timeout, metadata: metadata, retry_policy: @config.rpcs.get_data_scan.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :get_data_scan, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def get_data_scan_job request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Google::Cloud::Dataplex::V1::DataScanJob)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
view(::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView) -- -
name(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::GetDataScanJobRequest, ::Hash) --
Overloads:
-
get_data_scan_job(name: nil, view: nil) -
get_data_scan_job(request, options = nil)
def get_data_scan_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::GetDataScanJobRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_data_scan_job.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_data_scan_job.timeout, metadata: metadata, retry_policy: @config.rpcs.get_data_scan_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :get_data_scan_job, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def initialize
- Yieldparam: config -
Other tags:
- Yield: - Configure the DataScanService client.
def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/dataplex/v1/datascans_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @data_scan_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dataplex::V1::DataScanService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
def list_data_scan_jobs request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
filter(::String) -- -
page_token(::String) -- -
page_size(::Integer) -- -
parent(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::ListDataScanJobsRequest, ::Hash) --
Overloads:
-
list_data_scan_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil) -
list_data_scan_jobs(request, options = nil)
def list_data_scan_jobs request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListDataScanJobsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_data_scan_jobs.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_data_scan_jobs.timeout, metadata: metadata, retry_policy: @config.rpcs.list_data_scan_jobs.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :list_data_scan_jobs, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @data_scan_service_stub, :list_data_scan_jobs, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def list_data_scans request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Gapic::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
order_by(::String) -- -
filter(::String) -- -
page_token(::String) -- -
page_size(::Integer) -- -
parent(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::ListDataScansRequest, ::Hash) --
Overloads:
-
list_data_scans(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -
list_data_scans(request, options = nil)
def list_data_scans request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::ListDataScansRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_data_scans.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_data_scans.timeout, metadata: metadata, retry_policy: @config.rpcs.list_data_scans.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :list_data_scans, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @data_scan_service_stub, :list_data_scans, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def run_data_scan request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Google::Cloud::Dataplex::V1::RunDataScanResponse)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
name(::String) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::RunDataScanRequest, ::Hash) --
Overloads:
-
run_data_scan(name: nil) -
run_data_scan(request, options = nil)
def run_data_scan request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::RunDataScanRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.run_data_scan.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.run_data_scan.timeout, metadata: metadata, retry_policy: @config.rpcs.run_data_scan.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :run_data_scan, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
def update_data_scan request, options = nil
- Example: Basic example -
Raises:
-
(::Google::Cloud::Error)- if the RPC is aborted.
Returns:
-
(::Gapic::Operation)-
Other tags:
- Yieldparam: operation -
Yieldparam: response -
Other tags:
- Yield: - Access the result along with the RPC operation
Parameters:
-
validate_only(::Boolean) -- -
update_mask(::Google::Protobuf::FieldMask, ::Hash) -- -
data_scan(::Google::Cloud::Dataplex::V1::DataScan, ::Hash) -- -
options(::Gapic::CallOptions, ::Hash) -- -
request(::Google::Cloud::Dataplex::V1::UpdateDataScanRequest, ::Hash) --
Overloads:
-
update_data_scan(data_scan: nil, update_mask: nil, validate_only: nil) -
update_data_scan(request, options = nil)
def update_data_scan request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataplex::V1::UpdateDataScanRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_data_scan.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataplex::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.data_scan&.name header_params["data_scan.name"] = request.data_scan.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_data_scan.timeout, metadata: metadata, retry_policy: @config.rpcs.update_data_scan.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @data_scan_service_stub.call_rpc :update_data_scan, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end