com.datadog.api.client.v1.model

Class ImageWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.ImageWidgetDefinition

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

The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_HAS_BACKGROUND
static String	JSON_PROPERTY_HAS_BORDER
static String	JSON_PROPERTY_HORIZONTAL_ALIGN
static String	JSON_PROPERTY_MARGIN
static String	JSON_PROPERTY_SIZING
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_URL
static String	JSON_PROPERTY_URL_DARK_THEME
static String	JSON_PROPERTY_VERTICAL_ALIGN
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ImageWidgetDefinition()
ImageWidgetDefinition(ImageWidgetDefinitionType type, String url)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Return true if this ImageWidgetDefinition 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.
Boolean	getHasBackground() Whether to display a background or not.
Boolean	getHasBorder() Whether to display a border or not.
WidgetHorizontalAlign	getHorizontalAlign() Horizontal alignment.
WidgetMargin	getMargin() Size of the margins around the image.
WidgetImageSizing	getSizing() How to size the image on the widget.
ImageWidgetDefinitionType	getType() Type of the image widget.
String	getUrl() URL of the image.
String	getUrlDarkTheme() URL of the image in dark mode.
WidgetVerticalAlign	getVerticalAlign() Vertical alignment.
ImageWidgetDefinition	hasBackground(Boolean hasBackground)
ImageWidgetDefinition	hasBorder(Boolean hasBorder)
int	hashCode()
ImageWidgetDefinition	horizontalAlign(WidgetHorizontalAlign horizontalAlign)
ImageWidgetDefinition	margin(WidgetMargin margin)
ImageWidgetDefinition	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setHasBackground(Boolean hasBackground)
void	setHasBorder(Boolean hasBorder)
void	setHorizontalAlign(WidgetHorizontalAlign horizontalAlign)
void	setMargin(WidgetMargin margin)
void	setSizing(WidgetImageSizing sizing)
void	setType(ImageWidgetDefinitionType type)
void	setUrl(String url)
void	setUrlDarkTheme(String urlDarkTheme)
void	setVerticalAlign(WidgetVerticalAlign verticalAlign)
ImageWidgetDefinition	sizing(WidgetImageSizing sizing)
String	toString()
ImageWidgetDefinition	type(ImageWidgetDefinitionType type)
ImageWidgetDefinition	url(String url)
ImageWidgetDefinition	urlDarkTheme(String urlDarkTheme)
ImageWidgetDefinition	verticalAlign(WidgetVerticalAlign verticalAlign)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_HAS_BACKGROUND

public static final String JSON_PROPERTY_HAS_BACKGROUND

See Also:

Constant Field Values

JSON_PROPERTY_HAS_BORDER

public static final String JSON_PROPERTY_HAS_BORDER

See Also:

Constant Field Values

JSON_PROPERTY_HORIZONTAL_ALIGN

public static final String JSON_PROPERTY_HORIZONTAL_ALIGN

See Also:

Constant Field Values

JSON_PROPERTY_MARGIN

public static final String JSON_PROPERTY_MARGIN

See Also:

Constant Field Values

JSON_PROPERTY_SIZING

public static final String JSON_PROPERTY_SIZING

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

Constant Field Values

JSON_PROPERTY_URL_DARK_THEME

public static final String JSON_PROPERTY_URL_DARK_THEME

See Also:

Constant Field Values

JSON_PROPERTY_VERTICAL_ALIGN

public static final String JSON_PROPERTY_VERTICAL_ALIGN

See Also:

Constant Field Values

Constructor Detail

ImageWidgetDefinition

public ImageWidgetDefinition()

ImageWidgetDefinition

public ImageWidgetDefinition(ImageWidgetDefinitionType type,
                             String url)

Method Detail

hasBackground

public ImageWidgetDefinition hasBackground(Boolean hasBackground)

getHasBackground

@Nullable
public Boolean getHasBackground()

Whether to display a background or not.

Returns:

hasBackground

setHasBackground

public void setHasBackground(Boolean hasBackground)

hasBorder

public ImageWidgetDefinition hasBorder(Boolean hasBorder)

getHasBorder

@Nullable
public Boolean getHasBorder()

Whether to display a border or not.

Returns:

hasBorder

setHasBorder

public void setHasBorder(Boolean hasBorder)

horizontalAlign

public ImageWidgetDefinition horizontalAlign(WidgetHorizontalAlign horizontalAlign)

getHorizontalAlign

@Nullable
public WidgetHorizontalAlign getHorizontalAlign()

Horizontal alignment.

Returns:

horizontalAlign

setHorizontalAlign

public void setHorizontalAlign(WidgetHorizontalAlign horizontalAlign)

margin

public ImageWidgetDefinition margin(WidgetMargin margin)

getMargin

@Nullable
public WidgetMargin getMargin()

Size of the margins around the image. Note: small and large values are deprecated.

Returns:

margin

setMargin

public void setMargin(WidgetMargin margin)

sizing

public ImageWidgetDefinition sizing(WidgetImageSizing sizing)

getSizing

@Nullable
public WidgetImageSizing getSizing()

How to size the image on the widget. The values are based on the image object-fit CSS properties. Note: zoom, fit and center values are deprecated.

Returns:

sizing

setSizing

public void setSizing(WidgetImageSizing sizing)

type

public ImageWidgetDefinition type(ImageWidgetDefinitionType type)

getType

public ImageWidgetDefinitionType getType()

Type of the image widget.

Returns:

type

setType

public void setType(ImageWidgetDefinitionType type)

url

public ImageWidgetDefinition url(String url)

getUrl

public String getUrl()

URL of the image.

Returns:

url

setUrl

public void setUrl(String url)

urlDarkTheme

public ImageWidgetDefinition urlDarkTheme(String urlDarkTheme)

getUrlDarkTheme

@Nullable
public String getUrlDarkTheme()

URL of the image in dark mode.

Returns:

urlDarkTheme

setUrlDarkTheme

public void setUrlDarkTheme(String urlDarkTheme)

verticalAlign

public ImageWidgetDefinition verticalAlign(WidgetVerticalAlign verticalAlign)

getVerticalAlign

@Nullable
public WidgetVerticalAlign getVerticalAlign()

Vertical alignment.

Returns:

verticalAlign

setVerticalAlign

public void setVerticalAlign(WidgetVerticalAlign verticalAlign)

putAdditionalProperty

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

ImageWidgetDefinition

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