Dataplex V1 API - Class Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec (v2.2.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::MetadataJob::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aspect_sync_mode

def aspect_sync_mode() -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode
Returns

#aspect_sync_mode=

def aspect_sync_mode=(value) -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode
Parameter
Returns

#entry_sync_mode

def entry_sync_mode() -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode
Returns

#entry_sync_mode=

def entry_sync_mode=(value) -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::SyncMode
Parameter
Returns

#log_level

def log_level() -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel
Returns

#log_level=

def log_level=(value) -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::LogLevel
Parameter
Returns

#scope

def scope() -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope
Returns

#scope=

def scope=(value) -> ::Google::Cloud::Dataplex::V1::MetadataJob::ImportJobSpec::ImportJobScope
Parameter
Returns

#source_create_time

def source_create_time() -> ::Google::Protobuf::Timestamp
Returns

#source_create_time=

def source_create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#source_storage_uri

def source_storage_uri() -> ::String
Returns
  • (::String) — 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.

#source_storage_uri=

def source_storage_uri=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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.