Skip to content

SourceTagAttachment

Detailed information about the attachment of a tag to an Atlan asset, synced from source.

Complete reference

This is a complete reference for the SourceTagAttachment 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 SourceTagAttachment struct in an asset:

sourceTagName
Simple name of the source tag.
1
2
builder.sourceTagName(...); // (1)
sourceTagAttachment.getSourceTagName(); // (2)

  1. Set the sourceTagName for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagName from a SourceTagAttachment.

    For more details

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

sourceTagQualifiedName
Unique name of the source tag, in Atlan.
1
2
builder.sourceTagQualifiedName(...); // (1)
sourceTagAttachment.getSourceTagQualifiedName(); // (2)

  1. Set the sourceTagQualifiedName for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagQualifiedName from a SourceTagAttachment.

    For more details

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

sourceTagGuid
Unique identifier (GUID) of the source tag, in Atlan.
1
2
builder.sourceTagGuid(...); // (1)
sourceTagAttachment.getSourceTagGuid(); // (2)

  1. Set the sourceTagGuid for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagGuid from a SourceTagAttachment.

    For more details

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

sourceTagConnectorName
Connector that is the source of the tag.
1
2
builder.sourceTagConnectorName(...); // (1)
sourceTagAttachment.getSourceTagConnectorName(); // (2)

  1. Set the sourceTagConnectorName for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagConnectorName from a SourceTagAttachment.

    For more details

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

sourceTagValue
Value of the tag attachment, from the source.
1
2
builder.sourceTagValue(...); // (1)
sourceTagAttachment.getSourceTagValue(); // (2)

  1. Set the sourceTagValue for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagValue from a SourceTagAttachment.

    For more details

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

isSourceTagSynced
Whether the tag attachment has been synced at the source (true) or not (false).
1
2
builder.isSourceTagSynced(...); // (1)
sourceTagAttachment.getIsSourceTagSynced(); // (2)

  1. Set the isSourceTagSynced for a SourceTagAttachment.

    For more details

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

  2. Retrieve the isSourceTagSynced from a SourceTagAttachment.

    For more details

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

sourceTagSyncTimestamp
Time (epoch) when the tag attachment was synced at the source, in milliseconds.
1
2
builder.sourceTagSyncTimestamp(...); // (1)
sourceTagAttachment.getSourceTagSyncTimestamp(); // (2)

  1. Set the sourceTagSyncTimestamp for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagSyncTimestamp from a SourceTagAttachment.

    For more details

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

sourceTagSyncError
Error message if the tag attachment sync at the source failed.
1
2
builder.sourceTagSyncError(...); // (1)
sourceTagAttachment.getSourceTagSyncError(); // (2)

  1. Set the sourceTagSyncError for a SourceTagAttachment.

    For more details

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

  2. Retrieve the sourceTagSyncError from a SourceTagAttachment.

    For more details

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

sourceTagName
Simple name of the source tag.
1
2
3
4
5
{
  "attributes": {
    "sourceTagName": ... // (1)
  }
}

  1. Set the sourceTagName for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagQualifiedName
Unique name of the source tag, in Atlan.
1
2
3
4
5
{
  "attributes": {
    "sourceTagQualifiedName": ... // (1)
  }
}

  1. Set the sourceTagQualifiedName for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagGuid
Unique identifier (GUID) of the source tag, in Atlan.
1
2
3
4
5
{
  "attributes": {
    "sourceTagGuid": ... // (1)
  }
}

  1. Set the sourceTagGuid for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagConnectorName
Connector that is the source of the tag.
1
2
3
4
5
{
  "attributes": {
    "sourceTagConnectorName": ... // (1)
  }
}

  1. Set the sourceTagConnectorName for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagValue
Value of the tag attachment, from the source.
1
2
3
4
5
{
  "attributes": {
    "sourceTagValue": ... // (1)
  }
}

  1. Set the sourceTagValue for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

isSourceTagSynced
Whether the tag attachment has been synced at the source (true) or not (false).
1
2
3
4
5
{
  "attributes": {
    "isSourceTagSynced": ... // (1)
  }
}

  1. Set the isSourceTagSynced for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagSyncTimestamp
Time (epoch) when the tag attachment was synced at the source, in milliseconds.
1
2
3
4
5
{
  "attributes": {
    "sourceTagSyncTimestamp": ... // (1)
  }
}

  1. Set the sourceTagSyncTimestamp for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.

sourceTagSyncError
Error message if the tag attachment sync at the source failed.
1
2
3
4
5
{
  "attributes": {
    "sourceTagSyncError": ... // (1)
  }
}

  1. Set the sourceTagSyncError for a SourceTagAttachment.

    For more details

    For more information, see the asset CRUD snippets.