com.datadog.api.client.v2.model

Class DashboardUsageAttributes

java.lang.Object

com.datadog.api.client.v2.model.DashboardUsageAttributes

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

Usage statistics for a dashboard. The viewer field and all view-count fields ( total_views, viewed_at, total_views_by_type) are populated only when Real User Monitoring (RUM) is active for the org.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AUTHOR
static String	JSON_PROPERTY_CREATED_AT
static String	JSON_PROPERTY_DASHBOARD_QUALITY_SCORE
static String	JSON_PROPERTY_EDITED_AT
static String	JSON_PROPERTY_ORG_ID
static String	JSON_PROPERTY_TEAMS
static String	JSON_PROPERTY_TITLE
static String	JSON_PROPERTY_TOTAL_VIEWS
static String	JSON_PROPERTY_TOTAL_VIEWS_BY_TYPE
static String	JSON_PROPERTY_VIEWED_AT
static String	JSON_PROPERTY_VIEWER
static String	JSON_PROPERTY_WIDGET_COUNT
static String	JSON_PROPERTY_WIDGET_COUNT_BY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
DashboardUsageAttributes()
DashboardUsageAttributes(Long orgId)

Method Summary

Modifier and Type	Method and Description
DashboardUsageAttributes	addTeamsItem(String teamsItem)
DashboardUsageAttributes	author(DashboardUsageUser author)
DashboardUsageAttributes	createdAt(OffsetDateTime createdAt)
DashboardUsageAttributes	dashboardQualityScore(Double dashboardQualityScore)
DashboardUsageAttributes	editedAt(OffsetDateTime editedAt)
boolean	equals(Object o) Return true if this DashboardUsageAttributes 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.
org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser>	getAuthor_JsonNullable()
DashboardUsageUser	getAuthor() A user referenced from a dashboard usage record (author or viewer).
org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime>	getCreatedAt_JsonNullable()
OffsetDateTime	getCreatedAt() When the dashboard was created.
org.openapitools.jackson.nullable.JsonNullable<Double>	getDashboardQualityScore_JsonNullable()
Double	getDashboardQualityScore() The dashboard quality score, or null when no score is available.
org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime>	getEditedAt_JsonNullable()
OffsetDateTime	getEditedAt() When the dashboard was most recently edited.
Long	getOrgId() The Datadog organization that owns the dashboard.
org.openapitools.jackson.nullable.JsonNullable<List<String>>	getTeams_JsonNullable()
List<String>	getTeams() Teams the dashboard is tagged with.
String	getTitle() The dashboard title.
Long	getTotalViews() Total view count for the dashboard.
org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>>	getTotalViewsByType_JsonNullable()
Map<String,Long>	getTotalViewsByType() View counts keyed by view type (in_app, embed, public, shared, api, unknown).
org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime>	getViewedAt_JsonNullable()
OffsetDateTime	getViewedAt() When the dashboard was most recently viewed.
org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser>	getViewer_JsonNullable()
DashboardUsageUser	getViewer() A user referenced from a dashboard usage record (author or viewer).
org.openapitools.jackson.nullable.JsonNullable<Long>	getWidgetCount_JsonNullable()
Long	getWidgetCount() The total number of widgets on the dashboard.
org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>>	getWidgetCountByType_JsonNullable()
Map<String,Long>	getWidgetCountByType() Widget counts keyed by widget type.
int	hashCode()
DashboardUsageAttributes	orgId(Long orgId)
DashboardUsageAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
DashboardUsageAttributes	putTotalViewsByTypeItem(String key, Long totalViewsByTypeItem)
DashboardUsageAttributes	putWidgetCountByTypeItem(String key, Long widgetCountByTypeItem)
void	setAuthor_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> author)
void	setAuthor(DashboardUsageUser author)
void	setCreatedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> createdAt)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDashboardQualityScore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Double> dashboardQualityScore)
void	setDashboardQualityScore(Double dashboardQualityScore)
void	setEditedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> editedAt)
void	setEditedAt(OffsetDateTime editedAt)
void	setOrgId(Long orgId)
void	setTeams_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> teams)
void	setTeams(List<String> teams)
void	setTitle(String title)
void	setTotalViews(Long totalViews)
void	setTotalViewsByType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> totalViewsByType)
void	setTotalViewsByType(Map<String,Long> totalViewsByType)
void	setViewedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> viewedAt)
void	setViewedAt(OffsetDateTime viewedAt)
void	setViewer_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> viewer)
void	setViewer(DashboardUsageUser viewer)
void	setWidgetCount_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> widgetCount)
void	setWidgetCount(Long widgetCount)
void	setWidgetCountByType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> widgetCountByType)
void	setWidgetCountByType(Map<String,Long> widgetCountByType)
DashboardUsageAttributes	teams(List<String> teams)
DashboardUsageAttributes	title(String title)
String	toString()
DashboardUsageAttributes	totalViews(Long totalViews)
DashboardUsageAttributes	totalViewsByType(Map<String,Long> totalViewsByType)
DashboardUsageAttributes	viewedAt(OffsetDateTime viewedAt)
DashboardUsageAttributes	viewer(DashboardUsageUser viewer)
DashboardUsageAttributes	widgetCount(Long widgetCount)
DashboardUsageAttributes	widgetCountByType(Map<String,Long> widgetCountByType)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_AUTHOR

