public sealed class ImportItem : IMessage<ImportItem>, IEquatable<ImportItem>, IDeepCloneable<ImportItem>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Dataplex v1 API class 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][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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eImportItem\u003c/code\u003e class within the Google Cloud Dataplex V1 API, used for specifying metadata import details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eImportItem\u003c/code\u003e class is part of the \u003ccode\u003eGoogle.Cloud.Dataplex.V1\u003c/code\u003e namespace and is used in metadata import jobs to define modifications to entries and aspects.\u003c/p\u003e\n"],["\u003cp\u003eThe page lists multiple versions of the API, ranging from version 1.0.0 to the latest version, 3.6.0, allowing users to select the appropriate documentation.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eImportItem\u003c/code\u003e class include \u003ccode\u003eAspectKeys\u003c/code\u003e, which specifies which aspects to modify, \u003ccode\u003eEntry\u003c/code\u003e, which holds information about an entry and its aspects, and \u003ccode\u003eUpdateMask\u003c/code\u003e, which defines which fields of an entry to update.\u003c/p\u003e\n"],["\u003cp\u003eThis page explains the inheritance and implementation details of the class along with other methods, properties, and constructors.\u003c/p\u003e\n"]]],[],null,["# Cloud Dataplex v1 API - Class ImportItem (3.9.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.9.0 (latest)](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.8.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.7.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.6.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.5.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.4.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.3.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.2.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.1.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/3.0.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.15.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.15.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.14.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.14.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.13.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.13.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.12.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.12.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.11.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.11.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.10.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.10.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.9.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.9.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.8.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.8.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.7.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.6.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.5.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.4.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.3.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.2.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.1.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/2.0.0/Google.Cloud.Dataplex.V1.ImportItem)\n- [1.0.0](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/1.0.0/Google.Cloud.Dataplex.V1.ImportItem) \n\n public sealed class ImportItem : IMessage\u003cImportItem\u003e, IEquatable\u003cImportItem\u003e, IDeepCloneable\u003cImportItem\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Cloud Dataplex v1 API class ImportItem.\n\nAn object that describes the values that you want to set for an entry and its\nattached aspects when you import metadata. Used when you run a metadata\nimport job. See\n\\[CreateMetadataJob\\]\\[google.cloud.dataplex.v1.CatalogService.CreateMetadataJob\\].\n\nYou provide a collection of import items in a metadata import file. For more\ninformation about how to create a metadata import file, see [Metadata import\nfile](https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ImportItem \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ImportItem](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ImportItem), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ImportItem](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ImportItem), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ImportItem](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1.ImportItem), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataplex.V1](/dotnet/docs/reference/Google.Cloud.Dataplex.V1/latest/Google.Cloud.Dataplex.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataplex.V1.dll\n\nConstructors\n------------\n\n### ImportItem()\n\n public ImportItem()\n\n### ImportItem(ImportItem)\n\n public ImportItem(ImportItem other)\n\nProperties\n----------\n\n### AspectKeys\n\n public RepeatedField\u003cstring\u003e AspectKeys { get; }\n\nThe aspects to modify. Supports the following syntaxes:\n\n- `{aspect_type_reference}`: matches aspects that belong to the specified aspect type and are attached directly to the entry.\n- `{aspect_type_reference}@{path}`: matches aspects that belong to the specified aspect type and path.\n- `{aspect_type_reference}@*` : matches aspects of the given type for all paths.\n- `*@path` : matches aspects of all types on the given path.\n\nReplace `{aspect_type_reference}` with a reference to the aspect type, in\nthe format\n`{project_id_or_number}.{location_id}.{aspect_type_id}`.\n\nIn `FULL` entry sync mode, if you leave this field empty, it is treated as\nspecifying exactly those aspects that are present within the specified\nentry. Dataplex implicitly adds the keys for all of the required aspects of\nan entry.\n\n### Entry\n\n public Entry Entry { get; set; }\n\nInformation about an entry and its attached aspects.\n\n### UpdateMask\n\n public FieldMask UpdateMask { get; set; }\n\nThe fields to update, in paths that are relative to the `Entry` resource.\nSeparate each field with a comma.\n\nIn `FULL` entry sync mode, Dataplex includes the paths of all of the fields\nfor an entry that can be modified, including aspects. This means that\nDataplex replaces the existing entry with the entry in the metadata import\nfile. All modifiable fields are updated, regardless of the fields that are\nlisted in the update mask, and regardless of whether a field is present\nin the `entry` object.\n\nThe `update_mask` field is ignored when an entry is created or re-created.\n\nIn an aspect-only metadata job (when entry sync mode is `NONE`), set this\nvalue to `aspects`.\n\nDataplex also determines which entries and aspects to modify by comparing\nthe values and timestamps that you provide in the metadata import file with\nthe values and timestamps that exist in your project. For more information,\nsee [Comparison\nlogic](https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic)."]]