Class DatasetFetchPostParams.Body
-
- All Implemented Interfaces:
public final class DatasetFetchPostParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classDatasetFetchPostParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<String>cursor()An opaque string to be used as a cursor for the next page of results, in order from latest to earliest. final Optional<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 Optional<String>maxRootSpanId()DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. final Optional<String>maxXactId()DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests. final Optional<String>version()Retrieve a snapshot of events from a past timeThe version id is essentially a filter on the latest event transaction id. final JsonField<String>_cursor()Returns the raw JSON value of cursor. final JsonField<Long>_limit()Returns the raw JSON value of limit. final JsonField<String>_maxRootSpanId()Returns the raw JSON value of maxRootSpanId. final JsonField<String>_maxXactId()Returns the raw JSON value of maxXactId. final JsonField<String>_version()Returns the raw JSON value of version. final Map<String, JsonValue>_additionalProperties()final DatasetFetchPostParams.Bodyvalidate()final DatasetFetchPostParams.Body.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static DatasetFetchPostParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
cursor
final Optional<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
-
limit
final Optional<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.
-
maxRootSpanId
final Optional<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.
-
maxXactId
final Optional<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.
-
version
final Optional<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.
-
_cursor
final JsonField<String> _cursor()
Returns the raw JSON value of cursor.
Unlike cursor, this method doesn't throw if the JSON field has an unexpected type.
-
_limit
final JsonField<Long> _limit()
Returns the raw JSON value of limit.
Unlike limit, this method doesn't throw if the JSON field has an unexpected type.
-
_maxRootSpanId
final JsonField<String> _maxRootSpanId()
Returns the raw JSON value of maxRootSpanId.
Unlike maxRootSpanId, this method doesn't throw if the JSON field has an unexpected type.
-
_maxXactId
final JsonField<String> _maxXactId()
Returns the raw JSON value of maxXactId.
Unlike maxXactId, this method doesn't throw if the JSON field has an unexpected type.
-
_version
final JsonField<String> _version()
Returns the raw JSON value of version.
Unlike version, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final DatasetFetchPostParams.Body validate()
-
toBuilder
final DatasetFetchPostParams.Body.Builder toBuilder()
-
builder
final static DatasetFetchPostParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
-
-
-
-