Google Cloud Dataplex V1 Client - Class ImportItem (1.8.0)

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ entry Entry

Information about an entry and its attached aspects.
↳ entry_link EntryLink

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

getEntry

Information about an entry and its attached aspects.

Returns
Type Description
Entry|null

hasEntry

clearEntry

setEntry

Information about an entry and its attached aspects.

Parameter
Name Description
var Entry
Returns
Type Description
$this

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.

Returns
Type Description
EntryLink|null

hasEntryLink

clearEntryLink

setEntryLink

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.

Parameter
Name Description
var EntryLink
Returns
Type Description
$this

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.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

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.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getAspectKeys

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.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAspectKeys

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.
Parameter
Name Description
var string[]
Returns
Type Description
$this