public static final String JSON_PROPERTY_AUTHOR

See Also:

Constant Field Values

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

See Also:

Constant Field Values

JSON_PROPERTY_DASHBOARD_QUALITY_SCORE

public static final String JSON_PROPERTY_DASHBOARD_QUALITY_SCORE

See Also:

Constant Field Values

JSON_PROPERTY_EDITED_AT

public static final String JSON_PROPERTY_EDITED_AT

See Also:

Constant Field Values

JSON_PROPERTY_ORG_ID

public static final String JSON_PROPERTY_ORG_ID

See Also:

Constant Field Values

JSON_PROPERTY_TEAMS

public static final String JSON_PROPERTY_TEAMS

See Also:

Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

Constant Field Values

JSON_PROPERTY_TOTAL_VIEWS

public static final String JSON_PROPERTY_TOTAL_VIEWS

See Also:

Constant Field Values

JSON_PROPERTY_TOTAL_VIEWS_BY_TYPE

public static final String JSON_PROPERTY_TOTAL_VIEWS_BY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_VIEWED_AT

public static final String JSON_PROPERTY_VIEWED_AT

See Also:

Constant Field Values

JSON_PROPERTY_VIEWER

public static final String JSON_PROPERTY_VIEWER

See Also:

Constant Field Values

JSON_PROPERTY_WIDGET_COUNT

public static final String JSON_PROPERTY_WIDGET_COUNT

See Also:

Constant Field Values

JSON_PROPERTY_WIDGET_COUNT_BY_TYPE

public static final String JSON_PROPERTY_WIDGET_COUNT_BY_TYPE

See Also:

Constant Field Values

Constructor Detail

DashboardUsageAttributes

public DashboardUsageAttributes()

DashboardUsageAttributes

public DashboardUsageAttributes(Long orgId)

Method Detail

author

public DashboardUsageAttributes author(DashboardUsageUser author)

getAuthor

@Nullable
public DashboardUsageUser getAuthor()

A user referenced from a dashboard usage record (author or viewer).

Returns:

author

getAuthor_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> getAuthor_JsonNullable()

setAuthor_JsonNullable

public void setAuthor_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> author)

setAuthor

public void setAuthor(DashboardUsageUser author)

createdAt

public DashboardUsageAttributes createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

When the dashboard was created.

Returns:

createdAt

getCreatedAt_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getCreatedAt_JsonNullable()

setCreatedAt_JsonNullable

public void setCreatedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> createdAt)

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

dashboardQualityScore

public DashboardUsageAttributes dashboardQualityScore(Double dashboardQualityScore)

getDashboardQualityScore

@Nullable
public Double getDashboardQualityScore()

The dashboard quality score, or null when no score is available.

Returns:

dashboardQualityScore

getDashboardQualityScore_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Double> getDashboardQualityScore_JsonNullable()

setDashboardQualityScore_JsonNullable

public void setDashboardQualityScore_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Double> dashboardQualityScore)

setDashboardQualityScore

public void setDashboardQualityScore(Double dashboardQualityScore)

editedAt

public DashboardUsageAttributes editedAt(OffsetDateTime editedAt)

getEditedAt

@Nullable
public OffsetDateTime getEditedAt()

When the dashboard was most recently edited.

Returns:

