Purpose (SmallRye: GraphQL Server :: API 2.8.3 API)

java.lang.Object
- java.lang.Enum<Purpose>
- - io.smallrye.graphql.api.federation.link.Purpose

All Implemented Interfaces:

Serializable, Comparable<Purpose>
```
public enum Purpose
extends Enum<Purpose>
```
The role of a Link schema. This behavior is different for Link with a specified purpose:
- SECURITY links convey metadata necessary to compute the API schema and securely resolve fields within it
- EXECUTION links convey metadata necessary to correctly resolve fields within the schema
- UNDEFINED is used for internal purposes as the default value that should be ignored and not used in the schema

Enum Constant Summary

Enum Constants
Enum Constant Description

EXECUTION

SECURITY

UNDEFINED

Method Summary

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

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SECURITY
```
@Description("`SECURITY` features provide metadata necessary to securely resolve fields.")
public static final Purpose SECURITY
```
  - EXECUTION
```
@Description("`EXECUTION` features provide metadata necessary for operation execution.")
public static final Purpose EXECUTION
```
  - UNDEFINED
```
@Ignore
public static final Purpose UNDEFINED
```
- Method Detail
  - values
```
public static Purpose[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (Purpose c : Purpose.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Purpose valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null