EndSpanOptions

java.lang.Object
- io.opencensus.trace.EndSpanOptions

Direct Known Subclasses:

AutoValue_EndSpanOptions
```
@Immutable
public abstract class EndSpanOptions
extends java.lang.Object
```
A class that enables overriding the default values used when ending a Span. Allows overriding the status.

Since:

0.5

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class EndSpanOptions.Builder
Builder class for EndSpanOptions.

Field Summary

Fields
Modifier and Type Field Description

static EndSpanOptions DEFAULT
The default EndSpanOptions.

Constructor Summary

Constructors
Constructor Description

EndSpanOptions()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static EndSpanOptions.Builder`	`builder()`	Returns a new `EndSpanOptions.Builder` with default options.
`abstract boolean`	`getSampleToLocalSpanStore()`	If `true` this is equivalent with calling the `SampledSpanStore.registerSpanNamesForCollection(Collection)` in advance for this span name.
`abstract Status`	`getStatus()`	Returns the status.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT
```
public static final EndSpanOptions DEFAULT
```
    The default EndSpanOptions.
    
    Since:
    
    0.5
- Constructor Detail
  - EndSpanOptions
```
EndSpanOptions()
```
- Method Detail
  - builder
```
public static EndSpanOptions.Builder builder()
```
    Returns a new EndSpanOptions.Builder with default options.
    
    Returns:
    
    a new Builder with default options.
    
    Since:
    
    0.5
  - getSampleToLocalSpanStore
```
@ExperimentalApi
public abstract boolean getSampleToLocalSpanStore()
```
    If true this is equivalent with calling the SampledSpanStore.registerSpanNamesForCollection(Collection) in advance for this span name.
    
    Returns:
    
    true if the name of the Span should be registered to the io.opencensus.trace.export.SampledSpanStore.
    
    Since:
    
    0.8
  - getStatus
```
@Nullable
public abstract Status getStatus()
```
    Returns the status.
    If null then the Span will record the Status set via Span.setStatus(Status) or the default Status.OK if no status was set.
    
    Returns:
    
    the status.
    
    Since:
    
    0.5