Class MetadataJob.ImportJobSpec (1.53.0)

public static final class MetadataJob.ImportJobSpec extends GeneratedMessageV3 implements MetadataJob.ImportJobSpecOrBuilder

Job specification for a metadata import job

Protobuf type google.cloud.dataplex.v1.MetadataJob.ImportJobSpec

Static Fields

ASPECT_SYNC_MODE_FIELD_NUMBER

public static final int ASPECT_SYNC_MODE_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_SYNC_MODE_FIELD_NUMBER

public static final int ENTRY_SYNC_MODE_FIELD_NUMBER
Field Value
Type Description
int

LOG_LEVEL_FIELD_NUMBER

public static final int LOG_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CREATE_TIME_FIELD_NUMBER

public static final int SOURCE_CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_STORAGE_URI_FIELD_NUMBER

public static final int SOURCE_STORAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataJob.ImportJobSpec getDefaultInstance()
Returns
Type Description
MetadataJob.ImportJobSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MetadataJob.ImportJobSpec.Builder newBuilder()
Returns
Type Description
MetadataJob.ImportJobSpec.Builder

newBuilder(MetadataJob.ImportJobSpec prototype)

public static MetadataJob.ImportJobSpec.Builder newBuilder(MetadataJob.ImportJobSpec prototype)
Parameter
Name Description
prototype MetadataJob.ImportJobSpec
Returns
Type Description
MetadataJob.ImportJobSpec.Builder

parseDelimitedFrom(InputStream input)

public static MetadataJob.ImportJobSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetadataJob.ImportJobSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetadataJob.ImportJobSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetadataJob.ImportJobSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetadataJob.ImportJobSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetadataJob.ImportJobSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ImportJobSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ImportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetadataJob.ImportJobSpec> parser()
Returns
Type Description
Parser<ImportJobSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAspectSyncMode()

public 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 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.

getDefaultInstanceForType()

public MetadataJob.ImportJobSpec getDefaultInstanceForType()
Returns
Type Description
MetadataJob.ImportJobSpec

getEntrySyncMode()

public 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 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 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 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.

getParserForType()

public Parser<MetadataJob.ImportJobSpec> getParserForType()
Returns
Type Description
Parser<ImportJobSpec>
Overrides

getScope()

public 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCreateTime()

public 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetadataJob.ImportJobSpec.Builder newBuilderForType()
Returns
Type Description
MetadataJob.ImportJobSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetadataJob.ImportJobSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataJob.ImportJobSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetadataJob.ImportJobSpec.Builder toBuilder()
Returns
Type Description
MetadataJob.ImportJobSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException