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

Class SharedDashboardUpdateRequest

java.lang.Object

com.datadog.api.client.v1.model.SharedDashboardUpdateRequest

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

Update a shared dashboard's settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_EMBEDDABLE_DOMAINS
static final String	JSON_PROPERTY_EXPIRATION
static final String	JSON_PROPERTY_GLOBAL_TIME
static final String	JSON_PROPERTY_GLOBAL_TIME_SELECTABLE_ENABLED
static final String	JSON_PROPERTY_INVITEES
static final String	JSON_PROPERTY_SELECTABLE_TEMPLATE_VARS
static final String	JSON_PROPERTY_SHARE_LIST
static final String	JSON_PROPERTY_SHARE_TYPE
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_VIEWING_PREFERENCES
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SharedDashboardUpdateRequest()

Method Summary

Modifier and Type	Method	Description
SharedDashboardUpdateRequest	addEmbeddableDomainsItem(String embeddableDomainsItem)
SharedDashboardUpdateRequest	addInviteesItem(SharedDashboardInviteesItems inviteesItem)
SharedDashboardUpdateRequest	addSelectableTemplateVarsItem(SelectableTemplateVariableItems selectableTemplateVarsItem)
SharedDashboardUpdateRequest	addShareListItem(String shareListItem)
SharedDashboardUpdateRequest	embeddableDomains(List<String> embeddableDomains)
boolean	equals(Object o)	Return true if this SharedDashboardUpdateRequest object is equal to o.
SharedDashboardUpdateRequest	expiration(OffsetDateTime expiration)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<String>	getEmbeddableDomains()	The SharedDashboard embeddable_domains.
OffsetDateTime	getExpiration()	The time when an OPEN shared dashboard becomes publicly unavailable.
org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime>	getExpiration_JsonNullable()
SharedDashboardUpdateRequestGlobalTime	getGlobalTime()	Timeframe setting for the shared dashboard.
org.openapitools.jackson.nullable.JsonNullable<SharedDashboardUpdateRequestGlobalTime>	getGlobalTime_JsonNullable()
Boolean	getGlobalTimeSelectableEnabled()	Whether to allow viewers to select a different global time setting for the shared dashboard.
org.openapitools.jackson.nullable.JsonNullable<Boolean>	getGlobalTimeSelectableEnabled_JsonNullable()
List<SharedDashboardInviteesItems>	getInvitees()	The SharedDashboard invitees.
List<SelectableTemplateVariableItems>	getSelectableTemplateVars()	List of objects representing template variables on the shared dashboard which can have selectable values.
org.openapitools.jackson.nullable.JsonNullable<List<SelectableTemplateVariableItems>>	getSelectableTemplateVars_JsonNullable()
List<String>	getShareList()	Deprecated.
org.openapitools.jackson.nullable.JsonNullable<List<String>>	getShareList_JsonNullable()	Deprecated.
DashboardShareType	getShareType()	Type of sharing access (either open to anyone who has the public URL or invite-only).
org.openapitools.jackson.nullable.JsonNullable<DashboardShareType>	getShareType_JsonNullable()
SharedDashboardStatus	getStatus()	Active means the dashboard is publicly available.
String	getTitle()	Title of the shared dashboard.
ViewingPreferences	getViewingPreferences()	The viewing preferences for a shared dashboard.
SharedDashboardUpdateRequest	globalTime(SharedDashboardUpdateRequestGlobalTime globalTime)
SharedDashboardUpdateRequest	globalTimeSelectableEnabled(Boolean globalTimeSelectableEnabled)
int	hashCode()
SharedDashboardUpdateRequest	invitees(List<SharedDashboardInviteesItems> invitees)
SharedDashboardUpdateRequest	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SharedDashboardUpdateRequest	selectableTemplateVars(List<SelectableTemplateVariableItems> selectableTemplateVars)
void	setEmbeddableDomains(List<String> embeddableDomains)
void	setExpiration(OffsetDateTime expiration)
void	setExpiration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> expiration)
void	setGlobalTime(SharedDashboardUpdateRequestGlobalTime globalTime)
void	setGlobalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<SharedDashboardUpdateRequestGlobalTime> globalTime)
void	setGlobalTimeSelectableEnabled(Boolean globalTimeSelectableEnabled)
void	setGlobalTimeSelectableEnabled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> globalTimeSelectableEnabled)
void	setInvitees(List<SharedDashboardInviteesItems> invitees)
void	setSelectableTemplateVars(List<SelectableTemplateVariableItems> selectableTemplateVars)
void	setSelectableTemplateVars_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<SelectableTemplateVariableItems>> selectableTemplateVars)
void	setShareList(List<String> shareList)
void	setShareList_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> shareList)
void	setShareType(DashboardShareType shareType)
void	setShareType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardShareType> shareType)
void	setStatus(SharedDashboardStatus status)
void	setTitle(String title)
void	setViewingPreferences(ViewingPreferences viewingPreferences)
SharedDashboardUpdateRequest	shareList(List<String> shareList)
SharedDashboardUpdateRequest	shareType(DashboardShareType shareType)
SharedDashboardUpdateRequest	status(SharedDashboardStatus status)
SharedDashboardUpdateRequest	title(String title)
String	toString()
SharedDashboardUpdateRequest	viewingPreferences(ViewingPreferences viewingPreferences)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_EMBEDDABLE_DOMAINS

