Constructor Detail

Method Detail

• datasetId

   final DatasetFetchPostParams.Builder datasetId(String datasetId)

  Dataset id

• body

   final DatasetFetchPostParams.Builder body(DatasetFetchPostParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • cursor

  • limit

  • maxRootSpanId

  • maxXactId

  • version

  • etc.

• cursor

   final DatasetFetchPostParams.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 cursor property of the previous fetch query

• cursor

   final DatasetFetchPostParams.Builder cursor(Optional<String> cursor)

  Alias for calling Builder.cursor with cursor.orElse(null).

• cursor

   final DatasetFetchPostParams.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 DatasetFetchPostParams.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 (by id) from your combined result set.

  The limit parameter 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 DatasetFetchPostParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final DatasetFetchPostParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• limit

   final DatasetFetchPostParams.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 DatasetFetchPostParams.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_id and max_root_span_id form a pagination cursor

  Since 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 of limit for an overview of paginating fetch queries.

• maxRootSpanId

   final DatasetFetchPostParams.Builder maxRootSpanId(Optional<String> maxRootSpanId)

  Alias for calling Builder.maxRootSpanId with maxRootSpanId.orElse(null).

• maxRootSpanId

   final DatasetFetchPostParams.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 DatasetFetchPostParams.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_id and max_root_span_id form a pagination cursor

  Since 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 of limit for an overview of paginating fetch queries.

• maxXactId

   final DatasetFetchPostParams.Builder maxXactId(Optional<String> maxXactId)

  Alias for calling Builder.maxXactId with maxXactId.orElse(null).

• maxXactId

   final DatasetFetchPostParams.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 DatasetFetchPostParams.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_id returned by a past fetch as the version to reproduce that exact fetch.

• version

   final DatasetFetchPostParams.Builder version(Optional<String> version)

  Alias for calling Builder.version with version.orElse(null).

• version

   final DatasetFetchPostParams.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.

• additionalBodyProperties

   final DatasetFetchPostParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final DatasetFetchPostParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final DatasetFetchPostParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final DatasetFetchPostParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final DatasetFetchPostParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final DatasetFetchPostParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final DatasetFetchPostParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final DatasetFetchPostParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final DatasetFetchPostParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final DatasetFetchPostParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final DatasetFetchPostParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final DatasetFetchPostParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final DatasetFetchPostParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final DatasetFetchPostParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final DatasetFetchPostParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final DatasetFetchPostParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final DatasetFetchPostParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final DatasetFetchPostParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final DatasetFetchPostParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final DatasetFetchPostParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final DatasetFetchPostParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final DatasetFetchPostParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final DatasetFetchPostParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final DatasetFetchPostParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final DatasetFetchPostParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final DatasetFetchPostParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final DatasetFetchPostParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final DatasetFetchPostParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final DatasetFetchPostParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final DatasetFetchPostParams build()

  Returns an immutable instance of DatasetFetchPostParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .datasetId()