Package com.datadog.api.client.v1.model

Class CheckStatusWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.CheckStatusWidgetDefinition

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

Check status shows the current status or number of results for any check performed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CHECK
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_GROUP
static final String	JSON_PROPERTY_GROUP_BY
static final String	JSON_PROPERTY_GROUPING
static final String	JSON_PROPERTY_TAGS
static final String	JSON_PROPERTY_TIME
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_TITLE_ALIGN
static final String	JSON_PROPERTY_TITLE_SIZE
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
CheckStatusWidgetDefinition()
CheckStatusWidgetDefinition(String check, WidgetGrouping grouping, CheckStatusWidgetDefinitionType type)

Method Summary

Modifier and Type	Method	Description
CheckStatusWidgetDefinition	addGroupByItem(String groupByItem)
CheckStatusWidgetDefinition	addTagsItem(String tagsItem)
CheckStatusWidgetDefinition	check(String check)
CheckStatusWidgetDefinition	description(String description)
boolean	equals(Object o)	Return true if this CheckStatusWidgetDefinition 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.
String	getCheck()	Name of the check to use in the widget.
String	getDescription()	The description of the widget.
String	getGroup()	Group reporting a single check.
List<String>	getGroupBy()	List of tag prefixes to group by in the case of a cluster check.
WidgetGrouping	getGrouping()	The kind of grouping to use.
List<String>	getTags()	List of tags used to filter the groups reporting a cluster check.
WidgetTime	getTime()	Time setting for the widget.
String	getTitle()	Title of the widget.
WidgetTextAlign	getTitleAlign()	How to align the text on the widget.
String	getTitleSize()	Size of the title.
CheckStatusWidgetDefinitionType	getType()	Type of the check status widget.
CheckStatusWidgetDefinition	group(String group)
CheckStatusWidgetDefinition	groupBy(List<String> groupBy)
CheckStatusWidgetDefinition	grouping(WidgetGrouping grouping)
int	hashCode()
CheckStatusWidgetDefinition	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setCheck(String check)
void	setDescription(String description)
void	setGroup(String group)
void	setGroupBy(List<String> groupBy)
void	setGrouping(WidgetGrouping grouping)
void	setTags(List<String> tags)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(CheckStatusWidgetDefinitionType type)
CheckStatusWidgetDefinition	tags(List<String> tags)
CheckStatusWidgetDefinition	time(WidgetTime time)
CheckStatusWidgetDefinition	title(String title)
CheckStatusWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
CheckStatusWidgetDefinition	titleSize(String titleSize)
String	toString()
CheckStatusWidgetDefinition	type(CheckStatusWidgetDefinitionType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CHECK

public static final String JSON_PROPERTY_CHECK

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP

public static final String JSON_PROPERTY_GROUP

See Also:

• Constant Field Values

JSON_PROPERTY_GROUP_BY

public static final String JSON_PROPERTY_GROUP_BY

See Also:

• Constant Field Values

JSON_PROPERTY_GROUPING

public static final String JSON_PROPERTY_GROUPING

See Also:

• Constant Field Values

JSON_PROPERTY_TAGS

public static final String JSON_PROPERTY_TAGS

See Also:

• Constant Field Values

JSON_PROPERTY_TIME

public static final String JSON_PROPERTY_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_ALIGN

public static final String JSON_PROPERTY_TITLE_ALIGN

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE_SIZE

public static final String JSON_PROPERTY_TITLE_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

CheckStatusWidgetDefinition

public CheckStatusWidgetDefinition()

CheckStatusWidgetDefinition

public CheckStatusWidgetDefinition(String check,
 WidgetGrouping grouping,
 CheckStatusWidgetDefinitionType type)

Method Details

check

public CheckStatusWidgetDefinition check(String check)

getCheck

public String getCheck()

Name of the check to use in the widget.

Returns:

check

setCheck

public void setCheck(String check)

description

public CheckStatusWidgetDefinition description(String description)

getDescription

@Nullable
public String getDescription()

The description of the widget.

Returns:

description

setDescription

public void setDescription(String description)

group

public CheckStatusWidgetDefinition group(String group)

getGroup

@Nullable
public String getGroup()

Group reporting a single check.

Returns:

group

setGroup

public void setGroup(String group)

groupBy

public CheckStatusWidgetDefinition groupBy(List<String> groupBy)

addGroupByItem

public CheckStatusWidgetDefinition addGroupByItem(String groupByItem)

getGroupBy

@Nullable
public List<String> getGroupBy()

List of tag prefixes to group by in the case of a cluster check.

Returns:

groupBy

setGroupBy

public void setGroupBy(List<String> groupBy)

grouping

public CheckStatusWidgetDefinition grouping(WidgetGrouping grouping)

getGrouping

public WidgetGrouping getGrouping()

The kind of grouping to use.

Returns:

grouping

setGrouping

public void setGrouping(WidgetGrouping grouping)

tags

public CheckStatusWidgetDefinition tags(List<String> tags)

addTagsItem

public CheckStatusWidgetDefinition addTagsItem(String tagsItem)

getTags

@Nullable
public List<String> getTags()

List of tags used to filter the groups reporting a cluster check.

Returns:

tags

setTags

public void setTags(List<String> tags)

time

public CheckStatusWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public CheckStatusWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public CheckStatusWidgetDefinition titleAlign(WidgetTextAlign titleAlign)

getTitleAlign

@Nullable
public WidgetTextAlign getTitleAlign()

How to align the text on the widget.

Returns:

titleAlign

setTitleAlign

public void setTitleAlign(WidgetTextAlign titleAlign)

titleSize

public CheckStatusWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public CheckStatusWidgetDefinition type(CheckStatusWidgetDefinitionType type)

getType

public CheckStatusWidgetDefinitionType getType()

Type of the check status widget.

Returns:

type

setType

public void setType(CheckStatusWidgetDefinitionType type)

putAdditionalProperty

public CheckStatusWidgetDefinition 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:

CheckStatusWidgetDefinition

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 CheckStatusWidgetDefinition 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