Class: Google::Cloud::Dataplex::V1::ImportItem

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/catalog.rb

Overview

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.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#aspect_keys ⇒ ::Array<::String>

Returns 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 implicitly adds the keys for all of the required aspects of an entry.

Returns:

  • (::Array<::String>) —

    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 implicitly adds the keys for all of the required aspects of an entry.



1188
1189
1190
1191
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1188

class ImportItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entry ⇒ ::Google::Cloud::Dataplex::V1::Entry

Returns Information about an entry and its attached aspects.

Returns:



1188
1189
1190
1191
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1188

class ImportItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

Returns 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 includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex 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 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.

Returns:

  • (::Google::Protobuf::FieldMask) —

    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 includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex 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 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.



1188
1189
1190
1191
 
# File 'proto_docs/google/cloud/dataplex/v1/catalog.rb', line 1188

class ImportItem
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end