Skip to content

SourceTagAttribute

Detailed information about a source tag's attributes.

Complete reference

This is a complete reference for the SourceTagAttribute struct in Atlan, showing all of its embedded properties. For an introduction, you probably want to start with:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.

Embedded properties

These are the attributes embedded within each instance of the SourceTagAttribute struct in an asset:

tagAttributeKey
Attribute key, for example: 'allowedValues' or 'enabled'.
1
2
builder.tagAttributeKey(...); // (1)
sourceTagAttribute.getTagAttributeKey(); // (2)
  1. Set the tagAttributeKey for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the tagAttributeKey from a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

tagAttributeValue

java linenums="1" title="Attribute value, for example: '["Private", "PII"]' for allowedValues key or 'true' for enabled key." builder.tagAttributeValue(...); // (1) sourceTagAttribute.getTagAttributeValue(); // (2)

  1. Set the tagAttributeValue for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the tagAttributeValue from a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

tagAttributeProperties
Properties of the attribute.
1
2
builder.tagAttributeProperties(...); // (1)
sourceTagAttribute.getTagAttributeProperties(); // (2)
  1. Set the tagAttributeProperties for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the tagAttributeProperties from a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

tagAttributeKey
Attribute key, for example: 'allowedValues' or 'enabled'.
1
2
3
4
5
{
  "attributes": {
    "tagAttributeKey": ... // (1)
  }
}
  1. Set the tagAttributeKey for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets.

tagAttributeValue

json linenums="1" title="Attribute value, for example: '["Private", "PII"]' for allowedValues key or 'true' for enabled key." { "attributes": { "tagAttributeValue": ... // (1) } }

  1. Set the tagAttributeValue for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets.

tagAttributeProperties
Properties of the attribute.
1
2
3
4
5
{
  "attributes": {
    "tagAttributeProperties": ... // (1)
  }
}
  1. Set the tagAttributeProperties for a SourceTagAttribute.

    For more details

    For more information, see the asset CRUD snippets.