Class ExperimentFetchPostParams.Body.Builder
-
- All Implemented Interfaces:
public final class ExperimentFetchPostParams.Body.BuilderA builder for Body.
-
-
Method Summary
Modifier and Type Method Description final ExperimentFetchPostParams.Body.Buildercursor(String cursor)An opaque string to be used as a cursor for the next page of results, in order from latest to earliest. final ExperimentFetchPostParams.Body.Buildercursor(Optional<String> cursor)Alias for calling Builder.cursor with cursor.orElse(null).final ExperimentFetchPostParams.Body.Buildercursor(JsonField<String> cursor)Sets Builder.cursor to an arbitrary JSON value. final ExperimentFetchPostParams.Body.Builderlimit(Long limit)limit the number of traces fetchedFetch queries may be paginated if the total result size is expected to be large (e.g. final ExperimentFetchPostParams.Body.Builderlimit(Long limit)Alias for Builder.limit. final ExperimentFetchPostParams.Body.Builderlimit(Optional<Long> limit)Alias for calling Builder.limit with limit.orElse(null).final ExperimentFetchPostParams.Body.Builderlimit(JsonField<Long> limit)Sets Builder.limit to an arbitrary JSON value. final ExperimentFetchPostParams.Body.BuildermaxRootSpanId(String maxRootSpanId)DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. final ExperimentFetchPostParams.Body.BuildermaxRootSpanId(Optional<String> maxRootSpanId)Alias for calling Builder.maxRootSpanId with maxRootSpanId.orElse(null).final ExperimentFetchPostParams.Body.BuildermaxRootSpanId(JsonField<String> maxRootSpanId)Sets Builder.maxRootSpanId to an arbitrary JSON value. final ExperimentFetchPostParams.Body.BuildermaxXactId(String maxXactId)DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. final ExperimentFetchPostParams.Body.BuildermaxXactId(Optional<String> maxXactId)Alias for calling Builder.maxXactId with maxXactId.orElse(null).final ExperimentFetchPostParams.Body.BuildermaxXactId(JsonField<String> maxXactId)Sets Builder.maxXactId to an arbitrary JSON value. final ExperimentFetchPostParams.Body.Builderversion(String version)Retrieve a snapshot of events from a past timeThe version id is essentially a filter on the latest event transaction id. final ExperimentFetchPostParams.Body.Builderversion(Optional<String> version)Alias for calling Builder.version with version.orElse(null).final ExperimentFetchPostParams.Body.Builderversion(JsonField<String> version)Sets Builder.version to an arbitrary JSON value. final ExperimentFetchPostParams.Body.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final ExperimentFetchPostParams.Body.BuilderputAdditionalProperty(String key, JsonValue value)final ExperimentFetchPostParams.Body.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final ExperimentFetchPostParams.Body.BuilderremoveAdditionalProperty(String key)final ExperimentFetchPostParams.Body.BuilderremoveAllAdditionalProperties(Set<String> keys)final ExperimentFetchPostParams.Bodybuild()Returns an immutable instance of Body. -
-
Method Detail
-
cursor
final ExperimentFetchPostParams.Body.Builder cursor(String cursor)
An opaque string to be used as a cursor for the next page of results, in order from latest to earliest.
The string can be obtained directly from the
cursorproperty of the previous fetch query
-
cursor
final ExperimentFetchPostParams.Body.Builder cursor(Optional<String> cursor)
Alias for calling Builder.cursor with
cursor.orElse(null).
-
cursor
final ExperimentFetchPostParams.Body.Builder cursor(JsonField<String> cursor)
Sets Builder.cursor to an arbitrary JSON value.
You should usually call Builder.cursor with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
limit
final ExperimentFetchPostParams.Body.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 ExperimentFetchPostParams.Body.Builder limit(Long limit)
Alias for Builder.limit.
This unboxed primitive overload exists for backwards compatibility.
-
limit
final ExperimentFetchPostParams.Body.Builder limit(Optional<Long> limit)
Alias for calling Builder.limit with
limit.orElse(null).
-
limit
final ExperimentFetchPostParams.Body.Builder limit(JsonField<Long> limit)
Sets Builder.limit to an arbitrary JSON value.
You should usually call Builder.limit with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
maxRootSpanId
final ExperimentFetchPostParams.Body.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 ExperimentFetchPostParams.Body.Builder maxRootSpanId(Optional<String> maxRootSpanId)
Alias for calling Builder.maxRootSpanId with
maxRootSpanId.orElse(null).
-
maxRootSpanId
final ExperimentFetchPostParams.Body.Builder maxRootSpanId(JsonField<String> maxRootSpanId)
Sets Builder.maxRootSpanId to an arbitrary JSON value.
You should usually call Builder.maxRootSpanId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
maxXactId
final ExperimentFetchPostParams.Body.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 ExperimentFetchPostParams.Body.Builder maxXactId(Optional<String> maxXactId)
Alias for calling Builder.maxXactId with
maxXactId.orElse(null).
-
maxXactId
final ExperimentFetchPostParams.Body.Builder maxXactId(JsonField<String> maxXactId)
Sets Builder.maxXactId to an arbitrary JSON value.
You should usually call Builder.maxXactId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
version
final ExperimentFetchPostParams.Body.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 ExperimentFetchPostParams.Body.Builder version(Optional<String> version)
Alias for calling Builder.version with
version.orElse(null).
-
version
final ExperimentFetchPostParams.Body.Builder version(JsonField<String> version)
Sets Builder.version to an arbitrary JSON value.
You should usually call Builder.version with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ExperimentFetchPostParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ExperimentFetchPostParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ExperimentFetchPostParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ExperimentFetchPostParams.Body.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ExperimentFetchPostParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ExperimentFetchPostParams.Body build()
Returns an immutable instance of Body.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-