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. v1
Package
@google-cloud/dataplexConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of DataScanServiceClient.
opts
ClientOptions
gaxInstance
typeof gax | typeof gax.fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DataScanServiceClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
dataScanServiceStub
dataScanServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
assetPath(project, location, lake, zone, asset)
assetPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
asset
:
string
)
:
string
;
Return a fully-qualified asset resource name string.
project
string
location
string
lake
string
zone
string
asset
string
string
{string} Resource name string.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
protos. google.longrunning.CancelOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.CancelOperationRequest
, protos. google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkCreateDataScanProgress(name)
checkCreateDataScanProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createDataScan()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.dataplex.v1.DataScan
, protos. google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent location:
* `projects/{project}/locations/{location_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const parent = 'abc123'
/**
* Required. DataScan resource.
*/
// const dataScan = {}
/**
* 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.
*/
// const dataScanId = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callCreateDataScan
()
{
// Construct request
const
request
=
{
parent
,
dataScan
,
dataScanId
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataScan
();
checkDeleteDataScanProgress(name)
checkDeleteDataScanProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteDataScan()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the dataScan:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const name = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callDeleteDataScan
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataScan
();
checkUpdateDataScanProgress(name)
checkUpdateDataScanProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
DataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateDataScan()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.dataplex.v1.DataScan
, protos. google.cloud.dataplex.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. DataScan resource to be updated.
* Only fields specified in `update_mask` are updated.
*/
// const dataScan = {}
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callUpdateDataScan
()
{
// Construct request
const
request
=
{
dataScan
,
updateMask
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataScan
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
contentPath(project, location, lake, content)
contentPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
content
:
string
)
:
string
;
Return a fully-qualified content resource name string.
project
string
location
string
lake
string
content
string
string
{string} Resource name string.
createDataScan(request, options)
createDataScan
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataScanRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Creates a DataScan resource.
request
protos. google.cloud.dataplex.v1.ICreateDataScanRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent location:
* `projects/{project}/locations/{location_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const parent = 'abc123'
/**
* Required. DataScan resource.
*/
// const dataScan = {}
/**
* 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.
*/
// const dataScanId = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callCreateDataScan
()
{
// Construct request
const
request
=
{
parent
,
dataScan
,
dataScanId
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
createDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateDataScan
();
createDataScan(request, options, callback)
createDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataScanRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.ICreateDataScanRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
createDataScan(request, callback)
createDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
ICreateDataScanRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.ICreateDataScanRequest
callback
Callback
< LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
dataScanJobPath(project, location, dataScan, job)
dataScanJobPath
(
project
:
string
,
location
:
string
,
dataScan
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified dataScanJob resource name string.
project
string
location
string
dataScan
string
job
string
string
{string} Resource name string.
dataScanPath(project, location, dataScan)
dataScanPath
(
project
:
string
,
location
:
string
,
dataScan
:
string
)
:
string
;
Return a fully-qualified dataScan resource name string.
project
string
location
string
dataScan
string
string
{string} Resource name string.
deleteDataScan(request, options)
deleteDataScan
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataScanRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Deletes a DataScan resource.
request
protos. google.cloud.dataplex.v1.IDeleteDataScanRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.dataplex.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the dataScan:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const name = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callDeleteDataScan
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
deleteDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteDataScan
();
deleteDataScan(request, options, callback)
deleteDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataScanRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IDeleteDataScanRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteDataScan(request, callback)
deleteDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDeleteDataScanRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IDeleteDataScanRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
protos. google.longrunning.DeleteOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
entityPath(project, location, lake, zone, entity)
entityPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
entity
:
string
)
:
string
;
Return a fully-qualified entity resource name string.
project
string
location
string
lake
string
zone
string
entity
string
string
{string} Resource name string.
environmentPath(project, location, lake, environment)
environmentPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
environment
:
string
)
:
string
;
Return a fully-qualified environment resource name string.
project
string
location
string
lake
string
environment
string
string
{string} Resource name string.
getDataScan(request, options)
getDataScan
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
|
undefined
,
{}
|
undefined
]>;
Gets a DataScan resource.
request
protos. google.cloud.dataplex.v1.IGetDataScanRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.dataplex.v1.IDataScan
,
protos. google.cloud.dataplex.v1.IGetDataScanRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the dataScan:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const name = 'abc123'
/**
* Optional. Select the DataScan view to return. Defaults to `BASIC`.
*/
// const view = {}
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callGetDataScan
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataplexClient
.
getDataScan
(
request
);
console
.
log
(
response
);
}
callGetDataScan
();
getDataScan(request, options, callback)
getDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IGetDataScanRequest
options
CallOptions
callback
Callback
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IGetDataScanRequest
| null | undefined, {} | null | undefined>
void
getDataScan(request, callback)
getDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IGetDataScanRequest
callback
Callback
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IGetDataScanRequest
| null | undefined, {} | null | undefined>
void
getDataScanJob(request, options)
getDataScanJob
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
|
undefined
,
{}
|
undefined
]>;
Gets a DataScanJob resource.
request
protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.dataplex.v1.IDataScanJob
,
protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the DataScanJob:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/dataScanJobs/{data_scan_job_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const name = 'abc123'
/**
* Optional. Select the DataScanJob view to return. Defaults to `BASIC`.
*/
// const view = {}
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callGetDataScanJob
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataplexClient
.
getDataScanJob
(
request
);
console
.
log
(
response
);
}
callGetDataScanJob
();
getDataScanJob(request, options, callback)
getDataScanJob
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
options
CallOptions
callback
Callback
<protos. google.cloud.dataplex.v1.IDataScanJob
, protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
| null | undefined, {} | null | undefined>
void
getDataScanJob(request, callback)
getDataScanJob
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IGetDataScanJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
callback
Callback
<protos. google.cloud.dataplex.v1.IDataScanJob
, protos. google.cloud.dataplex.v1.IGetDataScanJobRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos. google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
<LocationProtos. google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
protos. google.longrunning.GetOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<[protos. google.longrunning.Operation
]>
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
jobPath(project, location, lake, task, job)
jobPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
task
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified job resource name string.
project
string
location
string
lake
string
task
string
job
string
string
{string} Resource name string.
lakePath(project, location, lake)
lakePath
(
project
:
string
,
location
:
string
,
lake
:
string
)
:
string
;
Return a fully-qualified lake resource name string.
project
string
location
string
lake
string
string
{string} Resource name string.
listDataScanJobs(request, options)
listDataScanJobs
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
[],
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
|
null
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsResponse
]>;
Lists DataScanJobs under the given DataScan.
request
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.dataplex.v1.IDataScanJob
[],
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
| null,
protos. google.cloud.dataplex.v1.IListDataScanJobsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDataScanJobsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listDataScanJobs(request, options, callback)
listDataScanJobs
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
, protos. google.cloud.dataplex.v1.IListDataScanJobsResponse
| null | undefined, protos. google.cloud.dataplex.v1.IDataScanJob
>
void
listDataScanJobs(request, callback)
listDataScanJobs
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
callback
PaginationCallback
<protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
, protos. google.cloud.dataplex.v1.IListDataScanJobsResponse
| null | undefined, protos. google.cloud.dataplex.v1.IDataScanJob
>
void
listDataScanJobsAsync(request, options)
listDataScanJobsAsync
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScanJob
> ;
Equivalent to listDataScanJobs
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.dataplex.v1.IDataScanJob
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent environment:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const parent = 'abc123'
/**
* 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.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListDataScanJobs` call.
* Provide this to retrieve the subsequent page. When paginating, all other
* parameters provided to `ListDataScanJobs` must match the call that provided
* the page token.
*/
// const pageToken = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callListDataScanJobs
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataplexClient
.
listDataScanJobsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListDataScanJobs
();
listDataScanJobsStream(request, options)
listDataScanJobsStream
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScanJobsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.dataplex.v1.IListDataScanJobsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataScanJobsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listDataScans(request, options)
listDataScans
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
[],
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
|
null
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansResponse
]>;
Lists DataScans.
request
protos. google.cloud.dataplex.v1.IListDataScansRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.dataplex.v1.IDataScan
[],
protos. google.cloud.dataplex.v1.IListDataScansRequest
| null,
protos. google.cloud.dataplex.v1.IListDataScansResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listDataScansAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listDataScans(request, options, callback)
listDataScans
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IListDataScansRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.dataplex.v1.IListDataScansRequest
, protos. google.cloud.dataplex.v1.IListDataScansResponse
| null | undefined, protos. google.cloud.dataplex.v1.IDataScan
>
void
listDataScans(request, callback)
listDataScans
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IListDataScansRequest
callback
PaginationCallback
<protos. google.cloud.dataplex.v1.IListDataScansRequest
, protos. google.cloud.dataplex.v1.IListDataScansResponse
| null | undefined, protos. google.cloud.dataplex.v1.IDataScan
>
void
listDataScansAsync(request, options)
listDataScansAsync
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
> ;
Equivalent to listDataScans
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.dataplex.v1.IListDataScansRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.dataplex.v1.IDataScan
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent location:
* `projects/{project}/locations/{location_id}`
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
*/
// const parent = 'abc123'
/**
* Optional. Maximum number of dataScans to return. The service may return
* fewer than this value. If unspecified, at most 10 scans will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. Page token received from a previous `ListDataScans` call. Provide
* this to retrieve the subsequent page. When paginating, all other parameters
* provided to `ListDataScans` must match the call that provided the
* page token.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter request.
*/
// const filter = 'abc123'
/**
* Optional. Order by fields (`name` or `create_time`) for the result.
* If not specified, the ordering is undefined.
*/
// const orderBy = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callListDataScans
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
dataplexClient
.
listDataScansAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListDataScans
();
listDataScansStream(request, options)
listDataScansStream
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IListDataScansRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.dataplex.v1.IListDataScansRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDataScansAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos. google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
<LocationProtos. google.cloud.location.ILocation
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
protos. google.longrunning.ListOperationsRequest
The request object that will be sent.
options
gax. CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
<protos. google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchActionFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchActionFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the action.
matchActionFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchActionFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the action.
matchActionFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchActionFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the action from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the action.
matchAssetFromAssetName(assetName)
matchAssetFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the asset from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the asset.
matchAssetFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchAssetFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the asset from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the asset.
matchContentFromContentName(contentName)
matchContentFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the content from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the content.
matchDataScanFromDataScanJobName(dataScanJobName)
matchDataScanFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the dataScan from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the dataScan.
matchDataScanFromDataScanName(dataScanName)
matchDataScanFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the dataScan from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the dataScan.
matchEntityFromEntityName(entityName)
matchEntityFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the entity from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the entity.
matchEntityFromPartitionName(partitionName)
matchEntityFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the entity from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the entity.
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the environment from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromSessionName(sessionName)
matchEnvironmentFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the environment from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the environment.
matchJobFromDataScanJobName(dataScanJobName)
matchJobFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the job from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the job.
matchJobFromJobName(jobName)
matchJobFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the job from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the job.
matchLakeFromAssetName(assetName)
matchLakeFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the lake from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the lake.
matchLakeFromContentName(contentName)
matchLakeFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the lake from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the lake.
matchLakeFromEntityName(entityName)
matchLakeFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the lake from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the lake.
matchLakeFromEnvironmentName(environmentName)
matchLakeFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the lake from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the lake.
matchLakeFromJobName(jobName)
matchLakeFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the lake from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the lake.
matchLakeFromLakeName(lakeName)
matchLakeFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the lake from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the lake.
matchLakeFromPartitionName(partitionName)
matchLakeFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the lake from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchLakeFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchLakeFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the lake.
matchLakeFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchLakeFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the lake from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the lake.
matchLakeFromSessionName(sessionName)
matchLakeFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the lake from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the lake.
matchLakeFromTaskName(taskName)
matchLakeFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the lake from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the lake.
matchLakeFromZoneName(zoneName)
matchLakeFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the lake from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the lake.
matchLocationFromAssetName(assetName)
matchLocationFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the location from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the location.
matchLocationFromContentName(contentName)
matchLocationFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the location from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the location.
matchLocationFromDataScanJobName(dataScanJobName)
matchLocationFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the location from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the location.
matchLocationFromDataScanName(dataScanName)
matchLocationFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the location from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the location.
matchLocationFromEntityName(entityName)
matchLocationFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the location from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the location.
matchLocationFromEnvironmentName(environmentName)
matchLocationFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the location from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the location.
matchLocationFromJobName(jobName)
matchLocationFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the location from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the location.
matchLocationFromLakeName(lakeName)
matchLocationFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the location from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromPartitionName(partitionName)
matchLocationFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the location from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchLocationFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchLocationFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchLocationFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the location.
matchLocationFromSessionName(sessionName)
matchLocationFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the location from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the location.
matchLocationFromTaskName(taskName)
matchLocationFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the location from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the location.
matchLocationFromZoneName(zoneName)
matchLocationFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the location from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the location.
matchPartitionFromPartitionName(partitionName)
matchPartitionFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the partition from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the partition.
matchProjectFromAssetName(assetName)
matchProjectFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the project from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the project.
matchProjectFromContentName(contentName)
matchProjectFromContentName
(
contentName
:
string
)
:
string
|
number
;
Parse the project from Content resource.
contentName
string
A fully-qualified path representing Content resource.
string | number
{string} A string representing the project.
matchProjectFromDataScanJobName(dataScanJobName)
matchProjectFromDataScanJobName
(
dataScanJobName
:
string
)
:
string
|
number
;
Parse the project from DataScanJob resource.
dataScanJobName
string
A fully-qualified path representing DataScanJob resource.
string | number
{string} A string representing the project.
matchProjectFromDataScanName(dataScanName)
matchProjectFromDataScanName
(
dataScanName
:
string
)
:
string
|
number
;
Parse the project from DataScan resource.
dataScanName
string
A fully-qualified path representing DataScan resource.
string | number
{string} A string representing the project.
matchProjectFromEntityName(entityName)
matchProjectFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the project from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the project.
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the project from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the project.
matchProjectFromJobName(jobName)
matchProjectFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the project from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the project.
matchProjectFromLakeName(lakeName)
matchProjectFromLakeName
(
lakeName
:
string
)
:
string
|
number
;
Parse the project from Lake resource.
lakeName
string
A fully-qualified path representing Lake resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromPartitionName(partitionName)
matchProjectFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the project from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeActionName(projectLocationLakeActionName)
matchProjectFromProjectLocationLakeActionName
(
projectLocationLakeActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeAction resource.
projectLocationLakeActionName
string
A fully-qualified path representing project_location_lake_action resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchProjectFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchProjectFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the project.
matchProjectFromSessionName(sessionName)
matchProjectFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the project from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the project.
matchProjectFromTaskName(taskName)
matchProjectFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the project from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the project.
matchProjectFromZoneName(zoneName)
matchProjectFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the project from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the project.
matchSessionFromSessionName(sessionName)
matchSessionFromSessionName
(
sessionName
:
string
)
:
string
|
number
;
Parse the session from Session resource.
sessionName
string
A fully-qualified path representing Session resource.
string | number
{string} A string representing the session.
matchTaskFromJobName(jobName)
matchTaskFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the task from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the task.
matchTaskFromTaskName(taskName)
matchTaskFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the task from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the task.
matchZoneFromAssetName(assetName)
matchZoneFromAssetName
(
assetName
:
string
)
:
string
|
number
;
Parse the zone from Asset resource.
assetName
string
A fully-qualified path representing Asset resource.
string | number
{string} A string representing the zone.
matchZoneFromEntityName(entityName)
matchZoneFromEntityName
(
entityName
:
string
)
:
string
|
number
;
Parse the zone from Entity resource.
entityName
string
A fully-qualified path representing Entity resource.
string | number
{string} A string representing the zone.
matchZoneFromPartitionName(partitionName)
matchZoneFromPartitionName
(
partitionName
:
string
)
:
string
|
number
;
Parse the zone from Partition resource.
partitionName
string
A fully-qualified path representing Partition resource.
string | number
{string} A string representing the zone.
matchZoneFromProjectLocationLakeZoneActionName(projectLocationLakeZoneActionName)
matchZoneFromProjectLocationLakeZoneActionName
(
projectLocationLakeZoneActionName
:
string
)
:
string
|
number
;
Parse the zone from ProjectLocationLakeZoneAction resource.
projectLocationLakeZoneActionName
string
A fully-qualified path representing project_location_lake_zone_action resource.
string | number
{string} A string representing the zone.
matchZoneFromProjectLocationLakeZoneAssetActionName(projectLocationLakeZoneAssetActionName)
matchZoneFromProjectLocationLakeZoneAssetActionName
(
projectLocationLakeZoneAssetActionName
:
string
)
:
string
|
number
;
Parse the zone from ProjectLocationLakeZoneAssetAction resource.
projectLocationLakeZoneAssetActionName
string
A fully-qualified path representing project_location_lake_zone_asset_action resource.
string | number
{string} A string representing the zone.
matchZoneFromZoneName(zoneName)
matchZoneFromZoneName
(
zoneName
:
string
)
:
string
|
number
;
Parse the zone from Zone resource.
zoneName
string
A fully-qualified path representing Zone resource.
string | number
{string} A string representing the zone.
partitionPath(project, location, lake, zone, entity, partition)
partitionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
entity
:
string
,
partition
:
string
)
:
string
;
Return a fully-qualified partition resource name string.
project
string
location
string
lake
string
zone
string
entity
string
partition
string
string
{string} Resource name string.
projectLocationLakeActionPath(project, location, lake, action)
projectLocationLakeActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeAction resource name string.
project
string
location
string
lake
string
action
string
string
{string} Resource name string.
projectLocationLakeZoneActionPath(project, location, lake, zone, action)
projectLocationLakeZoneActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeZoneAction resource name string.
project
string
location
string
lake
string
zone
string
action
string
string
{string} Resource name string.
projectLocationLakeZoneAssetActionPath(project, location, lake, zone, asset, action)
projectLocationLakeZoneAssetActionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
,
asset
:
string
,
action
:
string
)
:
string
;
Return a fully-qualified projectLocationLakeZoneAssetAction resource name string.
project
string
location
string
lake
string
zone
string
asset
string
action
string
string
{string} Resource name string.
runDataScan(request, options)
runDataScan
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanResponse
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
|
undefined
,
{}
|
undefined
]>;
Runs an on-demand execution of a DataScan
request
protos. google.cloud.dataplex.v1.IRunDataScanRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.dataplex.v1.IRunDataScanResponse
,
protos. google.cloud.dataplex.v1.IRunDataScanRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the DataScan:
* `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`.
* where `project` refers to a *project_id* or *project_number* and
* `location_id` refers to a GCP region.
* Only **OnDemand** data scans are allowed.
*/
// const name = 'abc123'
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callRunDataScan
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
dataplexClient
.
runDataScan
(
request
);
console
.
log
(
response
);
}
callRunDataScan
();
runDataScan(request, options, callback)
runDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanResponse
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IRunDataScanRequest
options
CallOptions
callback
Callback
<protos. google.cloud.dataplex.v1.IRunDataScanResponse
, protos. google.cloud.dataplex.v1.IRunDataScanRequest
| null | undefined, {} | null | undefined>
void
runDataScan(request, callback)
runDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanResponse
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IRunDataScanRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IRunDataScanRequest
callback
Callback
<protos. google.cloud.dataplex.v1.IRunDataScanResponse
, protos. google.cloud.dataplex.v1.IRunDataScanRequest
| null | undefined, {} | null | undefined>
void
sessionPath(project, location, lake, environment, session)
sessionPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
environment
:
string
,
session
:
string
)
:
string
;
Return a fully-qualified session resource name string.
project
string
location
string
lake
string
environment
string
session
string
string
{string} Resource name string.
taskPath(project, location, lake, task)
taskPath
(
project
:
string
,
location
:
string
,
lake
:
string
,
task
:
string
)
:
string
;
Return a fully-qualified task resource name string.
project
string
location
string
lake
string
task
string
string
{string} Resource name string.
updateDataScan(request, options)
updateDataScan
(
request
?:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataScanRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Updates a DataScan resource.
request
protos. google.cloud.dataplex.v1.IUpdateDataScanRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. DataScan resource to be updated.
* Only fields specified in `update_mask` are updated.
*/
// const dataScan = {}
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
// Imports the Dataplex library
const
{
DataScanServiceClient
}
=
require
(
' @google-cloud/dataplex
'
).
v1
;
// Instantiates a client
const
dataplexClient
=
new
DataScanServiceClient
();
async
function
callUpdateDataScan
()
{
// Construct request
const
request
=
{
dataScan
,
updateMask
,
};
// Run request
const
[
operation
]
=
await
dataplexClient
.
updateDataScan
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateDataScan
();
updateDataScan(request, options, callback)
updateDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataScanRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IUpdateDataScanRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateDataScan(request, callback)
updateDataScan
(
request
:
protos
.
google
.
cloud
.
dataplex
.
v1
.
IUpdateDataScanRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dataplex
.
v1
.
IDataScan
,
protos
.
google
.
cloud
.
dataplex
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.dataplex.v1.IUpdateDataScanRequest
callback
Callback
< LROperation
<protos. google.cloud.dataplex.v1.IDataScan
, protos. google.cloud.dataplex.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
zonePath(project, location, lake, zone)
zonePath
(
project
:
string
,
location
:
string
,
lake
:
string
,
zone
:
string
)
:
string
;
Return a fully-qualified zone resource name string.
project
string
location
string
lake
string
zone
string
string
{string} Resource name string.
