All Implemented Interfaces:


public final class DatasetFetchParams.Builder

A builder for DatasetFetchParams.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final DatasetFetchParams.Builder`	`datasetId(String datasetId)`	Dataset id
`final DatasetFetchParams.Builder`	`limit(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 DatasetFetchParams.Builder`	`limit(Long limit)`	Alias for Builder.limit.
`final DatasetFetchParams.Builder`	`limit(Optional<Long> limit)`	Alias for calling Builder.limit with `limit.orElse(null)`.
`final DatasetFetchParams.Builder`	`maxRootSpanId(String maxRootSpanId)`	DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests.
`final DatasetFetchParams.Builder`	`maxRootSpanId(Optional<String> maxRootSpanId)`	Alias for calling Builder.maxRootSpanId with `maxRootSpanId.orElse(null)`.
`final DatasetFetchParams.Builder`	`maxXactId(String maxXactId)`	DEPRECATION NOTICE: The manually-constructed pagination cursor is deprecated in favor of the explicit 'cursor' returned by object fetch requests.
`final DatasetFetchParams.Builder`	`maxXactId(Optional<String> maxXactId)`	Alias for calling Builder.maxXactId with `maxXactId.orElse(null)`.
`final DatasetFetchParams.Builder`	`version(String version)`	Retrieve a snapshot of events from a past timeThe version id is essentially a filter on the latest event transaction id.
`final DatasetFetchParams.Builder`	`version(Optional<String> version)`	Alias for calling Builder.version with `version.orElse(null)`.
`final DatasetFetchParams.Builder`	`additionalHeaders(Headers additionalHeaders)`
`final DatasetFetchParams.Builder`	`additionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final DatasetFetchParams.Builder`	`putAdditionalHeader(String name, String value)`
`final DatasetFetchParams.Builder`	`putAdditionalHeaders(String name, Iterable<String> values)`
`final DatasetFetchParams.Builder`	`putAllAdditionalHeaders(Headers additionalHeaders)`
`final DatasetFetchParams.Builder`	`putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final DatasetFetchParams.Builder`	`replaceAdditionalHeaders(String name, String value)`
`final DatasetFetchParams.Builder`	`replaceAdditionalHeaders(String name, Iterable<String> values)`
`final DatasetFetchParams.Builder`	`replaceAllAdditionalHeaders(Headers additionalHeaders)`
`final DatasetFetchParams.Builder`	`replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)`
`final DatasetFetchParams.Builder`	`removeAdditionalHeaders(String name)`
`final DatasetFetchParams.Builder`	`removeAllAdditionalHeaders(Set<String> names)`
`final DatasetFetchParams.Builder`	`additionalQueryParams(QueryParams additionalQueryParams)`
`final DatasetFetchParams.Builder`	`additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final DatasetFetchParams.Builder`	`putAdditionalQueryParam(String key, String value)`
`final DatasetFetchParams.Builder`	`putAdditionalQueryParams(String key, Iterable<String> values)`
`final DatasetFetchParams.Builder`	`putAllAdditionalQueryParams(QueryParams additionalQueryParams)`
`final DatasetFetchParams.Builder`	`putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final DatasetFetchParams.Builder`	`replaceAdditionalQueryParams(String key, String value)`
`final DatasetFetchParams.Builder`	`replaceAdditionalQueryParams(String key, Iterable<String> values)`
`final DatasetFetchParams.Builder`	`replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)`
`final DatasetFetchParams.Builder`	`replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)`
`final DatasetFetchParams.Builder`	`removeAdditionalQueryParams(String key)`
`final DatasetFetchParams.Builder`	`removeAllAdditionalQueryParams(Set<String> keys)`
`final DatasetFetchParams`	`build()`	Returns an immutable instance of DatasetFetchParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - datasetId
```
 final DatasetFetchParams.Builder datasetId(String datasetId)
```
    Dataset id
  - limit
```
 final DatasetFetchParams.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 DatasetFetchParams.Builder limit(Long limit)
```
    Alias for Builder.limit.
    This unboxed primitive overload exists for backwards compatibility.
  - limit
```
 final DatasetFetchParams.Builder limit(Optional<Long> limit)
