Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.
REST client for the DataScanService service.
DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::ConfigurationConfigure the DataScanService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all DataScanService clients ::Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::ConfigurationConfigure the DataScanService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_data_scan
def create_data_scan(request, options = nil) -> ::Gapic::Operation
def create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil, validate_only: nil) -> ::Gapic::OperationCreates a DataScan resource.
def create_data_scan(request, options = nil) -> ::Gapic::Operationcreate_data_scan via a request object, either of type
CreateDataScanRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::CreateDataScanRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_data_scan(parent: nil, data_scan: nil, data_scan_id: nil, validate_only: nil) -> ::Gapic::Operationcreate_data_scan via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the parent location:
projects/{project}/locations/{location_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. - data_scan (::Google::Cloud::Dataplex::V1::DataScan, ::Hash) — Required. DataScan resource.
-
data_scan_id (::String) —
Required. DataScan identifier.
- Must contain only lowercase letters, numbers and hyphens.
- Must start with a letter.
- Must end with a number or a letter.
- Must be between 1-63 characters.
- Must be unique within the customer project / location.
-
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations.
The default is
false.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::CreateDataScanRequest.new # Call the create_data_scan method. result = client.create_data_scan request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_data_scan
def delete_data_scan(request, options = nil) -> ::Gapic::Operation
def delete_data_scan(name: nil, force: nil) -> ::Gapic::OperationDeletes a DataScan resource.
def delete_data_scan(request, options = nil) -> ::Gapic::Operationdelete_data_scan via a request object, either of type
Google::Cloud::Dataplex::V1::DeleteDataScanRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::DeleteDataScanRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_data_scan(name: nil, force: nil) -> ::Gapic::Operationdelete_data_scan via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the dataScan:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. - force (::Boolean) — Optional. If set to true, any child resources of this data scan will also be deleted. (Otherwise, the request will only work if the data scan has no child resources.)
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::DeleteDataScanRequest.new # Call the delete_data_scan method. result = client.delete_data_scan request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#generate_data_quality_rules
def generate_data_quality_rules(request, options = nil) -> ::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponse
def generate_data_quality_rules(name: nil) -> ::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponseGenerates recommended data quality rules based on the results of a data profiling scan.
Use the recommendations to build rules for a data quality scan.
def generate_data_quality_rules(request, options = nil) -> ::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponsegenerate_data_quality_rules via a request object, either of type
GenerateDataQualityRulesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def generate_data_quality_rules(name: nil) -> ::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponsegenerate_data_quality_rules via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) —
Required. The name must be one of the following:
- The name of a data scan with at least one successful, completed data profiling job
- The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::GenerateDataQualityRulesRequest.new # Call the generate_data_quality_rules method. result = client.generate_data_quality_rules request # The returned object is of type Google::Cloud::Dataplex::V1::GenerateDataQualityRulesResponse. p result
#get_data_scan
def get_data_scan(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataScan
def get_data_scan(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::DataScanGets a DataScan resource.
def get_data_scan(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataScanget_data_scan via a request object, either of type
GetDataScanRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::GetDataScanRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_data_scan(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::DataScanget_data_scan via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the dataScan:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. -
view (::Google::Cloud::Dataplex::V1::GetDataScanRequest::DataScanView) — Optional. Select the DataScan view to return. Defaults to
BASIC.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dataplex::V1::DataScan)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::GetDataScanRequest.new # Call the get_data_scan method. result = client.get_data_scan request # The returned object is of type Google::Cloud::Dataplex::V1::DataScan. p result
#get_data_scan_job
def get_data_scan_job(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataScanJob
def get_data_scan_job(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::DataScanJobGets a DataScanJob resource.
def get_data_scan_job(request, options = nil) -> ::Google::Cloud::Dataplex::V1::DataScanJobget_data_scan_job via a request object, either of type
GetDataScanJobRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::GetDataScanJobRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_data_scan_job(name: nil, view: nil) -> ::Google::Cloud::Dataplex::V1::DataScanJobget_data_scan_job via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the DataScanJob:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. -
view (::Google::Cloud::Dataplex::V1::GetDataScanJobRequest::DataScanJobView) — Optional. Select the DataScanJob view to return. Defaults to
BASIC.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dataplex::V1::DataScanJob)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::GetDataScanJobRequest.new # Call the get_data_scan_job method. result = client.get_data_scan_job request # The returned object is of type Google::Cloud::Dataplex::V1::DataScanJob. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::ClientGet the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Rest::Client)
#initialize
def initialize() { |config| ... } -> ClientCreate a new DataScanService REST client object.
- (config) — Configure the DataScanService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new do |config| config.timeout = 10.0 end
#list_data_scan_jobs
def list_data_scan_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>
def list_data_scan_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>Lists DataScanJobs under the given DataScan.
def list_data_scan_jobs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>list_data_scan_jobs via a request object, either of type
ListDataScanJobsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::ListDataScanJobsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_data_scan_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>list_data_scan_jobs via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the parent environment:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. - page_size (::Integer) — Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-
page_token (::String) — Optional. Page token received from a previous
ListDataScanJobscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListDataScanJobsmust match the call that provided the page token. -
filter (::String) — Optional. An expression for filtering the results of the ListDataScanJobs
request.
If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with
AND,ORlogical operators). Filters are case-sensitive.Allowed fields are:
start_timeend_time
start_timeandend_timeexpect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time > 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScanJob>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::ListDataScanJobsRequest.new # Call the list_data_scan_jobs method. result = client.list_data_scan_jobs request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Dataplex::V1::DataScanJob. p item end
#list_data_scans
def list_data_scans(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>
def list_data_scans(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>Lists DataScans.
def list_data_scans(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>list_data_scans via a request object, either of type
ListDataScansRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::ListDataScansRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_data_scans(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>list_data_scans via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
parent (::String) — Required. The resource name of the parent location:
projects/{project}/locations/{location_id}whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region. - page_size (::Integer) — Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-
page_token (::String) — Optional. Page token received from a previous
ListDataScanscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListDataScansmust match the call that provided the page token. - filter (::String) — Optional. Filter request.
-
order_by (::String) — Optional. Order by fields (
nameorcreate_time) for the result. If not specified, the ordering is undefined.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataplex::V1::DataScan>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::ListDataScansRequest.new # Call the list_data_scans method. result = client.list_data_scans request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::Dataplex::V1::DataScan. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Rest::ClientGet the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Rest::Client)
#logger
def logger() -> LoggerThe logger used for request/response debug logging.
- (Logger)
#operations_client
def operations_client() -> ::Google::Cloud::Dataplex::V1::DataScanService::Rest::OperationsGet the associated client for long-running operations.
#run_data_scan
def run_data_scan(request, options = nil) -> ::Google::Cloud::Dataplex::V1::RunDataScanResponse
def run_data_scan(name: nil) -> ::Google::Cloud::Dataplex::V1::RunDataScanResponseRuns an on-demand execution of a DataScan
def run_data_scan(request, options = nil) -> ::Google::Cloud::Dataplex::V1::RunDataScanResponserun_data_scan via a request object, either of type
RunDataScanRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::RunDataScanRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def run_data_scan(name: nil) -> ::Google::Cloud::Dataplex::V1::RunDataScanResponserun_data_scan via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
name (::String) — Required. The resource name of the DataScan:
projects/{project}/locations/{location_id}/dataScans/{data_scan_id}. whereprojectrefers to a project_id or project_number andlocation_idrefers to a Google Cloud region.Only OnDemand data scans are allowed.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Dataplex::V1::RunDataScanResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::RunDataScanRequest.new # Call the run_data_scan method. result = client.run_data_scan request # The returned object is of type Google::Cloud::Dataplex::V1::RunDataScanResponse. p result
#universe_domain
def universe_domain() -> StringThe effective universe domain
- (String)
#update_data_scan
def update_data_scan(request, options = nil) -> ::Gapic::Operation
def update_data_scan(data_scan: nil, update_mask: nil, validate_only: nil) -> ::Gapic::OperationUpdates a DataScan resource.
def update_data_scan(request, options = nil) -> ::Gapic::Operationupdate_data_scan via a request object, either of type
UpdateDataScanRequest or an equivalent Hash.
- request (::Google::Cloud::Dataplex::V1::UpdateDataScanRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_data_scan(data_scan: nil, update_mask: nil, validate_only: nil) -> ::Gapic::Operationupdate_data_scan via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
data_scan (::Google::Cloud::Dataplex::V1::DataScan, ::Hash) — Required. DataScan resource to be updated.
Only fields specified in
update_maskare updated. - update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Mask of fields to update.
-
validate_only (::Boolean) — Optional. Only validate the request, but do not perform mutations.
The default is
false.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/dataplex/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataplex::V1::DataScanService::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataplex::V1::UpdateDataScanRequest.new # Call the update_data_scan method. result = client.update_data_scan request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end