Skip to content

BadgeCondition

Detailed information about a condition used in coloring a custom metadata badge in Atlan.

Complete reference

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

badgeConditionOperator
Comparison operator to use when comparing a custom metadata attribute's value.
1
2
builder.badgeConditionOperator(...); // (1)
badgeCondition.getBadgeConditionOperator(); // (2)

  1. Set the badgeConditionOperator for a BadgeCondition.

    For more details

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

  2. Retrieve the badgeConditionOperator from a BadgeCondition.

    For more details

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

badgeConditionValue
Value against which to compare the custom metadata attribute's content.
1
2
builder.badgeConditionValue(...); // (1)
badgeCondition.getBadgeConditionValue(); // (2)

  1. Set the badgeConditionValue for a BadgeCondition.

    For more details

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

  2. Retrieve the badgeConditionValue from a BadgeCondition.

    For more details

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

badgeConditionColorhex
Color (in RGB hex, with a # prefix) to use when custom metadata attribute's content matches the value through the comparison operator.
1
2
builder.badgeConditionColorhex(...); // (1)
badgeCondition.getBadgeConditionColorhex(); // (2)

  1. Set the badgeConditionColorhex for a BadgeCondition.

    For more details

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

  2. Retrieve the badgeConditionColorhex from a BadgeCondition.

    For more details

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

badgeConditionOperator
Comparison operator to use when comparing a custom metadata attribute's value.
1
2
3
4
5
{
  "attributes": {
    "badgeConditionOperator": ... // (1)
  }
}

  1. Set the badgeConditionOperator for a BadgeCondition.

    For more details

    For more information, see the asset CRUD snippets.

badgeConditionValue
Value against which to compare the custom metadata attribute's content.
1
2
3
4
5
{
  "attributes": {
    "badgeConditionValue": ... // (1)
  }
}

  1. Set the badgeConditionValue for a BadgeCondition.

    For more details

    For more information, see the asset CRUD snippets.

badgeConditionColorhex
Color (in RGB hex, with a # prefix) to use when custom metadata attribute's content matches the value through the comparison operator.
1
2
3
4
5
{
  "attributes": {
    "badgeConditionColorhex": ... // (1)
  }
}

  1. Set the badgeConditionColorhex for a BadgeCondition.

    For more details

    For more information, see the asset CRUD snippets.