public static final String JSON_PROPERTY_EMBEDDABLE_DOMAINS

See Also:

• Constant Field Values

JSON_PROPERTY_EXPIRATION

public static final String JSON_PROPERTY_EXPIRATION

See Also:

• Constant Field Values

JSON_PROPERTY_GLOBAL_TIME

public static final String JSON_PROPERTY_GLOBAL_TIME

See Also:

• Constant Field Values

JSON_PROPERTY_GLOBAL_TIME_SELECTABLE_ENABLED

public static final String JSON_PROPERTY_GLOBAL_TIME_SELECTABLE_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_INVITEES

public static final String JSON_PROPERTY_INVITEES

See Also:

• Constant Field Values

JSON_PROPERTY_SELECTABLE_TEMPLATE_VARS

public static final String JSON_PROPERTY_SELECTABLE_TEMPLATE_VARS

See Also:

• Constant Field Values

JSON_PROPERTY_SHARE_LIST

public static final String JSON_PROPERTY_SHARE_LIST

See Also:

• Constant Field Values

JSON_PROPERTY_SHARE_TYPE

public static final String JSON_PROPERTY_SHARE_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_VIEWING_PREFERENCES

public static final String JSON_PROPERTY_VIEWING_PREFERENCES

See Also:

• Constant Field Values

Constructor Details

SharedDashboardUpdateRequest

public SharedDashboardUpdateRequest()

Method Details

embeddableDomains

public SharedDashboardUpdateRequest embeddableDomains(List<String> embeddableDomains)

addEmbeddableDomainsItem

public SharedDashboardUpdateRequest addEmbeddableDomainsItem(String embeddableDomainsItem)

getEmbeddableDomains

@Nullable
public List<String> getEmbeddableDomains()

The SharedDashboard embeddable_domains.

Returns:

embeddableDomains

setEmbeddableDomains

public void setEmbeddableDomains(List<String> embeddableDomains)

expiration

public SharedDashboardUpdateRequest expiration(OffsetDateTime expiration)

getExpiration

@Nullable
public OffsetDateTime getExpiration()

The time when an OPEN shared dashboard becomes publicly unavailable.

Returns:

expiration

getExpiration_JsonNullable

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

setExpiration_JsonNullable

public void setExpiration_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<OffsetDateTime> expiration)

setExpiration

public void setExpiration(OffsetDateTime expiration)

globalTime

public SharedDashboardUpdateRequest globalTime(SharedDashboardUpdateRequestGlobalTime globalTime)

getGlobalTime

@Nullable
public SharedDashboardUpdateRequestGlobalTime getGlobalTime()

Timeframe setting for the shared dashboard.

Returns:

globalTime

getGlobalTime_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<SharedDashboardUpdateRequestGlobalTime> getGlobalTime_JsonNullable()

setGlobalTime_JsonNullable

public void setGlobalTime_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<SharedDashboardUpdateRequestGlobalTime> globalTime)

setGlobalTime

public void setGlobalTime(SharedDashboardUpdateRequestGlobalTime globalTime)

