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 messagegoogle.cloud.dataplex.v1.MetadataJob.ImportJobSpec
Namespace
Google \ Cloud \ Dataplex \ V1 \ MetadataJob
Methods
__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 withgs://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 import job. For more information about how to create a metadata import file and the file requirements, seeMetadata 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.jsonor.jsonlfile extension). InFULLentry sync mode, don't save the metadata import file in a folder namedSOURCE_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.
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 incuradditional coststhat might not be merited for all jobs. If unspecified, defaults toINFO.
getSourceStorageUri
Optional. The URI of a Cloud Storage bucket or folder (beginning withgs://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 import job. For more information about how to
create a metadata import file and the file requirements, seeMetadata
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.jsonor.jsonlfile extension).
InFULLentry sync mode, don't save the metadata import file in a
folder namedSOURCE_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 withgs://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 import job. For more information about how to
create a metadata import file and the file requirements, seeMetadata
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.jsonor.jsonlfile extension).
InFULLentry sync mode, don't save the metadata import file in a
folder namedSOURCE_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.
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 incuradditional
coststhat might not be
merited for all jobs.
If unspecified, defaults toINFO.
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 incuradditional
coststhat might not be
merited for all jobs.
If unspecified, defaults toINFO.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ImportJobSpec (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.MetadataJob.ImportJobSpec)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.MetadataJob.ImportJobSpec)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.MetadataJob.ImportJobSpec)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.MetadataJob.ImportJobSpec)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.MetadataJob.ImportJobSpec)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.MetadataJob.ImportJobSpec)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.MetadataJob.ImportJobSpec)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.MetadataJob.ImportJobSpec)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.MetadataJob.ImportJobSpec)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.MetadataJob.ImportJobSpec)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.MetadataJob.ImportJobSpec)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.MetadataJob.ImportJobSpec)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.MetadataJob.ImportJobSpec)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.MetadataJob.ImportJobSpec)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.MetadataJob.ImportJobSpec)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.MetadataJob.ImportJobSpec)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.MetadataJob.ImportJobSpec)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.MetadataJob.ImportJobSpec)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.MetadataJob.ImportJobSpec)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.MetadataJob.ImportJobSpec)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.MetadataJob.ImportJobSpec)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.MetadataJob.ImportJobSpec)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.MetadataJob.ImportJobSpec)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.MetadataJob.ImportJobSpec) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ImportJobSpec.\n\nJob specification for a metadata import job.\n\nYou can run the following kinds of metadata import jobs:\n\n- Full sync of entries with incremental import of their aspects. Supported for custom entries.\n- 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.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.MetadataJob.ImportJobSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ MetadataJob\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSourceStorageUri\n\nOptional. The URI of a Cloud Storage bucket or folder (beginning with\n`gs://` and ending with `/`) that contains the metadata import files for\nthis job.\n\nA metadata import file defines the values to set for each of the entries\nand aspects in a metadata import job. For more information about how to\ncreate a metadata import file and the file requirements, see [Metadata\nimport\nfile](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).\nYou can provide multiple metadata import files in the same metadata job.\nThe bucket or folder must contain at least one metadata import file, in\nJSON Lines format (either `.json` or `.jsonl` file extension).\nIn `FULL` entry sync mode, don't save the metadata import file in a\nfolder named `SOURCE_STORAGE_URI/deletions/`.\n**Caution**: If the metadata import file contains no data, all entries\nand aspects that belong to the job's scope are deleted.\n\n### setSourceStorageUri\n\nOptional. The URI of a Cloud Storage bucket or folder (beginning with\n`gs://` and ending with `/`) that contains the metadata import files for\nthis job.\n\nA metadata import file defines the values to set for each of the entries\nand aspects in a metadata import job. For more information about how to\ncreate a metadata import file and the file requirements, see [Metadata\nimport\nfile](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).\nYou can provide multiple metadata import files in the same metadata job.\nThe bucket or folder must contain at least one metadata import file, in\nJSON Lines format (either `.json` or `.jsonl` file extension).\nIn `FULL` entry sync mode, don't save the metadata import file in a\nfolder named `SOURCE_STORAGE_URI/deletions/`.\n**Caution**: If the metadata import file contains no data, all entries\nand aspects that belong to the job's scope are deleted.\n\n### getSourceCreateTime\n\nOptional. The time when the process that created the metadata import\nfiles began.\n\n### hasSourceCreateTime\n\n### clearSourceCreateTime\n\n### setSourceCreateTime\n\nOptional. The time when the process that created the metadata import\nfiles began.\n\n### getScope\n\nRequired. A boundary on the scope of impact that the metadata import job\ncan have.\n\n### hasScope\n\n### clearScope\n\n### setScope\n\nRequired. A boundary on the scope of impact that the metadata import job\ncan have.\n\n### getEntrySyncMode\n\nRequired. The sync mode for entries.\n\n### setEntrySyncMode\n\nRequired. The sync mode for entries.\n\n### getAspectSyncMode\n\nRequired. The sync mode for aspects.\n\n### setAspectSyncMode\n\nRequired. The sync mode for aspects.\n\n### getLogLevel\n\nOptional. The level of logs to write to Cloud Logging for this job.\n\nDebug-level logs provide highly-detailed information for\ntroubleshooting, but their increased verbosity could incur [additional\ncosts](https://cloud.google.com/stackdriver/pricing) that might not be\nmerited for all jobs.\nIf unspecified, defaults to `INFO`.\n\n### setLogLevel\n\nOptional. The level of logs to write to Cloud Logging for this job.\n\nDebug-level logs provide highly-detailed information for\ntroubleshooting, but their increased verbosity could incur [additional\ncosts](https://cloud.google.com/stackdriver/pricing) that might not be\nmerited for all jobs.\nIf unspecified, defaults to `INFO`."]]
