Cloud Dataplex v1 API - Class MetadataJob.Types.ImportJobSpec (3.4.0)

public sealed class MetadataJob.Types.ImportJobSpec : IMessage<MetadataJob.Types.ImportJobSpec>, IEquatable<MetadataJob.Types.ImportJobSpec>, IDeepCloneable<MetadataJob.Types.ImportJobSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class MetadataJob.Types.ImportJobSpec.

Job specification for a metadata import job

Inheritance

object > MetadataJob.Types.ImportJobSpec

Implements

IMessage MetadataJob Types ImportJobSpec, IEquatable MetadataJob Types ImportJobSpec, IDeepCloneable MetadataJob Types ImportJobSpec, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ImportJobSpec()

public ImportJobSpec()

ImportJobSpec(ImportJobSpec)

public ImportJobSpec(MetadataJob.Types.ImportJobSpec other)

Parameter
Name	Description
`other`	`MetadataJobTypesImportJobSpec`

Properties

AspectSyncMode

public MetadataJob.Types.ImportJobSpec.Types.SyncMode AspectSyncMode { get; set; }

Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.

Property Value
Type	Description
`MetadataJobTypesImportJobSpecTypesSyncMode`

EntrySyncMode

public MetadataJob.Types.ImportJobSpec.Types.SyncMode EntrySyncMode { get; set; }

Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.

Property Value
Type	Description
`MetadataJobTypesImportJobSpecTypesSyncMode`

LogLevel

public MetadataJob.Types.ImportJobSpec.Types.LogLevel LogLevel { get; set; }

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.

Property Value
Type	Description
`MetadataJobTypesImportJobSpecTypesLogLevel`

Scope

public MetadataJob.Types.ImportJobSpec.Types.ImportJobScope Scope { get; set; }

Required. A boundary on the scope of impact that the metadata import job can have.

Property Value
Type	Description
`MetadataJobTypesImportJobSpecTypesImportJobScope`

SourceCreateTime

public Timestamp SourceCreateTime { get; set; }

Optional. The time when the process that created the metadata import files began.

Property Value
Type	Description
`Timestamp`

SourceStorageUri

public string SourceStorageUri { get; set; }

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.

Property Value
Type	Description
`string`