Package com.datadog.api.client.v2.model

Class SecureEmbedCreateResponseAttributes

java.lang.Object

com.datadog.api.client.v2.model.SecureEmbedCreateResponseAttributes

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

Attributes of a newly created secure embed shared dashboard.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CREATED_AT
static final String	JSON_PROPERTY_CREDENTIAL
static final String	JSON_PROPERTY_DASHBOARD_ID
static final String	JSON_PROPERTY_GLOBAL_TIME
static final String	JSON_PROPERTY_GLOBAL_TIME_SELECTABLE
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_SELECTABLE_TEMPLATE_VARS
static final String	JSON_PROPERTY_SHARE_TYPE
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_TOKEN
static final String	JSON_PROPERTY_URL
static final String	JSON_PROPERTY_VIEWING_PREFERENCES
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
SecureEmbedCreateResponseAttributes()

Method Summary

Modifier and Type	Method	Description
SecureEmbedCreateResponseAttributes	addSelectableTemplateVarsItem(SecureEmbedSelectableTemplateVariable selectableTemplateVarsItem)
boolean	equals(Object o)	Return true if this SecureEmbedCreateResponseAttributes 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	getCreatedAt()	Creation timestamp.
String	getCredential()	The secret credential used for HMAC signing.
String	getDashboardId()	The source dashboard ID.
SecureEmbedGlobalTime	getGlobalTime()	Default time range configuration for the secure embed.
Boolean	getGlobalTimeSelectable()	Whether time range is viewer-selectable.
String	getId()	Internal share ID.
List<SecureEmbedSelectableTemplateVariable>	getSelectableTemplateVars()	Template variables with their configuration.
SecureEmbedShareType	getShareType()	The type of share.
SecureEmbedStatus	getStatus()	The status of the secure embed share.
String	getTitle()	Display title.
String	getToken()	Public share token.
String	getUrl()	CDN URL for the shared dashboard.
SecureEmbedViewingPreferences	getViewingPreferences()	Display settings for the secure embed shared dashboard.
SecureEmbedCreateResponseAttributes	globalTime(SecureEmbedGlobalTime globalTime)
SecureEmbedCreateResponseAttributes	globalTimeSelectable(Boolean globalTimeSelectable)
int	hashCode()
SecureEmbedCreateResponseAttributes	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
SecureEmbedCreateResponseAttributes	selectableTemplateVars(List<SecureEmbedSelectableTemplateVariable> selectableTemplateVars)
void	setGlobalTime(SecureEmbedGlobalTime globalTime)
void	setGlobalTimeSelectable(Boolean globalTimeSelectable)
void	setSelectableTemplateVars(List<SecureEmbedSelectableTemplateVariable> selectableTemplateVars)
void	setShareType(SecureEmbedShareType shareType)
void	setStatus(SecureEmbedStatus status)
void	setTitle(String title)
void	setViewingPreferences(SecureEmbedViewingPreferences viewingPreferences)
SecureEmbedCreateResponseAttributes	shareType(SecureEmbedShareType shareType)
SecureEmbedCreateResponseAttributes	status(SecureEmbedStatus status)
SecureEmbedCreateResponseAttributes	title(String title)
String	toString()
SecureEmbedCreateResponseAttributes	viewingPreferences(SecureEmbedViewingPreferences viewingPreferences)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CREATED_AT

public static final String JSON_PROPERTY_CREATED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_CREDENTIAL

public static final String JSON_PROPERTY_CREDENTIAL

See Also:

• Constant Field Values

JSON_PROPERTY_DASHBOARD_ID

public static final String JSON_PROPERTY_DASHBOARD_ID

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

public static final String JSON_PROPERTY_GLOBAL_TIME_SELECTABLE

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

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_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_TOKEN

public static final String JSON_PROPERTY_TOKEN

See Also:

• Constant Field Values

JSON_PROPERTY_URL

public static final String JSON_PROPERTY_URL

See Also:

• Constant Field Values

JSON_PROPERTY_VIEWING_PREFERENCES

public static final String JSON_PROPERTY_VIEWING_PREFERENCES

See Also:

• Constant Field Values

Constructor Details

SecureEmbedCreateResponseAttributes

public SecureEmbedCreateResponseAttributes()

Method Details

getCreatedAt

@Nullable
public String getCreatedAt()

Creation timestamp.

Returns:

createdAt

getCredential

@Nullable
public String getCredential()

The secret credential used for HMAC signing. Returned only on creation. Store securely — it cannot be retrieved again.

Returns:

credential

getDashboardId

@Nullable
public String getDashboardId()

The source dashboard ID.

Returns:

dashboardId

globalTime

public SecureEmbedCreateResponseAttributes globalTime(SecureEmbedGlobalTime globalTime)

getGlobalTime

@Nullable
public SecureEmbedGlobalTime getGlobalTime()

Default time range configuration for the secure embed.

Returns:

globalTime

setGlobalTime

public void setGlobalTime(SecureEmbedGlobalTime globalTime)

globalTimeSelectable

public SecureEmbedCreateResponseAttributes globalTimeSelectable(Boolean globalTimeSelectable)

getGlobalTimeSelectable

@Nullable
public Boolean getGlobalTimeSelectable()

Whether time range is viewer-selectable.

Returns:

globalTimeSelectable

setGlobalTimeSelectable

public void setGlobalTimeSelectable(Boolean globalTimeSelectable)

getId

@Nullable
public String getId()

Internal share ID.

Returns:

id

selectableTemplateVars

public SecureEmbedCreateResponseAttributes selectableTemplateVars(List<SecureEmbedSelectableTemplateVariable> selectableTemplateVars)

addSelectableTemplateVarsItem

public SecureEmbedCreateResponseAttributes addSelectableTemplateVarsItem(SecureEmbedSelectableTemplateVariable selectableTemplateVarsItem)

getSelectableTemplateVars

@Nullable
public List<SecureEmbedSelectableTemplateVariable> getSelectableTemplateVars()

Template variables with their configuration.

Returns:

selectableTemplateVars

setSelectableTemplateVars

public void setSelectableTemplateVars(List<SecureEmbedSelectableTemplateVariable> selectableTemplateVars)

shareType

public SecureEmbedCreateResponseAttributes shareType(SecureEmbedShareType shareType)

getShareType

@Nullable
public SecureEmbedShareType getShareType()

The type of share. Always secure_embed.

Returns:

shareType

setShareType

public void setShareType(SecureEmbedShareType shareType)

status

public SecureEmbedCreateResponseAttributes status(SecureEmbedStatus status)

getStatus

@Nullable
public SecureEmbedStatus getStatus()

The status of the secure embed share. Active means the shared dashboard is available. Paused means it is not.

Returns:

status

setStatus

public void setStatus(SecureEmbedStatus status)

title

public SecureEmbedCreateResponseAttributes title(String title)

getTitle

@Nullable
public String getTitle()

Display title.

Returns:

title

setTitle

public void setTitle(String title)

getToken

@Nullable
public String getToken()

Public share token.

Returns:

token

getUrl

@Nullable
public String getUrl()

CDN URL for the shared dashboard.

Returns:

url

viewingPreferences

public SecureEmbedCreateResponseAttributes viewingPreferences(SecureEmbedViewingPreferences viewingPreferences)

getViewingPreferences

@Nullable
public SecureEmbedViewingPreferences getViewingPreferences()

Display settings for the secure embed shared dashboard.

Returns:

viewingPreferences

setViewingPreferences

public void setViewingPreferences(SecureEmbedViewingPreferences viewingPreferences)

putAdditionalProperty

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

SecureEmbedCreateResponseAttributes

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