Interface MetadataJob.ImportJobSpecOrBuilder (1.53.0)

public static interface MetadataJob.ImportJobSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAspectSyncMode()

public abstract MetadataJob.ImportJobSpec.SyncMode getAspectSyncMode()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ImportJobSpec.SyncMode

The aspectSyncMode.

getAspectSyncModeValue()

public abstract int getAspectSyncModeValue()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for aspectSyncMode.

getEntrySyncMode()

public abstract MetadataJob.ImportJobSpec.SyncMode getEntrySyncMode()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ImportJobSpec.SyncMode

The entrySyncMode.

getEntrySyncModeValue()

public abstract int getEntrySyncModeValue()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for entrySyncMode.

getLogLevel()

public abstract MetadataJob.ImportJobSpec.LogLevel getLogLevel()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel log_level = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MetadataJob.ImportJobSpec.LogLevel

The logLevel.

getLogLevelValue()

public abstract int getLogLevelValue()

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.

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.LogLevel log_level = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for logLevel.

getScope()

public abstract MetadataJob.ImportJobSpec.ImportJobScope getScope()

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

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScope

The scope.

getScopeOrBuilder()

public abstract MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder getScopeOrBuilder()

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

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ImportJobSpec.ImportJobScopeOrBuilder

getSourceCreateTime()

public abstract Timestamp getSourceCreateTime()

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

.google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The sourceCreateTime.

getSourceCreateTimeOrBuilder()

public abstract TimestampOrBuilder getSourceCreateTimeOrBuilder()

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

.google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getSourceStorageUri()

public abstract String getSourceStorageUri()

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.

string source_storage_uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sourceStorageUri.

getSourceStorageUriBytes()

public abstract ByteString getSourceStorageUriBytes()

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.

string source_storage_uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sourceStorageUri.

hasScope()

public abstract boolean hasScope()

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

.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.ImportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the scope field is set.

hasSourceCreateTime()

public abstract boolean hasSourceCreateTime()

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

.google.protobuf.Timestamp source_create_time = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sourceCreateTime field is set.