Class ImportItem (1.53.0)

public final class ImportItem extends GeneratedMessageV3 implements ImportItemOrBuilder

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.

Protobuf type google.cloud.dataplex.v1.ImportItem

Implements

ImportItemOrBuilder

Static Fields

ASPECT_KEYS_FIELD_NUMBER

public static final int ASPECT_KEYS_FIELD_NUMBER
Field Value
Type Description
int

ENTRY_FIELD_NUMBER

public static final int ENTRY_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportItem getDefaultInstance()
Returns
Type Description
ImportItem

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ImportItem.Builder newBuilder()
Returns
Type Description
ImportItem.Builder

newBuilder(ImportItem prototype)

public static ImportItem.Builder newBuilder(ImportItem prototype)
Parameter
Name Description
prototype ImportItem
Returns
Type Description
ImportItem.Builder

parseDelimitedFrom(InputStream input)

public static ImportItem parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImportItem parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportItem parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportItem parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImportItem parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImportItem parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportItem parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImportItem> parser()
Returns
Type Description
Parser<ImportItem>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAspectKeys(int index)

public String getAspectKeys(int index)

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.

repeated string aspect_keys = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The aspectKeys at the given index.

getAspectKeysBytes(int index)

public ByteString getAspectKeysBytes(int index)

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.

repeated string aspect_keys = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the aspectKeys at the given index.

getAspectKeysCount()

public int getAspectKeysCount()

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.

repeated string aspect_keys = 3;

Returns
Type Description
int

The count of aspectKeys.

getAspectKeysList()

public ProtocolStringList getAspectKeysList()

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.

repeated string aspect_keys = 3;

Returns
Type Description
ProtocolStringList

A list containing the aspectKeys.

getDefaultInstanceForType()

public ImportItem getDefaultInstanceForType()
Returns
Type Description
ImportItem

getEntry()

public Entry getEntry()

Information about an entry and its attached aspects.

.google.cloud.dataplex.v1.Entry entry = 1;

Returns
Type Description
Entry

The entry.

getEntryOrBuilder()

public EntryOrBuilder getEntryOrBuilder()

Information about an entry and its attached aspects.

.google.cloud.dataplex.v1.Entry entry = 1;

Returns
Type Description
EntryOrBuilder

getParserForType()

public Parser<ImportItem> getParserForType()
Returns
Type Description
Parser<ImportItem>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateMask()

public FieldMask 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 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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
FieldMaskOrBuilder

hasEntry()

public boolean hasEntry()

Information about an entry and its attached aspects.

.google.cloud.dataplex.v1.Entry entry = 1;

Returns
Type Description
boolean

Whether the entry field is set.

hasUpdateMask()

public boolean hasUpdateMask()

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.

.google.protobuf.FieldMask update_mask = 2;

Returns
Type Description
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImportItem.Builder newBuilderForType()
Returns
Type Description
ImportItem.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportItem.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportItem.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ImportItem.Builder toBuilder()
Returns
Type Description
ImportItem.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException