Package com.atlan.model.structs

Class BadgeCondition

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.structs.AtlanStruct

com.atlan.model.structs.BadgeCondition

All Implemented Interfaces:

Serializable

@Generated("com.atlan.generators.ModelGeneratorV2")
public class BadgeCondition
extends AtlanStruct

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BadgeCondition.BadgeConditionBuilder<C extends BadgeCondition,B extends BadgeCondition.BadgeConditionBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.structs.AtlanStruct

AtlanStruct.AtlanStructBuilder<C extends AtlanStruct,B extends AtlanStruct.AtlanStructBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BadgeCondition(BadgeCondition.BadgeConditionBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static BadgeCondition.BadgeConditionBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getBadgeConditionColorhex()	Color (in RGB hex, with a # prefix) to use when custom metadata attribute's content matches the value through the comparison operator.
BadgeComparisonOperator	getBadgeConditionOperator()	Comparison operator to use when comparing a custom metadata attribute's value.
String	getBadgeConditionValue()	Value against which to compare the custom metadata attribute's content.
String	getTypeName()	Fixed typeName for BadgeCondition.
int	hashCode()
static BadgeCondition	of(BadgeComparisonOperator operator, boolean value, BadgeConditionColor color)	Build a new condition for a badge on a boolean-based custom metadata property.
static BadgeCondition	of(BadgeComparisonOperator operator, boolean value, String color)	Build a new condition for a badge on a boolean-based custom metadata property.
static BadgeCondition	of(BadgeComparisonOperator operator, Number value, BadgeConditionColor color)	Build a new condition for a badge on a number-based custom metadata property.
static BadgeCondition	of(BadgeComparisonOperator operator, Number value, String color)	Build a new condition for a badge on a number-based custom metadata property.
static BadgeCondition	of(BadgeComparisonOperator operator, String value, BadgeConditionColor color)	Build a new condition for a badge on a string-based custom metadata property (including options (enumerations)).
static BadgeCondition	of(BadgeComparisonOperator operator, String value, String color)	Build a new condition for a badge on a string-based custom metadata property (including options (enumerations)).
BadgeCondition.BadgeConditionBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

Constructor Details

BadgeCondition

protected BadgeCondition(BadgeCondition.BadgeConditionBuilder<?,?> b)

Method Details

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 String value,
 BadgeConditionColor color)

Build a new condition for a badge on a string-based custom metadata property (including options (enumerations)). Note that this will wrap the value itself in double-quotes, as this is needed to properly set the value for the badge. So for example if you set the value as abc123 and you retrieve this value back from the badge condition, you will receive back "abc123".

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (from the standard colors available in the UI)

Returns:

the badge condition with these criteria

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 String value,
 String color)

Build a new condition for a badge on a string-based custom metadata property (including options (enumerations)). Note that this will wrap the value itself in double-quotes, as this is needed to properly set the value for the badge. So for example if you set the value as abc123 and you retrieve this value back from the badge condition, you will receive back "abc123".

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (any valid RGB hex string of the form #ffffff)

Returns:

the badge condition with these criteria

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 Number value,
 BadgeConditionColor color)

Build a new condition for a badge on a number-based custom metadata property.

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (from the standard colors available in the UI)

Returns:

the badge condition with these criteria

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 Number value,
 String color)

Build a new condition for a badge on a number-based custom metadata property.

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (any valid RGB hex string of the form #ffffff)

Returns:

the badge condition with these criteria

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 boolean value,
 BadgeConditionColor color)

Build a new condition for a badge on a boolean-based custom metadata property.

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (from the standard colors available in the UI)

Returns:

the badge condition with these criteria

of

public static BadgeCondition of(BadgeComparisonOperator operator,
 boolean value,
 String color)

Build a new condition for a badge on a boolean-based custom metadata property.

Parameters:

operator - the comparison operator for the condition

value - the value to match against the comparison operator

color - the color to use when a value matches (any valid RGB hex string of the form #ffffff)

Returns:

the badge condition with these criteria

builder

public static BadgeCondition.BadgeConditionBuilder<?,?> builder()

toBuilder

public BadgeCondition.BadgeConditionBuilder<?,?> toBuilder()

getBadgeConditionOperator

public BadgeComparisonOperator getBadgeConditionOperator()

Comparison operator to use when comparing a custom metadata attribute's value.

getBadgeConditionValue

public String getBadgeConditionValue()

Value against which to compare the custom metadata attribute's content.

getBadgeConditionColorhex

public String getBadgeConditionColorhex()

Color (in RGB hex, with a # prefix) to use when custom metadata attribute's content matches the value through the comparison operator.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanStruct

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanStruct

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanStruct

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject

getTypeName

public String getTypeName()

Fixed typeName for BadgeCondition.

Overrides:

getTypeName in class AtlanStruct