Package io.opencensus.trace.export
Class RunningSpanStore.Filter
java.lang.Object
io.opencensus.trace.export.RunningSpanStore.Filter
- Direct Known Subclasses:
AutoValue_RunningSpanStore_Filter
- Enclosing class:
RunningSpanStore
Filter for running spans. Used to filter results returned by the
RunningSpanStore.getRunningSpans(Filter)
request.- Since:
- 0.5
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic RunningSpanStore.Filter
Returns a new instance ofFilter
.abstract int
Returns the maximum number of spans to be returned.abstract String
Returns the span name.
-
Constructor Details
-
Filter
Filter()
-
-
Method Details
-
create
Returns a new instance ofFilter
.Filters all the spans based on
spanName
and returns a maximum ofmaxSpansToReturn
.- Parameters:
spanName
- the name of the span.maxSpansToReturn
- the maximum number of results to be returned.0
means all.- Returns:
- a new instance of
Filter
. - Throws:
NullPointerException
- ifspanName
isnull
.IllegalArgumentException
- ifmaxSpansToReturn
is negative.- Since:
- 0.5
-
getSpanName
Returns the span name.- Returns:
- the span name.
- Since:
- 0.5
-
getMaxSpansToReturn
public abstract int getMaxSpansToReturn()Returns the maximum number of spans to be returned.0
means all.- Returns:
- the maximum number of spans to be returned.
- Since:
- 0.5
-