editedAt

getEditedAt_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getEditedAt_JsonNullable()

setEditedAt_JsonNullable

public void setEditedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> editedAt)

setEditedAt

public void setEditedAt(OffsetDateTime editedAt)

orgId

public DashboardUsageAttributes orgId(Long orgId)

getOrgId

public Long getOrgId()

The Datadog organization that owns the dashboard.

Returns:

orgId

setOrgId

public void setOrgId(Long orgId)

teams

public DashboardUsageAttributes teams(List<String> teams)

addTeamsItem

public DashboardUsageAttributes addTeamsItem(String teamsItem)

getTeams

@Nullable
public List<String> getTeams()

Teams the dashboard is tagged with.

Returns:

teams

getTeams_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<List<String>> getTeams_JsonNullable()

setTeams_JsonNullable

public void setTeams_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> teams)

setTeams

public void setTeams(List<String> teams)

title

public DashboardUsageAttributes title(String title)

getTitle

@Nullable
public String getTitle()

The dashboard title.

Returns:

title

setTitle

public void setTitle(String title)

totalViews

public DashboardUsageAttributes totalViews(Long totalViews)

getTotalViews

@Nullable
public Long getTotalViews()

Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); 0 in orgs without RUM.

Returns:

totalViews

setTotalViews

public void setTotalViews(Long totalViews)

totalViewsByType

public DashboardUsageAttributes totalViewsByType(Map<String,Long> totalViewsByType)

putTotalViewsByTypeItem

public DashboardUsageAttributes putTotalViewsByTypeItem(String key,
                                                        Long totalViewsByTypeItem)

getTotalViewsByType

@Nullable
public Map<String,Long> getTotalViewsByType()

View counts keyed by view type (in_app, embed, public, shared, api, unknown). Counts only views captured by Real User Monitoring (RUM); empty in orgs without RUM.

Returns:

totalViewsByType

getTotalViewsByType_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> getTotalViewsByType_JsonNullable()

setTotalViewsByType_JsonNullable

public void setTotalViewsByType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> totalViewsByType)

setTotalViewsByType

public void setTotalViewsByType(Map<String,Long> totalViewsByType)

viewedAt

public DashboardUsageAttributes viewedAt(OffsetDateTime viewedAt)

getViewedAt

@Nullable
public OffsetDateTime getViewedAt()

When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; null in orgs without RUM.

Returns:

viewedAt

getViewedAt_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> getViewedAt_JsonNullable()

setViewedAt_JsonNullable

public void setViewedAt_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> viewedAt)

setViewedAt

public void setViewedAt(OffsetDateTime viewedAt)

viewer

public DashboardUsageAttributes viewer(DashboardUsageUser viewer)

getViewer

@Nullable
public DashboardUsageUser getViewer()

A user referenced from a dashboard usage record (author or viewer).

Returns:

viewer

getViewer_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> getViewer_JsonNullable()

setViewer_JsonNullable

public void setViewer_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardUsageUser> viewer)

setViewer

public void setViewer(DashboardUsageUser viewer)

widgetCount

public DashboardUsageAttributes widgetCount(Long widgetCount)

getWidgetCount

@Nullable
public Long getWidgetCount()

The total number of widgets on the dashboard.

Returns:

widgetCount

getWidgetCount_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Long> getWidgetCount_JsonNullable()

setWidgetCount_JsonNullable

public void setWidgetCount_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Long> widgetCount)

setWidgetCount

public void setWidgetCount(Long widgetCount)

widgetCountByType

public DashboardUsageAttributes widgetCountByType(Map<String,Long> widgetCountByType)

putWidgetCountByTypeItem

public DashboardUsageAttributes putWidgetCountByTypeItem(String key,
                                                         Long widgetCountByTypeItem)

getWidgetCountByType

@Nullable
public Map<String,Long> getWidgetCountByType()

Widget counts keyed by widget type. The map includes group widgets and widgets without requests.

Returns:

widgetCountByType

getWidgetCountByType_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> getWidgetCountByType_JsonNullable()

setWidgetCountByType_JsonNullable

public void setWidgetCountByType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Map<String,Long>> widgetCountByType)

setWidgetCountByType

public void setWidgetCountByType(Map<String,Long> widgetCountByType)

putAdditionalProperty

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

DashboardUsageAttributes

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