Reference documentation and code samples for the Google Cloud Dataplex V1 Client 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.
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.
Generated from protobuf message google.cloud.dataplex.v1.ImportItem
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.
↳ aspect_keys
array
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.
getEntry
Information about an entry and its attached aspects.
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.
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.
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 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ImportItem (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.ImportItem)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.ImportItem)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.ImportItem)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.ImportItem)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.ImportItem)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.ImportItem)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.ImportItem)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.ImportItem)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.ImportItem)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.ImportItem)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.ImportItem)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.ImportItem)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.ImportItem)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.ImportItem)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.ImportItem)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.ImportItem)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.ImportItem)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.ImportItem)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.ImportItem)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.ImportItem)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.ImportItem)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.ImportItem)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.ImportItem)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.ImportItem) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client 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](/php/docs/reference/cloud-dataplex/latest/V1.Client.CatalogServiceClient#_Google_Cloud_Dataplex_V1_Client_CatalogServiceClient__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\nGenerated from protobuf message `google.cloud.dataplex.v1.ImportItem`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getEntry\n\nInformation about an entry and its attached aspects.\n\n### hasEntry\n\n### clearEntry\n\n### setEntry\n\nInformation about an entry and its attached aspects.\n\n### getUpdateMask\n\nThe fields to update, in paths that are relative to the `Entry` resource.\n\nSeparate each field with a comma.\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.\nThe `update_mask` field is ignored when an entry is created or re-created.\nIn an aspect-only metadata job (when entry sync mode is `NONE`), set this\nvalue to `aspects`.\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).\n\n### hasUpdateMask\n\n### clearUpdateMask\n\n### setUpdateMask\n\nThe fields to update, in paths that are relative to the `Entry` resource.\n\nSeparate each field with a comma.\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.\nThe `update_mask` field is ignored when an entry is created or re-created.\nIn an aspect-only metadata job (when entry sync mode is `NONE`), set this\nvalue to `aspects`.\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).\n\n### getAspectKeys\n\nThe aspects to modify. Supports the following syntaxes:\n\n- `{aspect_type_reference}`: matches aspects that belong to the specified\n aspect type and are attached directly to the entry.\n\n- `{aspect_type_reference}@{path}`: matches aspects that belong to the\n specified aspect type and path.\n\n- `{aspect_type_reference}@*` : matches aspects of the given type for all paths.\n- `*@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.\n\n### setAspectKeys\n\nThe aspects to modify. Supports the following syntaxes:\n\n- `{aspect_type_reference}`: matches aspects that belong to the specified\n aspect type and are attached directly to the entry.\n\n- `{aspect_type_reference}@{path}`: matches aspects that belong to the\n specified aspect type and path.\n\n- `{aspect_type_reference}@*` : matches aspects of the given type for all paths.\n- `*@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."]]
