Package com.google.cloud.dataplex.v1

Class MetadataJob.ImportJobSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.MetadataJob.ImportJobSpec
All Implemented Interfaces:
MetadataJob.ImportJobSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
MetadataJob
public static final class MetadataJob.ImportJobSpec extends com.google.protobuf.GeneratedMessage implements MetadataJob.ImportJobSpecOrBuilder
 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.
Protobuf type google.cloud.dataplex.v1.MetadataJob.ImportJobSpec
See Also:

  • Field Details

    • SOURCE_STORAGE_URI_FIELD_NUMBER

      public static final int SOURCE_STORAGE_URI_FIELD_NUMBER
      See Also:

    • SOURCE_CREATE_TIME_FIELD_NUMBER

      public static final int SOURCE_CREATE_TIME_FIELD_NUMBER
      See Also:

    • SCOPE_FIELD_NUMBER

      public static final int SCOPE_FIELD_NUMBER
      See Also:

    • ENTRY_SYNC_MODE_FIELD_NUMBER

      public static final int ENTRY_SYNC_MODE_FIELD_NUMBER
      See Also:

    • ASPECT_SYNC_MODE_FIELD_NUMBER

      public static final int ASPECT_SYNC_MODE_FIELD_NUMBER
      See Also:

    • LOG_LEVEL_FIELD_NUMBER

      public static final int LOG_LEVEL_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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 import job. For more information about how to
 create a metadata import file and the file requirements, see [Metadata
 import
 file](https://cloud.google.com/dataplex/docs/import-metadata#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];
      Specified by:
      getSourceStorageUri in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The sourceStorageUri.

    • getSourceStorageUriBytes

      public com.google.protobuf.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 import job. For more information about how to
 create a metadata import file and the file requirements, see [Metadata
 import
 file](https://cloud.google.com/dataplex/docs/import-metadata#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];
      Specified by:
      getSourceStorageUriBytes in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The bytes for sourceStorageUri.

    • 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];
      Specified by:
      hasSourceCreateTime in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      Whether the sourceCreateTime field is set.

    • getSourceCreateTime

      public com.google.protobuf.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];
      Specified by:
      getSourceCreateTime in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The sourceCreateTime.

    • getSourceCreateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getSourceCreateTimeOrBuilder in interface MetadataJob.ImportJobSpecOrBuilder

    • 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];
      Specified by:
      hasScope in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      Whether the scope field is set.

    • 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];
      Specified by:
      getScope in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      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];
      Specified by:
      getScopeOrBuilder in interface MetadataJob.ImportJobSpecOrBuilder

    • getEntrySyncModeValue

      public int getEntrySyncModeValue()
       Required. The sync mode for entries.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntrySyncModeValue in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The enum numeric value on the wire for entrySyncMode.

    • getEntrySyncMode

      public MetadataJob.ImportJobSpec.SyncMode getEntrySyncMode()
       Required. The sync mode for entries.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntrySyncMode in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The entrySyncMode.

    • getAspectSyncModeValue

      public int getAspectSyncModeValue()
       Required. The sync mode for aspects.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAspectSyncModeValue in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The enum numeric value on the wire for aspectSyncMode.

    • getAspectSyncMode

      public MetadataJob.ImportJobSpec.SyncMode getAspectSyncMode()
       Required. The sync mode for aspects.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAspectSyncMode in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The aspectSyncMode.

    • 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](https://cloud.google.com/stackdriver/pricing) 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];
      Specified by:
      getLogLevelValue in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The enum numeric value on the wire for logLevel.

    • 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](https://cloud.google.com/stackdriver/pricing) 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];
      Specified by:
      getLogLevel in interface MetadataJob.ImportJobSpecOrBuilder
      Returns:
      The logLevel.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetadataJob.ImportJobSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MetadataJob.ImportJobSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MetadataJob.ImportJobSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MetadataJob.ImportJobSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MetadataJob.ImportJobSpec.Builder newBuilder()

    • newBuilder

      public static MetadataJob.ImportJobSpec.Builder newBuilder(MetadataJob.ImportJobSpec prototype)

    • toBuilder

      public MetadataJob.ImportJobSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MetadataJob.ImportJobSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MetadataJob.ImportJobSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MetadataJob.ImportJobSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<MetadataJob.ImportJobSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public MetadataJob.ImportJobSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder