Note: The following fields are mutually exclusive: export_result, import_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: export_spec, import_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: export_spec, import_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: export_spec, import_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: import_result, export_result. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: import_spec, export_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: import_spec, export_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
Note: The following fields are mutually exclusive: import_spec, export_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.
(::String) — Output only. Identifier. The name of the resource that the configuration is
applied to, in the format
projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
(::String) — Output only. A system-generated, globally unique ID for the metadata job.
If the metadata job is deleted and then re-created with the same name, this
ID is different.
[[["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,["# Dataplex V1 API - Class Google::Cloud::Dataplex::V1::MetadataJob (v2.5.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.5.0 (latest)](/ruby/docs/reference/google-cloud-dataplex-v1/latest/Google-Cloud-Dataplex-V1-MetadataJob)\n- [2.4.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.4.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [2.3.1](/ruby/docs/reference/google-cloud-dataplex-v1/2.3.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [2.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.2.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [2.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.1.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [2.0.0](/ruby/docs/reference/google-cloud-dataplex-v1/2.0.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [1.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.4.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [1.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.3.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [1.2.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.2.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [1.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/1.1.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [1.0.1](/ruby/docs/reference/google-cloud-dataplex-v1/1.0.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.23.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.23.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.22.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.22.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.21.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.21.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.20.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.20.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.19.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.19.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.18.2](/ruby/docs/reference/google-cloud-dataplex-v1/0.18.2/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.17.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.17.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.16.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.16.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.15.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.15.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.14.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.14.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.13.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.12.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.12.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.11.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.10.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.10.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.9.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.9.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.8.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.8.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.7.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.6.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.6.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.5.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.5.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.4.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.3.0/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.2.1](/ruby/docs/reference/google-cloud-dataplex-v1/0.2.1/Google-Cloud-Dataplex-V1-MetadataJob)\n- [0.1.0](/ruby/docs/reference/google-cloud-dataplex-v1/0.1.0/Google-Cloud-Dataplex-V1-MetadataJob) \nReference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::MetadataJob.\n\nA metadata job resource. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the metadata job was created.\n\n### #export_result\n\n def export_result() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobResult\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobResult](./Google-Cloud-Dataplex-V1-MetadataJob-ExportJobResult)) --- Output only. Export job result.\n\n\n Note: The following fields are mutually exclusive: `export_result`, `import_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #export_spec\n\n def export_spec() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ExportJobSpec)) --- Export job specification.\n\n\n Note: The following fields are mutually exclusive: `export_spec`, `import_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #export_spec=\n\n def export_spec=(value) -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ExportJobSpec)) --- Export job specification.\n\n\nNote: The following fields are mutually exclusive: `export_spec`, `import_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ExportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ExportJobSpec)) --- Export job specification.\n\n\n Note: The following fields are mutually exclusive: `export_spec`, `import_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #import_result\n\n def import_result() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobResult\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobResult](./Google-Cloud-Dataplex-V1-MetadataJob-ImportJobResult)) --- Output only. Import job result.\n\n\n Note: The following fields are mutually exclusive: `import_result`, `export_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #import_spec\n\n def import_spec() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ImportJobSpec)) --- Import job specification.\n\n\n Note: The following fields are mutually exclusive: `import_spec`, `export_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #import_spec=\n\n def import_spec=(value) -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ImportJobSpec)) --- Import job specification.\n\n\nNote: The following fields are mutually exclusive: `import_spec`, `export_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec](./Google-Cloud-Dataplex-V1-MetadataJob-ImportJobSpec)) --- Import job specification.\n\n\n Note: The following fields are mutually exclusive: `import_spec`, `export_spec`. If a field in that set is populated, all other fields in the set will automatically be cleared.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. User-defined labels.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. User-defined labels. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. User-defined labels.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Identifier. The name of the resource that the configuration is applied to, in the format `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.\n\n### #status\n\n def status() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::Status\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::Status](./Google-Cloud-Dataplex-V1-MetadataJob-Status)) --- Output only. Metadata job status.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::Type\n\n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::Type](./Google-Cloud-Dataplex-V1-MetadataJob-Type)) --- Required. Metadata job type.\n\n### #type=\n\n def type=(value) -\u003e ::Google::Cloud::Dataplex::V1::MetadataJob::Type\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dataplex::V1::MetadataJob::Type](./Google-Cloud-Dataplex-V1-MetadataJob-Type)) --- Required. Metadata job type. \n**Returns**\n\n- ([::Google::Cloud::Dataplex::V1::MetadataJob::Type](./Google-Cloud-Dataplex-V1-MetadataJob-Type)) --- Required. Metadata job type.\n\n### #uid\n\n def uid() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The time when the metadata job was updated."]]