```
    Alias for calling Builder.limit with limit.orElse(null).
  - maxRootSpanId
```
 final DatasetFetchParams.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 DatasetFetchParams.Builder maxRootSpanId(Optional<String> maxRootSpanId)
```
    Alias for calling Builder.maxRootSpanId with maxRootSpanId.orElse(null).
  - maxXactId
```
 final DatasetFetchParams.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 DatasetFetchParams.Builder maxXactId(Optional<String> maxXactId)
```
    Alias for calling Builder.maxXactId with maxXactId.orElse(null).
  - version
```
 final DatasetFetchParams.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 DatasetFetchParams.Builder version(Optional<String> version)
```
    Alias for calling Builder.version with version.orElse(null).
  - additionalHeaders
```
 final DatasetFetchParams.Builder additionalHeaders(Headers additionalHeaders)
```
  - additionalHeaders
```
 final DatasetFetchParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - putAdditionalHeader
```
 final DatasetFetchParams.Builder putAdditionalHeader(String name, String value)
```
  - putAdditionalHeaders
```
 final DatasetFetchParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
```
  - putAllAdditionalHeaders
```
 final DatasetFetchParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
```
  - putAllAdditionalHeaders
```
 final DatasetFetchParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - replaceAdditionalHeaders
```
 final DatasetFetchParams.Builder replaceAdditionalHeaders(String name, String value)
```
  - replaceAdditionalHeaders
```
 final DatasetFetchParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
```
  - replaceAllAdditionalHeaders
```
 final DatasetFetchParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
```
  - replaceAllAdditionalHeaders
```
 final DatasetFetchParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
```
  - removeAdditionalHeaders
```
 final DatasetFetchParams.Builder removeAdditionalHeaders(String name)
```
  - removeAllAdditionalHeaders
```
 final DatasetFetchParams.Builder removeAllAdditionalHeaders(Set<String> names)
```
  - additionalQueryParams
```
 final DatasetFetchParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
```
  - additionalQueryParams
```
 final DatasetFetchParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - putAdditionalQueryParam
```
 final DatasetFetchParams.Builder putAdditionalQueryParam(String key, String value)
```
  - putAdditionalQueryParams
```
 final DatasetFetchParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
```
  - putAllAdditionalQueryParams
```
 final DatasetFetchParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
```
  - putAllAdditionalQueryParams
```
 final DatasetFetchParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - replaceAdditionalQueryParams
```
 final DatasetFetchParams.Builder replaceAdditionalQueryParams(String key, String value)
```
  - replaceAdditionalQueryParams
```
 final DatasetFetchParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
```
  - replaceAllAdditionalQueryParams
```
 final DatasetFetchParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
```
  - replaceAllAdditionalQueryParams
```
 final DatasetFetchParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
```
  - removeAdditionalQueryParams
```
 final DatasetFetchParams.Builder removeAdditionalQueryParams(String key)
```
  - removeAllAdditionalQueryParams
```
 final DatasetFetchParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
```
  - build
```
 final DatasetFetchParams build()
```
    Returns an immutable instance of DatasetFetchParams.
    Further updates to this Builder will not mutate the returned instance.
    The following fields are required:
    .datasetId()

Class DatasetFetchParams.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

datasetId

limit

limit

limit

maxRootSpanId

maxRootSpanId

maxXactId

maxXactId

version

version

additionalHeaders

additionalHeaders

putAdditionalHeader

putAdditionalHeaders

putAllAdditionalHeaders

putAllAdditionalHeaders

replaceAdditionalHeaders

replaceAdditionalHeaders

replaceAllAdditionalHeaders

replaceAllAdditionalHeaders

removeAdditionalHeaders

removeAllAdditionalHeaders

additionalQueryParams

additionalQueryParams

putAdditionalQueryParam

putAdditionalQueryParams

putAllAdditionalQueryParams

putAllAdditionalQueryParams

replaceAdditionalQueryParams

replaceAdditionalQueryParams

replaceAllAdditionalQueryParams

replaceAllAdditionalQueryParams

removeAdditionalQueryParams

removeAllAdditionalQueryParams

build