Package com.atlan.model.relations

Class Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.relations.Reference.ReferenceBuilder<C,B>
Direct Known Subclasses:
Asset.AssetBuilder
Enclosing class:
Reference
public abstract static class Reference.ReferenceBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>> extends AtlanObject.AtlanObjectBuilder<C,B>

  • Constructor Details

    • ReferenceBuilder

      public ReferenceBuilder()

  • Method Details

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>

    • semantic

      public B semantic(Reference.SaveSemantic semantic)
      Semantic for how this relationship should be saved, if used in an asset request on which .save() is called.
      Returns:
      this.

    • completeObject

      public B completeObject(boolean completeObject)
      Internal tracking of whether this represents a complete view of an object, or not.
      Returns:
      this.

    • typeName

      public B typeName(String typeName)
      Name of the type that defines the entity.
      Returns:
      this.

    • docId

      public B docId(String docId)
      Unique identifier for the record in the search index (for search results).
      Returns:
      this.

    • guid

      public B guid(String guid)
      Globally-unique identifier for the entity.
      Returns:
      this.

    • displayText

      public B displayText(String displayText)
      Human-readable name of the entity.
      Returns:
      this.

    • entityStatus

      public B entityStatus(String entityStatus)
      Status of the entity (if this is a related entity).
      Returns:
      this.

    • relationshipType

      public B relationshipType(String relationshipType)
      Type of the relationship (if this is a related entity).
      Returns:
      this.

    • relationshipGuid

      public B relationshipGuid(String relationshipGuid)
      Unique identifier of the relationship (when this is a related entity).
      Returns:
      this.

    • relationshipStatus

      public B relationshipStatus(AtlanStatus relationshipStatus)
      Status of the relationship (when this is a related entity).
      Returns:
      this.

    • relationshipAttributes

      public B relationshipAttributes(RelationshipAttributes relationshipAttributes)
      Attributes specific to the relationship.
      Returns:
      this.

    • uniqueAttributes

      public B uniqueAttributes(UniqueAttributes uniqueAttributes)
      Attribute(s) that uniquely identify the entity (when this is a related entity). If the guid is not provided, these must be provided.
      Returns:
      this.

    • label

      public B label(String label)

    • labels

      public B labels(Collection<? extends String> labels)

    • clearLabels

      public B clearLabels()

    • customAttribute

      public B customAttribute(String customAttributeKey, String customAttributeValue)

    • customAttributes

      public B customAttributes(Map<? extends String,? extends String> customAttributes)

    • clearCustomAttributes

      public B clearCustomAttributes()

    • addedRelationshipAttributes

      public B addedRelationshipAttributes(Reference addedRelationshipAttributes)
      Relationships that were added to this asset (part of audit logging ONLY).
      Returns:
      this.

    • removedRelationshipAttributes

      public B removedRelationshipAttributes(Reference removedRelationshipAttributes)
      Relationships that were removed from this asset (part of audit logging ONLY).
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class AtlanObject.AtlanObjectBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class AtlanObject.AtlanObjectBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class AtlanObject.AtlanObjectBuilder<C extends Reference,B extends Reference.ReferenceBuilder<C,B>>