Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ImportJobSpec.
Job specification for a metadata import job.
You can run the following kinds of metadata import jobs:
- Full sync of entries with incremental import of their aspects. Supported for custom entries.
- Incremental import of aspects only. Supported for aspects that belong to custom entries and system entries. For custom entries, you can modify both optional aspects and required aspects. For system entries, you can modify optional aspects.
Generated from protobuf message google.cloud.dataplex.v1.MetadataJob.ImportJobSpec
Namespace
Google \ Cloud \ Dataplex \ V1 \ MetadataJobMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ source_storage_uri |
string
Optional. The URI of a Cloud Storage bucket or folder (beginning with |
↳ source_create_time |
Google\Protobuf\Timestamp
Optional. The time when the process that created the metadata import files began. |
↳ scope |
ImportJobSpec\ImportJobScope
Required. A boundary on the scope of impact that the metadata import job can have. |
↳ entry_sync_mode |
int
Required. The sync mode for entries. |
↳ aspect_sync_mode |
int
Required. The sync mode for aspects. |
↳ log_level |
int
Optional. The level of logs to write to Cloud Logging for this job. Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs that might not be merited for all jobs. If unspecified, defaults to |
getSourceStorageUri
Optional. The URI of a Cloud Storage bucket or folder (beginning with
gs://
and ending with /
) that contains the metadata import files for
this job.
A metadata import file defines the values to set for each of the entries
and aspects in a metadata job. For more information about how to create a
metadata import file and the file requirements, see Metadata import
file.
You can provide multiple metadata import files in the same metadata job.
The bucket or folder must contain at least one metadata import file, in
JSON Lines format (either .json
or .jsonl
file extension).
In FULL
entry sync mode, don't save the metadata import file in a
folder named SOURCE_STORAGE_URI/deletions/
.
Caution: If the metadata import file contains no data, all entries
and aspects that belong to the job's scope are deleted.
Returns | |
---|---|
Type | Description |
string |
setSourceStorageUri
Optional. The URI of a Cloud Storage bucket or folder (beginning with
gs://
and ending with /
) that contains the metadata import files for
this job.
A metadata import file defines the values to set for each of the entries
and aspects in a metadata job. For more information about how to create a
metadata import file and the file requirements, see Metadata import
file.
You can provide multiple metadata import files in the same metadata job.
The bucket or folder must contain at least one metadata import file, in
JSON Lines format (either .json
or .jsonl
file extension).
In FULL
entry sync mode, don't save the metadata import file in a
folder named SOURCE_STORAGE_URI/deletions/
.
Caution: If the metadata import file contains no data, all entries
and aspects that belong to the job's scope are deleted.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getSourceCreateTime
Optional. The time when the process that created the metadata import files began.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasSourceCreateTime
clearSourceCreateTime
setSourceCreateTime
Optional. The time when the process that created the metadata import files began.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getScope
Required. A boundary on the scope of impact that the metadata import job can have.
Returns | |
---|---|
Type | Description |
ImportJobSpec\ImportJobScope|null |
hasScope
clearScope
setScope
Required. A boundary on the scope of impact that the metadata import job can have.
Parameter | |
---|---|
Name | Description |
var |
ImportJobSpec\ImportJobScope
|
Returns | |
---|---|
Type | Description |
$this |
getEntrySyncMode
Required. The sync mode for entries.
Returns | |
---|---|
Type | Description |
int |
setEntrySyncMode
Required. The sync mode for entries.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getAspectSyncMode
Required. The sync mode for aspects.
Returns | |
---|---|
Type | Description |
int |
setAspectSyncMode
Required. The sync mode for aspects.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getLogLevel
Optional. The level of logs to write to Cloud Logging for this job.
Debug-level logs provide highly-detailed information for
troubleshooting, but their increased verbosity could incur additional
costs that might not be
merited for all jobs.
If unspecified, defaults to INFO
.
Returns | |
---|---|
Type | Description |
int |
setLogLevel
Optional. The level of logs to write to Cloud Logging for this job.
Debug-level logs provide highly-detailed information for
troubleshooting, but their increased verbosity could incur additional
costs that might not be
merited for all jobs.
If unspecified, defaults to INFO
.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |