Class ImportItem.Builder (1.52.0) 

public static final class ImportItem.Builder extends GeneratedMessageV3.Builder<ImportItem.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportItem.Builder

Implements

ImportItemOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllAspectKeys(Iterable<String> values)

public ImportItem.Builder addAllAspectKeys(Iterable<String> values)

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
values Iterable<String>

The aspectKeys to add.
Returns
Type Description
ImportItem.Builder

This builder for chaining.

addAspectKeys(String value)

public ImportItem.Builder addAspectKeys(String value)

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
value String

The aspectKeys to add.
Returns
Type Description
ImportItem.Builder

This builder for chaining.

addAspectKeysBytes(ByteString value)

public ImportItem.Builder addAspectKeysBytes(ByteString value)

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
value ByteString

The bytes of the aspectKeys to add.
Returns
Type Description
ImportItem.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportItem.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportItem.Builder
Overrides

build()

public ImportItem build()
Returns
Type Description
ImportItem

buildPartial()

public ImportItem buildPartial()
Returns
Type Description
ImportItem

clear()

public ImportItem.Builder clear()
Returns
Type Description
ImportItem.Builder
Overrides

clearAspectKeys()

public ImportItem.Builder clearAspectKeys()

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
ImportItem.Builder

This builder for chaining.

clearEntry()

public ImportItem.Builder clearEntry()

Information about an entry and its attached aspects.

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

Returns
Type Description
ImportItem.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportItem.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportItem.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportItem.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportItem.Builder
Overrides

clearUpdateMask()

public ImportItem.Builder clearUpdateMask()

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
ImportItem.Builder

clone()

public ImportItem.Builder clone()
Returns
Type Description
ImportItem.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEntryBuilder()

public Entry.Builder getEntryBuilder()

Information about an entry and its attached aspects.

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

Returns
Type Description
Entry.Builder

getEntryOrBuilder()

public EntryOrBuilder getEntryOrBuilder()

Information about an entry and its attached aspects.

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

Returns
Type Description
EntryOrBuilder

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.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEntry(Entry value)

public ImportItem.Builder mergeEntry(Entry value)

Information about an entry and its attached aspects.

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

Parameter
Name Description
value Entry
Returns
Type Description
ImportItem.Builder

mergeFrom(ImportItem other)

public ImportItem.Builder mergeFrom(ImportItem other)
Parameter
Name Description
other ImportItem
Returns
Type Description
ImportItem.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportItem.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportItem.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportItem.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportItem.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportItem.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportItem.Builder
Overrides

mergeUpdateMask(FieldMask value)

public ImportItem.Builder mergeUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ImportItem.Builder

setAspectKeys(int index, String value)

public ImportItem.Builder setAspectKeys(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The aspectKeys to set.
Returns
Type Description
ImportItem.Builder

This builder for chaining.

setEntry(Entry value)

public ImportItem.Builder setEntry(Entry value)

Information about an entry and its attached aspects.

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

Parameter
Name Description
value Entry
Returns
Type Description
ImportItem.Builder

setEntry(Entry.Builder builderForValue)

public ImportItem.Builder setEntry(Entry.Builder builderForValue)

Information about an entry and its attached aspects.

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

Parameter
Name Description
builderForValue Entry.Builder
Returns
Type Description
ImportItem.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportItem.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportItem.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ImportItem.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportItem.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportItem.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportItem.Builder
Overrides

setUpdateMask(FieldMask value)

public ImportItem.Builder setUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ImportItem.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public ImportItem.Builder setUpdateMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ImportItem.Builder