globalTimeSelectableEnabled

public SharedDashboardUpdateRequest globalTimeSelectableEnabled(Boolean globalTimeSelectableEnabled)

getGlobalTimeSelectableEnabled

@Nullable
public Boolean getGlobalTimeSelectableEnabled()

Whether to allow viewers to select a different global time setting for the shared dashboard.

Returns:

globalTimeSelectableEnabled

getGlobalTimeSelectableEnabled_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Boolean> getGlobalTimeSelectableEnabled_JsonNullable()

setGlobalTimeSelectableEnabled_JsonNullable

public void setGlobalTimeSelectableEnabled_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> globalTimeSelectableEnabled)

setGlobalTimeSelectableEnabled

public void setGlobalTimeSelectableEnabled(Boolean globalTimeSelectableEnabled)

invitees

public SharedDashboardUpdateRequest invitees(List<SharedDashboardInviteesItems> invitees)

addInviteesItem

public SharedDashboardUpdateRequest addInviteesItem(SharedDashboardInviteesItems inviteesItem)

getInvitees

@Nullable
public List<SharedDashboardInviteesItems> getInvitees()

The SharedDashboard invitees.

Returns:

invitees

setInvitees

public void setInvitees(List<SharedDashboardInviteesItems> invitees)

selectableTemplateVars

public SharedDashboardUpdateRequest selectableTemplateVars(List<SelectableTemplateVariableItems> selectableTemplateVars)

addSelectableTemplateVarsItem

public SharedDashboardUpdateRequest addSelectableTemplateVarsItem(SelectableTemplateVariableItems selectableTemplateVarsItem)

getSelectableTemplateVars

@Nullable
public List<SelectableTemplateVariableItems> getSelectableTemplateVars()

List of objects representing template variables on the shared dashboard which can have selectable values.

Returns:

selectableTemplateVars

getSelectableTemplateVars_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<List<SelectableTemplateVariableItems>> getSelectableTemplateVars_JsonNullable()

setSelectableTemplateVars_JsonNullable

public void setSelectableTemplateVars_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<SelectableTemplateVariableItems>> selectableTemplateVars)

setSelectableTemplateVars

public void setSelectableTemplateVars(List<SelectableTemplateVariableItems> selectableTemplateVars)

shareList

public SharedDashboardUpdateRequest shareList(List<String> shareList)

addShareListItem

public SharedDashboardUpdateRequest addShareListItem(String shareListItem)

getShareList

@Deprecated
@Nullable
public List<String> getShareList()

Deprecated.

List of email addresses that can be given access to the shared dashboard.

Returns:

shareList

getShareList_JsonNullable

@Deprecated
public org.openapitools.jackson.nullable.JsonNullable<List<String>> getShareList_JsonNullable()

Deprecated.

setShareList_JsonNullable

public void setShareList_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<String>> shareList)

setShareList

public void setShareList(List<String> shareList)

shareType

public SharedDashboardUpdateRequest shareType(DashboardShareType shareType)

getShareType

@Nullable
public DashboardShareType getShareType()

Type of sharing access (either open to anyone who has the public URL or invite-only).

Returns:

shareType

getShareType_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<DashboardShareType> getShareType_JsonNullable()

setShareType_JsonNullable

public void setShareType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<DashboardShareType> shareType)

setShareType

public void setShareType(DashboardShareType shareType)

status

public SharedDashboardUpdateRequest status(SharedDashboardStatus status)

getStatus

@Nullable
public SharedDashboardStatus getStatus()

Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.

Returns:

status

setStatus

public void setStatus(SharedDashboardStatus status)

title

public SharedDashboardUpdateRequest title(String title)

getTitle

@Nullable
public String getTitle()

Title of the shared dashboard.

Returns:

title

setTitle

public void setTitle(String title)

viewingPreferences

public SharedDashboardUpdateRequest viewingPreferences(ViewingPreferences viewingPreferences)

getViewingPreferences

@Nullable
public ViewingPreferences getViewingPreferences()

The viewing preferences for a shared dashboard.

Returns:

viewingPreferences

setViewingPreferences

public void setViewingPreferences(ViewingPreferences viewingPreferences)

putAdditionalProperty

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

SharedDashboardUpdateRequest

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