Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ImportItem (v1.1.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ImportItem.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aspect_keys

def aspect_keys() -> ::Array<::String>
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 that belong to the specified aspect type for all paths.

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

    If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.

    In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.

#aspect_keys=

def aspect_keys=(value) -> ::Array<::String>
Parameter
  • value (::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 that belong to the specified aspect type for all paths.

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

    If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.

    In FULL entry sync mode, 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 that belong to the specified aspect type for all paths.

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

    If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.

    In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.

#entry

def entry() -> ::Google::Cloud::Dataplex::V1::Entry
Returns

#entry=

def entry=(value) -> ::Google::Cloud::Dataplex::V1::Entry
Parameter
Returns

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask
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.

    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.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::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.

    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.

    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.