Class protos.google.cloud.dataplex.v1.DataScanService (5.5.0)

5.5.0 (latest) 5.4.0 5.3.0 3.13.0 3.12.0 3.11.0 3.10.0 3.8.0 3.7.0 3.5.1 3.2.0 3.1.0 2.4.0 2.3.2 2.2.2 2.1.1 1.2.0 1.1.0 1.0.0

Represents a DataScanService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dataplex.v1.DataScanService

Package

@google-cloud/dataplex

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DataScanService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DataScanService;

Creates new DataScanService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
DataScanService	RPC service. Useful where requests and/or responses are streamed.

createDataScan(request, callback)

public createDataScan(request: google.cloud.dataplex.v1.ICreateDataScanRequest, callback: google.cloud.dataplex.v1.DataScanService.CreateDataScanCallback): void;

Calls CreateDataScan.

Parameters
Name	Description
request	ICreateDataScanRequest CreateDataScanRequest message or plain object
callback	CreateDataScanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createDataScan(request)

public createDataScan(request: google.cloud.dataplex.v1.ICreateDataScanRequest): Promise<google.longrunning.Operation>;

Calls CreateDataScan.

Parameter
Name	Description
request	ICreateDataScanRequest CreateDataScanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteDataScan(request, callback)

public deleteDataScan(request: google.cloud.dataplex.v1.IDeleteDataScanRequest, callback: google.cloud.dataplex.v1.DataScanService.DeleteDataScanCallback): void;

Calls DeleteDataScan.

Parameters
Name	Description
request	IDeleteDataScanRequest DeleteDataScanRequest message or plain object
callback	DeleteDataScanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteDataScan(request)

public deleteDataScan(request: google.cloud.dataplex.v1.IDeleteDataScanRequest): Promise<google.longrunning.Operation>;

Calls DeleteDataScan.

Parameter
Name	Description
request	IDeleteDataScanRequest DeleteDataScanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

generateDataQualityRules(request, callback)

public generateDataQualityRules(request: google.cloud.dataplex.v1.IGenerateDataQualityRulesRequest, callback: google.cloud.dataplex.v1.DataScanService.GenerateDataQualityRulesCallback): void;

Calls GenerateDataQualityRules.

Parameters
Name	Description
request	IGenerateDataQualityRulesRequest GenerateDataQualityRulesRequest message or plain object
callback	GenerateDataQualityRulesCallback Node-style callback called with the error, if any, and GenerateDataQualityRulesResponse

Returns
Type	Description
void

generateDataQualityRules(request)

public generateDataQualityRules(request: google.cloud.dataplex.v1.IGenerateDataQualityRulesRequest): Promise<google.cloud.dataplex.v1.GenerateDataQualityRulesResponse>;

Calls GenerateDataQualityRules.

Parameter
Name	Description
request	IGenerateDataQualityRulesRequest GenerateDataQualityRulesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.GenerateDataQualityRulesResponse>	Promise

getDataScan(request, callback)

public getDataScan(request: google.cloud.dataplex.v1.IGetDataScanRequest, callback: google.cloud.dataplex.v1.DataScanService.GetDataScanCallback): void;

Calls GetDataScan.

Parameters
Name	Description
request	IGetDataScanRequest GetDataScanRequest message or plain object
callback	GetDataScanCallback Node-style callback called with the error, if any, and DataScan

Returns
Type	Description
void

getDataScan(request)

public getDataScan(request: google.cloud.dataplex.v1.IGetDataScanRequest): Promise<google.cloud.dataplex.v1.DataScan>;

Calls GetDataScan.

Parameter
Name	Description
request	IGetDataScanRequest GetDataScanRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.DataScan>	Promise

getDataScanJob(request, callback)

public getDataScanJob(request: google.cloud.dataplex.v1.IGetDataScanJobRequest, callback: google.cloud.dataplex.v1.DataScanService.GetDataScanJobCallback): void;

Calls GetDataScanJob.

Parameters
Name	Description
request	IGetDataScanJobRequest GetDataScanJobRequest message or plain object
callback	GetDataScanJobCallback Node-style callback called with the error, if any, and DataScanJob

Returns
Type	Description
void

getDataScanJob(request)

public getDataScanJob(request: google.cloud.dataplex.v1.IGetDataScanJobRequest): Promise<google.cloud.dataplex.v1.DataScanJob>;

Calls GetDataScanJob.

Parameter
Name	Description
request	IGetDataScanJobRequest GetDataScanJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.DataScanJob>	Promise

listDataScanJobs(request, callback)

public listDataScanJobs(request: google.cloud.dataplex.v1.IListDataScanJobsRequest, callback: google.cloud.dataplex.v1.DataScanService.ListDataScanJobsCallback): void;

Calls ListDataScanJobs.

Parameters
Name	Description
request	IListDataScanJobsRequest ListDataScanJobsRequest message or plain object
callback	ListDataScanJobsCallback Node-style callback called with the error, if any, and ListDataScanJobsResponse

Returns
Type	Description
void

listDataScanJobs(request)

public listDataScanJobs(request: google.cloud.dataplex.v1.IListDataScanJobsRequest): Promise<google.cloud.dataplex.v1.ListDataScanJobsResponse>;

Calls ListDataScanJobs.

Parameter
Name	Description
request	IListDataScanJobsRequest ListDataScanJobsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.ListDataScanJobsResponse>	Promise

listDataScans(request, callback)

public listDataScans(request: google.cloud.dataplex.v1.IListDataScansRequest, callback: google.cloud.dataplex.v1.DataScanService.ListDataScansCallback): void;

Calls ListDataScans.

Parameters
Name	Description
request	IListDataScansRequest ListDataScansRequest message or plain object
callback	ListDataScansCallback Node-style callback called with the error, if any, and ListDataScansResponse

Returns
Type	Description
void

listDataScans(request)

public listDataScans(request: google.cloud.dataplex.v1.IListDataScansRequest): Promise<google.cloud.dataplex.v1.ListDataScansResponse>;

Calls ListDataScans.

Parameter
Name	Description
request	IListDataScansRequest ListDataScansRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.ListDataScansResponse>	Promise

runDataScan(request, callback)

public runDataScan(request: google.cloud.dataplex.v1.IRunDataScanRequest, callback: google.cloud.dataplex.v1.DataScanService.RunDataScanCallback): void;

Calls RunDataScan.

Parameters
Name	Description
request	IRunDataScanRequest RunDataScanRequest message or plain object
callback	RunDataScanCallback Node-style callback called with the error, if any, and RunDataScanResponse

Returns
Type	Description
void

runDataScan(request)

public runDataScan(request: google.cloud.dataplex.v1.IRunDataScanRequest): Promise<google.cloud.dataplex.v1.RunDataScanResponse>;

Calls RunDataScan.

Parameter
Name	Description
request	IRunDataScanRequest RunDataScanRequest message or plain object

Returns
Type	Description
Promise<google.cloud.dataplex.v1.RunDataScanResponse>	Promise

updateDataScan(request, callback)

public updateDataScan(request: google.cloud.dataplex.v1.IUpdateDataScanRequest, callback: google.cloud.dataplex.v1.DataScanService.UpdateDataScanCallback): void;

Calls UpdateDataScan.

Parameters
Name	Description
request	IUpdateDataScanRequest UpdateDataScanRequest message or plain object
callback	UpdateDataScanCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateDataScan(request)

public updateDataScan(request: google.cloud.dataplex.v1.IUpdateDataScanRequest): Promise<google.longrunning.Operation>;

Calls UpdateDataScan.

Parameter
Name	Description
request	IUpdateDataScanRequest UpdateDataScanRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise