metadata_jobs

Creates, updates, deletes, gets or lists a metadata_jobs resource.

Overview

Name	metadata_jobs
Type	Resource
Id	google.dataplex.metadata_jobs

Fields

Name	Datatype	Description
name	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}.
createTime	string	Output only. The time when the metadata job was created.
importResult	object	Results from a metadata import job.
importSpec	object	Job specification for a metadata import job
labels	object	Optional. User-defined labels.
status	object	Metadata job status.
type	string	Required. Metadata job type.
uid	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.
updateTime	string	Output only. The time when the metadata job was updated.

Methods

Name	Accessible by	Required Params	Description
projects_locations_metadata_jobs_get	SELECT	locationsId, metadataJobsId, projectsId	Gets a metadata job.
projects_locations_metadata_jobs_list	SELECT	locationsId, projectsId	Lists metadata jobs.
projects_locations_metadata_jobs_create	INSERT	locationsId, projectsId	Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
projects_locations_metadata_jobs_cancel	EXEC	locationsId, metadataJobsId, projectsId	Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

SELECT examples

Lists metadata jobs.

SELECT
name,
createTime,
importResult,
importSpec,
labels,
status,
type,
uid,
updateTime
FROM google.dataplex.metadata_jobs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new metadata_jobs resource.

All Properties

/*+ create */
INSERT INTO google.dataplex.metadata_jobs (
locationsId,
projectsId,
labels,
type,
importSpec
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ labels }}',
'{{ type }}',
'{{ importSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: uid
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: type
      value: string
    - name: importSpec
      value:
        - name: sourceStorageUri
          value: string
        - name: sourceCreateTime
          value: string
        - name: scope
          value:
            - name: entryGroups
              value:
                - string
            - name: entryTypes
              value:
                - string
            - name: aspectTypes
              value:
                - string
        - name: entrySyncMode
          value: string
        - name: aspectSyncMode
          value: string
        - name: logLevel
          value: string
    - name: importResult
      value:
        - name: deletedEntries
          value: string
        - name: updatedEntries
          value: string
        - name: createdEntries
          value: string
        - name: unchangedEntries
          value: string
        - name: recreatedEntries
          value: string
        - name: updateTime
          value: string
    - name: status
      value:
        - name: state
          value: string
        - name: message
          value: string
        - name: completionPercent
          value: integer
        - name: updateTime
          value: string