Package com.google.cloud.dataplex.v1

Class MetadataJob.ImportJobSpec.Builder

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

  • 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.Builder<MetadataJob.ImportJobSpec.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<MetadataJob.ImportJobSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public MetadataJob.ImportJobSpec.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataJob.ImportJobSpec.Builder>

    • mergeFrom

      public MetadataJob.ImportJobSpec.Builder mergeFrom(MetadataJob.ImportJobSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<MetadataJob.ImportJobSpec.Builder>

    • mergeFrom

      public MetadataJob.ImportJobSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetadataJob.ImportJobSpec.Builder>
      Throws:
      IOException

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

    • setSourceStorageUri

      public MetadataJob.ImportJobSpec.Builder setSourceStorageUri(String value)
       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];
      Parameters:
      value - The sourceStorageUri to set.
      Returns:
      This builder for chaining.

    • clearSourceStorageUri

      public MetadataJob.ImportJobSpec.Builder clearSourceStorageUri()
       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];
      Returns:
      This builder for chaining.

    • setSourceStorageUriBytes

      public MetadataJob.ImportJobSpec.Builder setSourceStorageUriBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for sourceStorageUri to set.
      Returns:
      This builder for chaining.

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

    • setSourceCreateTime

      public MetadataJob.ImportJobSpec.Builder setSourceCreateTime(com.google.protobuf.Timestamp value)
       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];

    • setSourceCreateTime

      public MetadataJob.ImportJobSpec.Builder setSourceCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];

    • mergeSourceCreateTime

      public MetadataJob.ImportJobSpec.Builder mergeSourceCreateTime(com.google.protobuf.Timestamp value)
       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];

    • clearSourceCreateTime

      public MetadataJob.ImportJobSpec.Builder clearSourceCreateTime()
       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];

    • getSourceCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getSourceCreateTimeBuilder()
       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];

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

    • setScope

      public MetadataJob.ImportJobSpec.Builder setScope(MetadataJob.ImportJobSpec.ImportJobScope value)
       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];

    • setScope

      public MetadataJob.ImportJobSpec.Builder setScope(MetadataJob.ImportJobSpec.ImportJobScope.Builder builderForValue)
       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];

    • mergeScope

      public MetadataJob.ImportJobSpec.Builder mergeScope(MetadataJob.ImportJobSpec.ImportJobScope value)
       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];

    • clearScope

      public MetadataJob.ImportJobSpec.Builder clearScope()
       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];

    • getScopeBuilder

      public MetadataJob.ImportJobSpec.ImportJobScope.Builder getScopeBuilder()
       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];

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

    • setEntrySyncModeValue

      public MetadataJob.ImportJobSpec.Builder setEntrySyncModeValue(int value)
       Required. The sync mode for entries.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for entrySyncMode to set.
      Returns:
      This builder for chaining.

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

    • setEntrySyncMode

      public MetadataJob.ImportJobSpec.Builder setEntrySyncMode(MetadataJob.ImportJobSpec.SyncMode value)
       Required. The sync mode for entries.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The entrySyncMode to set.
      Returns:
      This builder for chaining.

    • clearEntrySyncMode

      public MetadataJob.ImportJobSpec.Builder clearEntrySyncMode()
       Required. The sync mode for entries.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode entry_sync_mode = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

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

    • setAspectSyncModeValue

      public MetadataJob.ImportJobSpec.Builder setAspectSyncModeValue(int value)
       Required. The sync mode for aspects.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for aspectSyncMode to set.
      Returns:
      This builder for chaining.

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

    • setAspectSyncMode

      public MetadataJob.ImportJobSpec.Builder setAspectSyncMode(MetadataJob.ImportJobSpec.SyncMode value)
       Required. The sync mode for aspects.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The aspectSyncMode to set.
      Returns:
      This builder for chaining.

    • clearAspectSyncMode

      public MetadataJob.ImportJobSpec.Builder clearAspectSyncMode()
       Required. The sync mode for aspects.
      .google.cloud.dataplex.v1.MetadataJob.ImportJobSpec.SyncMode aspect_sync_mode = 4 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

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

    • setLogLevelValue

      public MetadataJob.ImportJobSpec.Builder setLogLevelValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for logLevel to set.
      Returns:
      This builder for chaining.

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

    • setLogLevel

      public MetadataJob.ImportJobSpec.Builder setLogLevel(MetadataJob.ImportJobSpec.LogLevel value)
       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];
      Parameters:
      value - The logLevel to set.
      Returns:
      This builder for chaining.

    • clearLogLevel

      public MetadataJob.ImportJobSpec.Builder clearLogLevel()
       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];
      Returns:
      This builder for chaining.