ApplicationsRequestScope (Apache Hadoop YARN API 3.5.0 API)
Description: declaration: package: org.apache.hadoop.yarn.api.protocolrecords, enum: ApplicationsRequestScope

Package org.apache.hadoop.yarn.api.protocolrecords

# Enum Class ApplicationsRequestScope

java.lang.Object
java.lang.Enum<ApplicationsRequestScope>
org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope

All Implemented Interfaces:
  `Serializable`, `Comparable<ApplicationsRequestScope>`, `Constable`

@Public @Unstable public enum ApplicationsRequestScope extends Enum<ApplicationsRequestScope>
Enumeration that controls the scope of applications fetched

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `ALL`
  All jobs
  `OWN`
  Jobs owned by current user
  `VIEWABLE`
  Jobs viewable by current user

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static ApplicationsRequestScope`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static ApplicationsRequestScope[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### ALL

    public static final ApplicationsRequestScope ALL
    All jobs

  - ### VIEWABLE

    public static final ApplicationsRequestScope VIEWABLE
    Jobs viewable by current user

  - ### OWN

    public static final ApplicationsRequestScope OWN
    Jobs owned by current user

- ## Method Details

  - ### values

    public static ApplicationsRequestScope[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static ApplicationsRequestScope valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
    Parameters:
      `name` - the name of the enum constant to be returned.
    Returns:
      the enum constant with the specified name
    Throws:
      `IllegalArgumentException` - if this enum class has no constant with the specified name
      `NullPointerException` - if the argument is null