Class EntityReference.Builder (0.85.0)

public static final class EntityReference.Builder extends GeneratedMessage.Builder<EntityReference.Builder> implements EntityReferenceOrBuilder

The soft reference to everything you can attach a lineage event to.

Protobuf type google.cloud.datacatalog.lineage.v1.EntityReference

Static Methods

getDescriptor()

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

Methods

addAllField(Iterable<String> values)

public EntityReference.Builder addAllField(Iterable<String> values)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The field to add.

Returns
Type Description
EntityReference.Builder

This builder for chaining.

addField(String value)

public EntityReference.Builder addField(String value)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The field to add.

Returns
Type Description
EntityReference.Builder

This builder for chaining.

addFieldBytes(ByteString value)

public EntityReference.Builder addFieldBytes(ByteString value)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the field to add.

Returns
Type Description
EntityReference.Builder

This builder for chaining.

build()

public EntityReference build()
Returns
Type Description
EntityReference

buildPartial()

public EntityReference buildPartial()
Returns
Type Description
EntityReference

clear()

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

clearField()

public EntityReference.Builder clearField()

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
EntityReference.Builder

This builder for chaining.

clearFullyQualifiedName()

public EntityReference.Builder clearFullyQualifiedName()

Required. Fully Qualified Name (FQN) of the entity.

string fully_qualified_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
EntityReference.Builder

This builder for chaining.

getDefaultInstanceForType()

public EntityReference getDefaultInstanceForType()
Returns
Type Description
EntityReference

getDescriptorForType()

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

getField(int index)

public String getField(int index)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The field at the given index.

getFieldBytes(int index)

public ByteString getFieldBytes(int index)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the field at the given index.

getFieldCount()

public int getFieldCount()

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of field.

getFieldList()

public ProtocolStringList getFieldList()

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the field.

getFullyQualifiedName()

public String getFullyQualifiedName()

Required. Fully Qualified Name (FQN) of the entity.

string fully_qualified_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The fullyQualifiedName.

getFullyQualifiedNameBytes()

public ByteString getFullyQualifiedNameBytes()

Required. Fully Qualified Name (FQN) of the entity.

string fully_qualified_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for fullyQualifiedName.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EntityReference other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setField(int index, String value)

public EntityReference.Builder setField(int index, String value)

Optional. Field path within the entity. Each nesting level should be a separate value in the repeated field. The order matters. Must be empty for asset level lineage

For example to address "salary.net" subfield where "salary" is a column and "net" is a proto field two values in the field should be reported, the first is "salary" and the second is "net".

Each field length is limited to 500 characters. Maximum supported nesting level is 20.

repeated string field = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int

The index to set the value at.

value String

The field to set.

Returns
Type Description
EntityReference.Builder

This builder for chaining.

setFullyQualifiedName(String value)

public EntityReference.Builder setFullyQualifiedName(String value)

Required. Fully Qualified Name (FQN) of the entity.

string fully_qualified_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The fullyQualifiedName to set.

Returns
Type Description
EntityReference.Builder

This builder for chaining.

setFullyQualifiedNameBytes(ByteString value)

public EntityReference.Builder setFullyQualifiedNameBytes(ByteString value)

Required. Fully Qualified Name (FQN) of the entity.

string fully_qualified_name = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for fullyQualifiedName to set.

Returns
Type Description
EntityReference.Builder

This builder for chaining.