Package com.google.cloud.dataplex.v1

Class ImportItem

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dataplex.v1.ImportItem
All Implemented Interfaces:
ImportItemOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ImportItem extends com.google.protobuf.GeneratedMessage implements ImportItemOrBuilder
 An object that describes the values that you want to set for an entry and its
 attached aspects when you import metadata. Used when you run a metadata
 import job. See
 [CreateMetadataJob][google.cloud.dataplex.v1.CatalogService.CreateMetadataJob].

 You provide a collection of import items in a metadata import file. For more
 information about how to create a metadata import file, see [Metadata import
 file](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).
Protobuf type google.cloud.dataplex.v1.ImportItem
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ImportItem.Builder
    An object that describes the values that you want to set for an entry and its attached aspects when you import metadata.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ASPECT_KEYS_FIELD_NUMBER
     
    static final int
    ENTRY_FIELD_NUMBER
     
    static final int
    ENTRY_LINK_FIELD_NUMBER
     
    static final int
    UPDATE_MASK_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAspectKeys(int index)
    The aspects to modify.
    com.google.protobuf.ByteString
    getAspectKeysBytes(int index)
    The aspects to modify.
    int
    getAspectKeysCount()
    The aspects to modify.
    com.google.protobuf.ProtocolStringList
    getAspectKeysList()
    The aspects to modify.
    static ImportItem
    getDefaultInstance()
     
    ImportItem
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Entry
    getEntry()
    Information about an entry and its attached aspects.
    EntryLink
    getEntryLink()
    Information about the entry link.
    EntryLinkOrBuilder
    getEntryLinkOrBuilder()
    Information about the entry link.
    EntryOrBuilder
    getEntryOrBuilder()
    Information about an entry and its attached aspects.
    com.google.protobuf.Parser<ImportItem>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.FieldMask
    getUpdateMask()
    The fields to update, in paths that are relative to the `Entry` resource.
    com.google.protobuf.FieldMaskOrBuilder
    getUpdateMaskOrBuilder()
    The fields to update, in paths that are relative to the `Entry` resource.
    boolean
    hasEntry()
    Information about an entry and its attached aspects.
    boolean
    hasEntryLink()
    Information about the entry link.
    int
    hashCode()
     
    boolean
    hasUpdateMask()
    The fields to update, in paths that are relative to the `Entry` resource.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ImportItem.Builder
    newBuilder()
     
    static ImportItem.Builder
    newBuilder(ImportItem prototype)
     
    ImportItem.Builder
    newBuilderForType()
     
    protected ImportItem.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ImportItem
    parseDelimitedFrom(InputStream input)
     
    static ImportItem
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ImportItem
    parseFrom(byte[] data)
     
    static ImportItem
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ImportItem
    parseFrom(com.google.protobuf.ByteString data)
     
    static ImportItem
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ImportItem
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ImportItem
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ImportItem
    parseFrom(InputStream input)
     
    static ImportItem
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ImportItem
    parseFrom(ByteBuffer data)
     
    static ImportItem
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ImportItem>
    parser()
     
    ImportItem.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • 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

    • hasEntry

      public boolean hasEntry()
       Information about an entry and its attached aspects.
      .google.cloud.dataplex.v1.Entry entry = 1;
      Specified by:
      hasEntry in interface ImportItemOrBuilder
      Returns:
      Whether the entry field is set.

    • getEntry

      public Entry getEntry()
       Information about an entry and its attached aspects.
      .google.cloud.dataplex.v1.Entry entry = 1;
      Specified by:
      getEntry in interface ImportItemOrBuilder
      Returns:
      The entry.

    • getEntryOrBuilder

      public EntryOrBuilder getEntryOrBuilder()
       Information about an entry and its attached aspects.
      .google.cloud.dataplex.v1.Entry entry = 1;
      Specified by:
      getEntryOrBuilder in interface ImportItemOrBuilder

    • hasEntryLink

      public boolean hasEntryLink()
       Information about the entry link. User should provide either one of the
 entry or entry_link. While providing entry_link, user should not
 provide update_mask and aspect_keys.
      .google.cloud.dataplex.v1.EntryLink entry_link = 4;
      Specified by:
      hasEntryLink in interface ImportItemOrBuilder
      Returns:
      Whether the entryLink field is set.

    • getEntryLink

      public EntryLink getEntryLink()
       Information about the entry link. User should provide either one of the
 entry or entry_link. While providing entry_link, user should not
 provide update_mask and aspect_keys.
      .google.cloud.dataplex.v1.EntryLink entry_link = 4;
      Specified by:
      getEntryLink in interface ImportItemOrBuilder
      Returns:
      The entryLink.

    • getEntryLinkOrBuilder

      public EntryLinkOrBuilder getEntryLinkOrBuilder()
       Information about the entry link. User should provide either one of the
 entry or entry_link. While providing entry_link, user should not
 provide update_mask and aspect_keys.
      .google.cloud.dataplex.v1.EntryLink entry_link = 4;
      Specified by:
      getEntryLinkOrBuilder in interface ImportItemOrBuilder

    • hasUpdateMask

      public boolean hasUpdateMask()
       The fields to update, in paths that are relative to the `Entry` resource.
 Separate each field with a comma.

 In `FULL` entry sync mode, Dataplex Universal Catalog includes the paths of
 all of the fields for an entry that can be modified, including aspects.
 This means that Dataplex Universal Catalog replaces the existing entry with
 the entry in the metadata import file. All modifiable fields are updated,
 regardless of the fields that are listed in the update mask, and regardless
 of whether a field is present in the `entry` object.

 The `update_mask` field is ignored when an entry is created or re-created.

 In an aspect-only metadata job (when entry sync mode is `NONE`), set this
 value to `aspects`.


 Dataplex Universal Catalog also determines which entries and aspects to
 modify by comparing the values and timestamps that you provide in the
 metadata import file with the values and timestamps that exist in your
 project. For more information, see [Comparison
 logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).
      .google.protobuf.FieldMask update_mask = 2;
      Specified by:
      hasUpdateMask in interface ImportItemOrBuilder
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      public com.google.protobuf.FieldMask getUpdateMask()
       The fields to update, in paths that are relative to the `Entry` resource.
 Separate each field with a comma.

 In `FULL` entry sync mode, Dataplex Universal Catalog includes the paths of
 all of the fields for an entry that can be modified, including aspects.
 This means that Dataplex Universal Catalog replaces the existing entry with
 the entry in the metadata import file. All modifiable fields are updated,
 regardless of the fields that are listed in the update mask, and regardless
 of whether a field is present in the `entry` object.

 The `update_mask` field is ignored when an entry is created or re-created.

 In an aspect-only metadata job (when entry sync mode is `NONE`), set this
 value to `aspects`.


 Dataplex Universal Catalog also determines which entries and aspects to
 modify by comparing the values and timestamps that you provide in the
 metadata import file with the values and timestamps that exist in your
 project. For more information, see [Comparison
 logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).
      .google.protobuf.FieldMask update_mask = 2;
      Specified by:
      getUpdateMask in interface ImportItemOrBuilder
      Returns:
      The updateMask.

    • getUpdateMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
       The fields to update, in paths that are relative to the `Entry` resource.
 Separate each field with a comma.

 In `FULL` entry sync mode, Dataplex Universal Catalog includes the paths of
 all of the fields for an entry that can be modified, including aspects.
 This means that Dataplex Universal Catalog replaces the existing entry with
 the entry in the metadata import file. All modifiable fields are updated,
 regardless of the fields that are listed in the update mask, and regardless
 of whether a field is present in the `entry` object.

 The `update_mask` field is ignored when an entry is created or re-created.

 In an aspect-only metadata job (when entry sync mode is `NONE`), set this
 value to `aspects`.


 Dataplex Universal Catalog also determines which entries and aspects to
 modify by comparing the values and timestamps that you provide in the
 metadata import file with the values and timestamps that exist in your
 project. For more information, see [Comparison
 logic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).
      .google.protobuf.FieldMask update_mask = 2;
      Specified by:
      getUpdateMaskOrBuilder in interface ImportItemOrBuilder

    • getAspectKeysList

      public com.google.protobuf.ProtocolStringList getAspectKeysList()
       The aspects to modify. Supports the following syntaxes:

 * `{aspect_type_reference}`: matches aspects that belong to the specified
 aspect type and are attached directly to the entry.
 * `{aspect_type_reference}@{path}`: matches aspects that belong to the
 specified aspect type and path.
 * `{aspect_type_reference}@*` : matches aspects of the given type for all
 paths.
 * `*@path` : matches aspects of all types on the given path.

 Replace `{aspect_type_reference}` with a reference to the aspect type, in
 the format
 `{project_id_or_number}.{location_id}.{aspect_type_id}`.

 In `FULL` entry sync mode, if you leave this field empty, it is treated as
 specifying exactly those aspects that are present within the specified
 entry. Dataplex Universal Catalog implicitly adds the keys for all of the
 required aspects of an entry.
      repeated string aspect_keys = 3;
      Specified by:
      getAspectKeysList in interface ImportItemOrBuilder
      Returns:
      A list containing the aspectKeys.

    • getAspectKeysCount

      public int getAspectKeysCount()
       The aspects to modify. Supports the following syntaxes:

 * `{aspect_type_reference}`: matches aspects that belong to the specified
 aspect type and are attached directly to the entry.
 * `{aspect_type_reference}@{path}`: matches aspects that belong to the
 specified aspect type and path.
 * `{aspect_type_reference}@*` : matches aspects of the given type for all
 paths.
 * `*@path` : matches aspects of all types on the given path.

 Replace `{aspect_type_reference}` with a reference to the aspect type, in
 the format
 `{project_id_or_number}.{location_id}.{aspect_type_id}`.

 In `FULL` entry sync mode, if you leave this field empty, it is treated as
 specifying exactly those aspects that are present within the specified
 entry. Dataplex Universal Catalog implicitly adds the keys for all of the
 required aspects of an entry.
      repeated string aspect_keys = 3;
      Specified by:
      getAspectKeysCount in interface ImportItemOrBuilder
      Returns:
      The count of aspectKeys.

    • getAspectKeys

      public String getAspectKeys(int index)
       The aspects to modify. Supports the following syntaxes:

 * `{aspect_type_reference}`: matches aspects that belong to the specified
 aspect type and are attached directly to the entry.
 * `{aspect_type_reference}@{path}`: matches aspects that belong to the
 specified aspect type and path.
 * `{aspect_type_reference}@*` : matches aspects of the given type for all
 paths.
 * `*@path` : matches aspects of all types on the given path.

 Replace `{aspect_type_reference}` with a reference to the aspect type, in
 the format
 `{project_id_or_number}.{location_id}.{aspect_type_id}`.

 In `FULL` entry sync mode, if you leave this field empty, it is treated as
 specifying exactly those aspects that are present within the specified
 entry. Dataplex Universal Catalog implicitly adds the keys for all of the
 required aspects of an entry.
      repeated string aspect_keys = 3;
      Specified by:
      getAspectKeys in interface ImportItemOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The aspectKeys at the given index.

    • getAspectKeysBytes

      public com.google.protobuf.ByteString getAspectKeysBytes(int index)
       The aspects to modify. Supports the following syntaxes:

 * `{aspect_type_reference}`: matches aspects that belong to the specified
 aspect type and are attached directly to the entry.
 * `{aspect_type_reference}@{path}`: matches aspects that belong to the
 specified aspect type and path.
 * `{aspect_type_reference}@*` : matches aspects of the given type for all
 paths.
 * `*@path` : matches aspects of all types on the given path.

 Replace `{aspect_type_reference}` with a reference to the aspect type, in
 the format
 `{project_id_or_number}.{location_id}.{aspect_type_id}`.

 In `FULL` entry sync mode, if you leave this field empty, it is treated as
 specifying exactly those aspects that are present within the specified
 entry. Dataplex Universal Catalog implicitly adds the keys for all of the
 required aspects of an entry.
      repeated string aspect_keys = 3;
      Specified by:
      getAspectKeysBytes in interface ImportItemOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the aspectKeys at the given index.

    • 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 ImportItem parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ImportItem parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ImportItem parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ImportItem.Builder newBuilder()

    • newBuilder

      public static ImportItem.Builder newBuilder(ImportItem prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ImportItem getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ImportItem> 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 ImportItem getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder