Skip to content

StarredDetails

Detailed information about the users who have starred an asset.

Complete reference

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

assetStarredBy
Username of the user who starred the asset.
1
2
builder.assetStarredBy(...); // (1)
starredDetails.getAssetStarredBy(); // (2)
  1. Set the assetStarredBy for a StarredDetails.

    For more details

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

  2. Retrieve the assetStarredBy from a StarredDetails.

    For more details

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

assetStarredAt
Time at which the user starred the asset.
1
2
builder.assetStarredAt(...); // (1)
starredDetails.getAssetStarredAt(); // (2)
  1. Set the assetStarredAt for a StarredDetails.

    For more details

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

  2. Retrieve the assetStarredAt from a StarredDetails.

    For more details

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

assetStarredBy
Username of the user who starred the asset.
1
2
3
4
5
{
  "attributes": {
    "assetStarredBy": ... // (1)
  }
}
  1. Set the assetStarredBy for a StarredDetails.

    For more details

    For more information, see the asset CRUD snippets.

assetStarredAt
Time at which the user starred the asset.
1
2
3
4
5
{
  "attributes": {
    "assetStarredAt": ... // (1)
  }
}
  1. Set the assetStarredAt for a StarredDetails.

    For more details

    For more information, see the asset CRUD snippets.