Package org.apache.hadoop.yarn.api.records.timelineservice

Class TimelineDomain

java.lang.Object
org.apache.hadoop.yarn.api.records.timelineservice.TimelineDomain
@Public @Evolving public class TimelineDomain extends Object

This class contains the information about a timeline service domain, which is used to a user to host a number of timeline entities, isolating them from others'. The user can also define the reader and writer users/groups for the domain, which is used to control the access to its entities.

The reader and writer users/groups pattern that the user can supply is the same as what AccessControlList takes.

  • Constructor Details

    • TimelineDomain

      public TimelineDomain()

  • Method Details

    • getId

      public String getId()
      Get the domain ID.
      Returns:
      the domain ID

    • setId

      public void setId(String id)
      Set the domain ID.
      Parameters:
      id - the domain ID

    • getDescription

      public String getDescription()
      Get the domain description.
      Returns:
      the domain description

    • setDescription

      public void setDescription(String description)
      Set the domain description.
      Parameters:
      description - the domain description

    • getOwner

      public String getOwner()
      Get the domain owner.
      Returns:
      the domain owner

    • setOwner

      public void setOwner(String owner)
      Set the domain owner. The user doesn't need to set it, which will automatically set to the user who puts the domain.
      Parameters:
      owner - the domain owner

    • getReaders

      public String getReaders()
      Get the reader (and/or reader group) list string.
      Returns:
      the reader (and/or reader group) list string

    • setReaders

      public void setReaders(String readers)
      Set the reader (and/or reader group) list string.
      Parameters:
      readers - the reader (and/or reader group) list string

    • getWriters

      public String getWriters()
      Get the writer (and/or writer group) list string.
      Returns:
      the writer (and/or writer group) list string

    • setWriters

      public void setWriters(String writers)
      Set the writer (and/or writer group) list string.
      Parameters:
      writers - the writer (and/or writer group) list string

    • getCreatedTime

      public Long getCreatedTime()
      Get the created time of the domain.
      Returns:
      the created time of the domain

    • setCreatedTime

      public void setCreatedTime(Long createdTime)
      Set the created time of the domain.
      Parameters:
      createdTime - the created time of the domain

    • getModifiedTime

      public Long getModifiedTime()
      Get the modified time of the domain.
      Returns:
      the modified time of the domain

    • setModifiedTime

      public void setModifiedTime(Long modifiedTime)
      Set the modified time of the domain.
      Parameters:
      modifiedTime - the modified time of the domain