com.datadog.api.client.v1.model

Class WidgetConditionalFormat

java.lang.Object

com.datadog.api.client.v1.model.WidgetConditionalFormat

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class WidgetConditionalFormat
extends Object

Define a conditional format for the widget.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_COMPARATOR
static String	JSON_PROPERTY_CUSTOM_BG_COLOR
static String	JSON_PROPERTY_CUSTOM_FG_COLOR
static String	JSON_PROPERTY_HIDE_VALUE
static String	JSON_PROPERTY_IMAGE_URL
static String	JSON_PROPERTY_METRIC
static String	JSON_PROPERTY_PALETTE
static String	JSON_PROPERTY_TIMEFRAME
static String	JSON_PROPERTY_VALUE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
WidgetConditionalFormat()
WidgetConditionalFormat(WidgetComparator comparator, WidgetPalette palette, Double value)

Method Summary

Modifier and Type	Method and Description
WidgetConditionalFormat	comparator(WidgetComparator comparator)
WidgetConditionalFormat	customBgColor(String customBgColor)
WidgetConditionalFormat	customFgColor(String customFgColor)
boolean	equals(Object o) Return true if this WidgetConditionalFormat object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
WidgetComparator	getComparator() Comparator to apply.
String	getCustomBgColor() Color palette to apply to the background, same values available as palette.
String	getCustomFgColor() Color palette to apply to the foreground, same values available as palette.
Boolean	getHideValue() True hides values.
String	getImageUrl() Displays an image as the background.
String	getMetric() Metric from the request to correlate this conditional format with.
WidgetPalette	getPalette() Color palette to apply.
String	getTimeframe() Defines the displayed timeframe.
Double	getValue() Value for the comparator.
int	hashCode()
WidgetConditionalFormat	hideValue(Boolean hideValue)
WidgetConditionalFormat	imageUrl(String imageUrl)
WidgetConditionalFormat	metric(String metric)
WidgetConditionalFormat	palette(WidgetPalette palette)
WidgetConditionalFormat	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setComparator(WidgetComparator comparator)
void	setCustomBgColor(String customBgColor)
void	setCustomFgColor(String customFgColor)
void	setHideValue(Boolean hideValue)
void	setImageUrl(String imageUrl)
void	setMetric(String metric)
void	setPalette(WidgetPalette palette)
void	setTimeframe(String timeframe)
void	setValue(Double value)
WidgetConditionalFormat	timeframe(String timeframe)
String	toString()
WidgetConditionalFormat	value(Double value)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_COMPARATOR

public static final String JSON_PROPERTY_COMPARATOR

See Also:

Constant Field Values

JSON_PROPERTY_CUSTOM_BG_COLOR

public static final String JSON_PROPERTY_CUSTOM_BG_COLOR

See Also:

Constant Field Values

JSON_PROPERTY_CUSTOM_FG_COLOR

public static final String JSON_PROPERTY_CUSTOM_FG_COLOR

See Also:

Constant Field Values

JSON_PROPERTY_HIDE_VALUE

public static final String JSON_PROPERTY_HIDE_VALUE

See Also:

Constant Field Values

JSON_PROPERTY_IMAGE_URL

public static final String JSON_PROPERTY_IMAGE_URL

See Also:

Constant Field Values

JSON_PROPERTY_METRIC

public static final String JSON_PROPERTY_METRIC

See Also:

Constant Field Values

JSON_PROPERTY_PALETTE

public static final String JSON_PROPERTY_PALETTE

See Also:

Constant Field Values

JSON_PROPERTY_TIMEFRAME

public static final String JSON_PROPERTY_TIMEFRAME

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

WidgetConditionalFormat

public WidgetConditionalFormat()

WidgetConditionalFormat

public WidgetConditionalFormat(WidgetComparator comparator,
                               WidgetPalette palette,
                               Double value)

Method Detail

comparator

public WidgetConditionalFormat comparator(WidgetComparator comparator)

getComparator

public WidgetComparator getComparator()

Comparator to apply.

Returns:

comparator

setComparator

public void setComparator(WidgetComparator comparator)

customBgColor

public WidgetConditionalFormat customBgColor(String customBgColor)

getCustomBgColor

@Nullable
public String getCustomBgColor()

Color palette to apply to the background, same values available as palette.

Returns:

customBgColor

setCustomBgColor

public void setCustomBgColor(String customBgColor)

customFgColor

public WidgetConditionalFormat customFgColor(String customFgColor)

getCustomFgColor

@Nullable
public String getCustomFgColor()

Color palette to apply to the foreground, same values available as palette.

Returns:

customFgColor

setCustomFgColor

public void setCustomFgColor(String customFgColor)

hideValue

public WidgetConditionalFormat hideValue(Boolean hideValue)

getHideValue

@Nullable
public Boolean getHideValue()

True hides values.

Returns:

hideValue

setHideValue

public void setHideValue(Boolean hideValue)

imageUrl

public WidgetConditionalFormat imageUrl(String imageUrl)

getImageUrl

@Nullable
public String getImageUrl()

Displays an image as the background.

Returns:

imageUrl

setImageUrl

public void setImageUrl(String imageUrl)

metric

public WidgetConditionalFormat metric(String metric)

getMetric

@Nullable
public String getMetric()

Metric from the request to correlate this conditional format with.

Returns:

metric

setMetric

public void setMetric(String metric)

palette

public WidgetConditionalFormat palette(WidgetPalette palette)

getPalette

public WidgetPalette getPalette()

Color palette to apply.

Returns:

palette

setPalette

public void setPalette(WidgetPalette palette)

timeframe

public WidgetConditionalFormat timeframe(String timeframe)

getTimeframe

@Nullable
public String getTimeframe()

Defines the displayed timeframe.

Returns:

timeframe

setTimeframe

public void setTimeframe(String timeframe)

value

public WidgetConditionalFormat value(Double value)

getValue

public Double getValue()

Value for the comparator.

Returns:

value

setValue

public void setValue(Double value)

putAdditionalProperty

public WidgetConditionalFormat putAdditionalProperty(String key,
                                                     Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

WidgetConditionalFormat

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this WidgetConditionalFormat object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object