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

Class SharedDashboard

java.lang.Object
com.datadog.api.client.v1.model.SharedDashboard
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class SharedDashboard extends Object
The metadata object associated with how a dashboard has been/will be shared.

  • Field Details

  • Constructor Details

    • SharedDashboard

      public SharedDashboard()

    • SharedDashboard

      public SharedDashboard(String dashboardId, DashboardType dashboardType)

  • Method Details

    • getAuthor

      @Nullable public SharedDashboardAuthor getAuthor()
      User who shared the dashboard.
      Returns:
      author

    • getCreated

      @Nullable public OffsetDateTime getCreated()
      Date the dashboard was shared.
      Returns:
      created

    • dashboardId

      public SharedDashboard dashboardId(String dashboardId)

    • getDashboardId

      public String getDashboardId()
      ID of the dashboard to share.
      Returns:
      dashboardId

    • setDashboardId

      public void setDashboardId(String dashboardId)

    • dashboardType

      public SharedDashboard dashboardType(DashboardType dashboardType)

    • getDashboardType

      public DashboardType getDashboardType()
      The type of the associated private dashboard.
      Returns:
      dashboardType

    • setDashboardType

      public void setDashboardType(DashboardType dashboardType)

    • embeddableDomains

      public SharedDashboard embeddableDomains(List<String> embeddableDomains)

    • addEmbeddableDomainsItem

      public SharedDashboard addEmbeddableDomainsItem(String embeddableDomainsItem)

    • getEmbeddableDomains

      @Nullable public List<String> getEmbeddableDomains()
      The SharedDashboard embeddable_domains.
      Returns:
      embeddableDomains

    • setEmbeddableDomains

      public void setEmbeddableDomains(List<String> embeddableDomains)

    • expiration

      public SharedDashboard 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 SharedDashboard globalTime(DashboardGlobalTime globalTime)

    • getGlobalTime

      @Nullable public DashboardGlobalTime getGlobalTime()
      Object containing the live span selection for the dashboard.
      Returns:
      globalTime

    • setGlobalTime

      public void setGlobalTime(DashboardGlobalTime globalTime)

    • globalTimeSelectableEnabled

      public SharedDashboard 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 SharedDashboard invitees(List<SharedDashboardInviteesItems> invitees)

    • addInviteesItem

      public SharedDashboard addInviteesItem(SharedDashboardInviteesItems inviteesItem)

    • getInvitees

      @Nullable public List<SharedDashboardInviteesItems> getInvitees()
      The SharedDashboard invitees.
      Returns:
      invitees

    • setInvitees

      public void setInvitees(List<SharedDashboardInviteesItems> invitees)

    • getLastAccessed

      @Nullable public OffsetDateTime getLastAccessed()
      The last time the shared dashboard was accessed. Null if never accessed.
      Returns:
      lastAccessed

    • getLastAccessed_JsonNullable

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

    • getPublicUrl

      @Nullable public String getPublicUrl()
      URL of the shared dashboard.
      Returns:
      publicUrl

    • selectableTemplateVars

      public SharedDashboard selectableTemplateVars(List<SelectableTemplateVariableItems> selectableTemplateVars)

    • addSelectableTemplateVarsItem

      public SharedDashboard 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 SharedDashboard shareList(List<String> shareList)

    • addShareListItem

      public SharedDashboard addShareListItem(String shareListItem)

    • getShareList

      @Deprecated @Nullable public List<String> getShareList()
      Deprecated.
      List of email addresses that can receive an invitation to 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 SharedDashboard 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 SharedDashboard 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 SharedDashboard title(String title)

    • getTitle

      @Nullable public String getTitle()
      Title of the shared dashboard.
      Returns:
      title

    • setTitle

      public void setTitle(String title)

    • getToken

      @Nullable public String getToken()
      A unique token assigned to the shared dashboard.
      Returns:
      token

    • viewingPreferences

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

    • 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 SharedDashboard 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