Package com.google.cloud.dataplex.v1

Interface ImportItemOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ImportItem, ImportItem.Builder
@Generated public interface ImportItemOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    List<String>
    getAspectKeysList()
    The aspects to modify.
    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.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.
    boolean
    hasUpdateMask()
    The fields to update, in paths that are relative to the `Entry` resource.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasEntry

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

    • getEntry

      Entry getEntry()
       Information about an entry and its attached aspects.
      .google.cloud.dataplex.v1.Entry entry = 1;
      Returns:
      The entry.

    • getEntryOrBuilder

      EntryOrBuilder getEntryOrBuilder()
       Information about an entry and its attached aspects.
      .google.cloud.dataplex.v1.Entry entry = 1;

    • hasEntryLink

      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;
      Returns:
      Whether the entryLink field is set.

    • getEntryLink

      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;
      Returns:
      The entryLink.

    • getEntryLinkOrBuilder

      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;

    • hasUpdateMask

      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;
      Returns:
      Whether the updateMask field is set.

    • getUpdateMask

      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;
      Returns:
      The updateMask.

    • getUpdateMaskOrBuilder

      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;

    • getAspectKeysList

      List<String> 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;
      Returns:
      A list containing the aspectKeys.

    • getAspectKeysCount

      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;
      Returns:
      The count of aspectKeys.

    • getAspectKeys

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The aspectKeys at the given index.

    • getAspectKeysBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the aspectKeys at the given index.