SamplerFunction.Constants (Spring Cloud Sleuth API 3.1.10 API)

java.lang.Object
- java.lang.Enum<SamplerFunction.Constants>
- - org.springframework.cloud.sleuth.SamplerFunction.Constants

All Implemented Interfaces:

Serializable, Comparable<SamplerFunction.Constants>, SamplerFunction<Object>

Enclosing interface:

SamplerFunction<T>
```
public static enum SamplerFunction.Constants
extends Enum<SamplerFunction.Constants>
implements SamplerFunction<Object>
```
Constant SamplerFunctions.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.springframework.cloud.sleuth.SamplerFunction
  SamplerFunction.Constants

Enum Constant Summary

Enum Constants
Enum Constant Description

ALWAYS_SAMPLE
Will always sample this trace.

DEFER_DECISION
Always defers sampling decision.

NEVER_SAMPLE
Will never sample this trace.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static SamplerFunction.Constants`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SamplerFunction.Constants[]`	`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

Methods inherited from interface org.springframework.cloud.sleuth.SamplerFunction
trySample

- Enum Constant Detail
  - DEFER_DECISION
```
public static final SamplerFunction.Constants DEFER_DECISION
```
    Always defers sampling decision.
  - NEVER_SAMPLE
```
public static final SamplerFunction.Constants NEVER_SAMPLE
```
    Will never sample this trace.
  - ALWAYS_SAMPLE
```
public static final SamplerFunction.Constants ALWAYS_SAMPLE
```
    Will always sample this trace.
- Method Detail
  - values
```
public static SamplerFunction.Constants[] 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 (SamplerFunction.Constants c : SamplerFunction.Constants.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SamplerFunction.Constants 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