com.datadog.api.client.v1.model

Class GroupWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.GroupWidgetDefinition

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

The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BACKGROUND_COLOR
static String	JSON_PROPERTY_BANNER_IMG
static String	JSON_PROPERTY_LAYOUT_TYPE
static String	JSON_PROPERTY_SHOW_TITLE
static String	JSON_PROPERTY_TITLE
static String	JSON_PROPERTY_TITLE_ALIGN
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_WIDGETS
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
GroupWidgetDefinition()
GroupWidgetDefinition(WidgetLayoutType layoutType, GroupWidgetDefinitionType type, List<Widget> widgets)

Method Summary

Modifier and Type	Method and Description
GroupWidgetDefinition	addWidgetsItem(Widget widgetsItem)
GroupWidgetDefinition	backgroundColor(String backgroundColor)
GroupWidgetDefinition	bannerImg(String bannerImg)
boolean	equals(Object o) Return true if this GroupWidgetDefinition 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	getBackgroundColor() Background color of the group title.
String	getBannerImg() URL of image to display as a banner for the group.
WidgetLayoutType	getLayoutType() Layout type of the group.
Boolean	getShowTitle() Whether to show the title or not.
String	getTitle() Title of the widget.
WidgetTextAlign	getTitleAlign() How to align the text on the widget.
GroupWidgetDefinitionType	getType() Type of the group widget.
List<Widget>	getWidgets() List of widget groups.
int	hashCode()
GroupWidgetDefinition	layoutType(WidgetLayoutType layoutType)
GroupWidgetDefinition	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setBackgroundColor(String backgroundColor)
void	setBannerImg(String bannerImg)
void	setLayoutType(WidgetLayoutType layoutType)
void	setShowTitle(Boolean showTitle)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setType(GroupWidgetDefinitionType type)
void	setWidgets(List<Widget> widgets)
GroupWidgetDefinition	showTitle(Boolean showTitle)
GroupWidgetDefinition	title(String title)
GroupWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
String	toString()
GroupWidgetDefinition	type(GroupWidgetDefinitionType type)
GroupWidgetDefinition	widgets(List<Widget> widgets)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_BACKGROUND_COLOR

public static final String JSON_PROPERTY_BACKGROUND_COLOR

See Also:

Constant Field Values

JSON_PROPERTY_BANNER_IMG

public static final String JSON_PROPERTY_BANNER_IMG

See Also:

Constant Field Values

JSON_PROPERTY_LAYOUT_TYPE

public static final String JSON_PROPERTY_LAYOUT_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_TITLE

public static final String JSON_PROPERTY_SHOW_TITLE

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_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_WIDGETS

public static final String JSON_PROPERTY_WIDGETS

See Also:

Constant Field Values

Constructor Detail

GroupWidgetDefinition

public GroupWidgetDefinition()

GroupWidgetDefinition

public GroupWidgetDefinition(WidgetLayoutType layoutType,
                             GroupWidgetDefinitionType type,
                             List<Widget> widgets)

Method Detail

backgroundColor

public GroupWidgetDefinition backgroundColor(String backgroundColor)

getBackgroundColor

@Nullable
public String getBackgroundColor()

Background color of the group title.

Returns:

backgroundColor

setBackgroundColor

public void setBackgroundColor(String backgroundColor)

bannerImg

public GroupWidgetDefinition bannerImg(String bannerImg)

getBannerImg

@Nullable
public String getBannerImg()

URL of image to display as a banner for the group.

Returns:

bannerImg

setBannerImg

public void setBannerImg(String bannerImg)

layoutType

public GroupWidgetDefinition layoutType(WidgetLayoutType layoutType)

getLayoutType

public WidgetLayoutType getLayoutType()

Layout type of the group.

Returns:

layoutType

setLayoutType

public void setLayoutType(WidgetLayoutType layoutType)

showTitle

public GroupWidgetDefinition showTitle(Boolean showTitle)

getShowTitle

@Nullable
public Boolean getShowTitle()

Whether to show the title or not.

Returns:

showTitle

setShowTitle

public void setShowTitle(Boolean showTitle)

title

public GroupWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public GroupWidgetDefinition titleAlign(WidgetTextAlign titleAlign)

getTitleAlign

@Nullable
public WidgetTextAlign getTitleAlign()

How to align the text on the widget.

Returns:

titleAlign

setTitleAlign

public void setTitleAlign(WidgetTextAlign titleAlign)

type

public GroupWidgetDefinition type(GroupWidgetDefinitionType type)

getType

public GroupWidgetDefinitionType getType()

Type of the group widget.

Returns:

type

setType

public void setType(GroupWidgetDefinitionType type)

widgets

public GroupWidgetDefinition widgets(List<Widget> widgets)

addWidgetsItem

public GroupWidgetDefinition addWidgetsItem(Widget widgetsItem)

getWidgets

public List<Widget> getWidgets()

List of widget groups.

Returns:

widgets

setWidgets

public void setWidgets(List<Widget> widgets)

putAdditionalProperty

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

GroupWidgetDefinition

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