com.datadog.api.client.v1.model

Class ServiceSummaryWidgetDefinition

java.lang.Object

com.datadog.api.client.v1.model.ServiceSummaryWidgetDefinition

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

The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DISPLAY_FORMAT
static String	JSON_PROPERTY_ENV
static String	JSON_PROPERTY_SERVICE
static String	JSON_PROPERTY_SHOW_BREAKDOWN
static String	JSON_PROPERTY_SHOW_DISTRIBUTION
static String	JSON_PROPERTY_SHOW_ERRORS
static String	JSON_PROPERTY_SHOW_HITS
static String	JSON_PROPERTY_SHOW_LATENCY
static String	JSON_PROPERTY_SHOW_RESOURCE_LIST
static String	JSON_PROPERTY_SIZE_FORMAT
static String	JSON_PROPERTY_SPAN_NAME
static String	JSON_PROPERTY_TIME
static String	JSON_PROPERTY_TITLE
static String	JSON_PROPERTY_TITLE_ALIGN
static String	JSON_PROPERTY_TITLE_SIZE
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ServiceSummaryWidgetDefinition()
ServiceSummaryWidgetDefinition(String env, String service, String spanName, ServiceSummaryWidgetDefinitionType type)

Method Summary

Modifier and Type	Method and Description
ServiceSummaryWidgetDefinition	displayFormat(WidgetServiceSummaryDisplayFormat displayFormat)
ServiceSummaryWidgetDefinition	env(String env)
boolean	equals(Object o) Return true if this ServiceSummaryWidgetDefinition 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.
WidgetServiceSummaryDisplayFormat	getDisplayFormat() Number of columns to display.
String	getEnv() APM environment.
String	getService() APM service.
Boolean	getShowBreakdown() Whether to show the latency breakdown or not.
Boolean	getShowDistribution() Whether to show the latency distribution or not.
Boolean	getShowErrors() Whether to show the error metrics or not.
Boolean	getShowHits() Whether to show the hits metrics or not.
Boolean	getShowLatency() Whether to show the latency metrics or not.
Boolean	getShowResourceList() Whether to show the resource list or not.
WidgetSizeFormat	getSizeFormat() Size of the widget.
String	getSpanName() APM span name.
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.
ServiceSummaryWidgetDefinitionType	getType() Type of the service summary widget.
int	hashCode()
ServiceSummaryWidgetDefinition	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ServiceSummaryWidgetDefinition	service(String service)
void	setDisplayFormat(WidgetServiceSummaryDisplayFormat displayFormat)
void	setEnv(String env)
void	setService(String service)
void	setShowBreakdown(Boolean showBreakdown)
void	setShowDistribution(Boolean showDistribution)
void	setShowErrors(Boolean showErrors)
void	setShowHits(Boolean showHits)
void	setShowLatency(Boolean showLatency)
void	setShowResourceList(Boolean showResourceList)
void	setSizeFormat(WidgetSizeFormat sizeFormat)
void	setSpanName(String spanName)
void	setTime(WidgetTime time)
void	setTitle(String title)
void	setTitleAlign(WidgetTextAlign titleAlign)
void	setTitleSize(String titleSize)
void	setType(ServiceSummaryWidgetDefinitionType type)
ServiceSummaryWidgetDefinition	showBreakdown(Boolean showBreakdown)
ServiceSummaryWidgetDefinition	showDistribution(Boolean showDistribution)
ServiceSummaryWidgetDefinition	showErrors(Boolean showErrors)
ServiceSummaryWidgetDefinition	showHits(Boolean showHits)
ServiceSummaryWidgetDefinition	showLatency(Boolean showLatency)
ServiceSummaryWidgetDefinition	showResourceList(Boolean showResourceList)
ServiceSummaryWidgetDefinition	sizeFormat(WidgetSizeFormat sizeFormat)
ServiceSummaryWidgetDefinition	spanName(String spanName)
ServiceSummaryWidgetDefinition	time(WidgetTime time)
ServiceSummaryWidgetDefinition	title(String title)
ServiceSummaryWidgetDefinition	titleAlign(WidgetTextAlign titleAlign)
ServiceSummaryWidgetDefinition	titleSize(String titleSize)
String	toString()
ServiceSummaryWidgetDefinition	type(ServiceSummaryWidgetDefinitionType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_DISPLAY_FORMAT

public static final String JSON_PROPERTY_DISPLAY_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_ENV

public static final String JSON_PROPERTY_ENV

See Also:

Constant Field Values

JSON_PROPERTY_SERVICE

public static final String JSON_PROPERTY_SERVICE

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_BREAKDOWN

public static final String JSON_PROPERTY_SHOW_BREAKDOWN

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_DISTRIBUTION

public static final String JSON_PROPERTY_SHOW_DISTRIBUTION

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_ERRORS

public static final String JSON_PROPERTY_SHOW_ERRORS

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_HITS

public static final String JSON_PROPERTY_SHOW_HITS

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_LATENCY

public static final String JSON_PROPERTY_SHOW_LATENCY

See Also:

Constant Field Values

JSON_PROPERTY_SHOW_RESOURCE_LIST

public static final String JSON_PROPERTY_SHOW_RESOURCE_LIST

See Also:

Constant Field Values

JSON_PROPERTY_SIZE_FORMAT

public static final String JSON_PROPERTY_SIZE_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_SPAN_NAME

public static final String JSON_PROPERTY_SPAN_NAME

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 Detail

ServiceSummaryWidgetDefinition

public ServiceSummaryWidgetDefinition()

ServiceSummaryWidgetDefinition

public ServiceSummaryWidgetDefinition(String env,
                                      String service,
                                      String spanName,
                                      ServiceSummaryWidgetDefinitionType type)

Method Detail

displayFormat

public ServiceSummaryWidgetDefinition displayFormat(WidgetServiceSummaryDisplayFormat displayFormat)

getDisplayFormat

@Nullable
public WidgetServiceSummaryDisplayFormat getDisplayFormat()

Number of columns to display.

Returns:

displayFormat

setDisplayFormat

public void setDisplayFormat(WidgetServiceSummaryDisplayFormat displayFormat)

env

public ServiceSummaryWidgetDefinition env(String env)

getEnv

public String getEnv()

APM environment.

Returns:

env

setEnv

public void setEnv(String env)

service

public ServiceSummaryWidgetDefinition service(String service)

getService

public String getService()

APM service.

Returns:

service

setService

public void setService(String service)

showBreakdown

public ServiceSummaryWidgetDefinition showBreakdown(Boolean showBreakdown)

getShowBreakdown

@Nullable
public Boolean getShowBreakdown()

Whether to show the latency breakdown or not.

Returns:

showBreakdown

setShowBreakdown

public void setShowBreakdown(Boolean showBreakdown)

showDistribution

public ServiceSummaryWidgetDefinition showDistribution(Boolean showDistribution)

getShowDistribution

@Nullable
public Boolean getShowDistribution()

Whether to show the latency distribution or not.

Returns:

showDistribution

setShowDistribution

public void setShowDistribution(Boolean showDistribution)

showErrors

public ServiceSummaryWidgetDefinition showErrors(Boolean showErrors)

getShowErrors

@Nullable
public Boolean getShowErrors()

Whether to show the error metrics or not.

Returns:

showErrors

setShowErrors

public void setShowErrors(Boolean showErrors)

showHits

public ServiceSummaryWidgetDefinition showHits(Boolean showHits)

getShowHits

@Nullable
public Boolean getShowHits()

Whether to show the hits metrics or not.

Returns:

showHits

setShowHits

public void setShowHits(Boolean showHits)

showLatency

public ServiceSummaryWidgetDefinition showLatency(Boolean showLatency)

getShowLatency

@Nullable
public Boolean getShowLatency()

Whether to show the latency metrics or not.

Returns:

showLatency

setShowLatency

public void setShowLatency(Boolean showLatency)

showResourceList

public ServiceSummaryWidgetDefinition showResourceList(Boolean showResourceList)

getShowResourceList

@Nullable
public Boolean getShowResourceList()

Whether to show the resource list or not.

Returns:

showResourceList

setShowResourceList

public void setShowResourceList(Boolean showResourceList)

sizeFormat

public ServiceSummaryWidgetDefinition sizeFormat(WidgetSizeFormat sizeFormat)

getSizeFormat

@Nullable
public WidgetSizeFormat getSizeFormat()

Size of the widget.

Returns:

sizeFormat

setSizeFormat

public void setSizeFormat(WidgetSizeFormat sizeFormat)

spanName

public ServiceSummaryWidgetDefinition spanName(String spanName)

getSpanName

public String getSpanName()

APM span name.

Returns:

spanName

setSpanName

public void setSpanName(String spanName)

time

public ServiceSummaryWidgetDefinition time(WidgetTime time)

getTime

@Nullable
public WidgetTime getTime()

Time setting for the widget.

Returns:

time

setTime

public void setTime(WidgetTime time)

title

public ServiceSummaryWidgetDefinition title(String title)

getTitle

@Nullable
public String getTitle()

Title of the widget.

Returns:

title

setTitle

public void setTitle(String title)

titleAlign

public ServiceSummaryWidgetDefinition 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 ServiceSummaryWidgetDefinition titleSize(String titleSize)

getTitleSize

@Nullable
public String getTitleSize()

Size of the title.

Returns:

titleSize

setTitleSize

public void setTitleSize(String titleSize)

type

public ServiceSummaryWidgetDefinition type(ServiceSummaryWidgetDefinitionType type)

getType

public ServiceSummaryWidgetDefinitionType getType()

Type of the service summary widget.

Returns:

type

setType

public void setType(ServiceSummaryWidgetDefinitionType type)

putAdditionalProperty

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

ServiceSummaryWidgetDefinition

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