Class ExperimentFetchParams.Builder
-
- All Implemented Interfaces:
public final class ExperimentFetchParams.BuilderA builder for ExperimentFetchParams.
-
-
Method Summary
-
-
Method Detail
-
experimentId
final ExperimentFetchParams.Builder experimentId(String experimentId)
Experiment id
-
limit
final ExperimentFetchParams.Builder limit(Long limit)
limit the number of traces fetched
Fetch queries may be paginated if the total result size is expected to be large (e.g. project_logs which accumulate over a long time). Note that fetch queries only support pagination in descending time order (from latest to earliest
_xact_id. Furthermore, later pages may return rows which showed up in earlier pages, except with an earlier_xact_id. This happens because pagination occurs over the whole version history of the event log. You will most likely want to exclude any such duplicate, outdated rows (byid) from your combined result set.The
limitparameter controls the number of full traces to return. So you may end up with more individual rows than the specified limit if you are fetching events containing traces.
-
limit
final ExperimentFetchParams.Builder limit(Long limit)
Alias for Builder.limit.
This unboxed primitive overload exists for backwards compatibility.
-
limit
final ExperimentFetchParams.Builder limit(Optional<Long> limit)
Alias for calling Builder.limit with
limit.orElse(null).
-
maxRootSpanId
final ExperimentFetchParams.Builder maxRootSpanId(String maxRootSpanId)
DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer the 'cursor' argument going forwards.
Together,
max_xact_idandmax_root_span_idform a pagination cursorSince a paginated fetch query returns results in order from latest to earliest, the cursor for the next page can be found as the row with the minimum (earliest) value of the tuple
(_xact_id, root_span_id). See the documentation oflimitfor an overview of paginating fetch queries.
-
maxRootSpanId
final ExperimentFetchParams.Builder maxRootSpanId(Optional<String> maxRootSpanId)
Alias for calling Builder.maxRootSpanId with
maxRootSpanId.orElse(null).
-
maxXactId
final ExperimentFetchParams.Builder maxXactId(String maxXactId)
DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. Please prefer the 'cursor' argument going forwards.
Together,
max_xact_idandmax_root_span_idform a pagination cursorSince a paginated fetch query returns results in order from latest to earliest, the cursor for the next page can be found as the row with the minimum (earliest) value of the tuple
(_xact_id, root_span_id). See the documentation oflimitfor an overview of paginating fetch queries.
-
maxXactId
final ExperimentFetchParams.Builder maxXactId(Optional<String> maxXactId)
Alias for calling Builder.maxXactId with
maxXactId.orElse(null).
-
version
final ExperimentFetchParams.Builder version(String version)
Retrieve a snapshot of events from a past time
The version id is essentially a filter on the latest event transaction id. You can use the
max_xact_idreturned by a past fetch as the version to reproduce that exact fetch.
-
version
final ExperimentFetchParams.Builder version(Optional<String> version)
Alias for calling Builder.version with
version.orElse(null).
-
additionalHeaders
final ExperimentFetchParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final ExperimentFetchParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final ExperimentFetchParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final ExperimentFetchParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final ExperimentFetchParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final ExperimentFetchParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final ExperimentFetchParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final ExperimentFetchParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final ExperimentFetchParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final ExperimentFetchParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final ExperimentFetchParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final ExperimentFetchParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final ExperimentFetchParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final ExperimentFetchParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final ExperimentFetchParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final ExperimentFetchParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final ExperimentFetchParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final ExperimentFetchParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final ExperimentFetchParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final ExperimentFetchParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final ExperimentFetchParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final ExperimentFetchParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final ExperimentFetchParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final ExperimentFetchParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final ExperimentFetchParams build()
Returns an immutable instance of ExperimentFetchParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.experimentId()
-
-
-
-