V1RetrieveParams

All Implemented Interfaces:

dev.case.api.core.Params
```
public final class V1RetrieveParams
 implements Params
                    
```
Returns customer-facing usage metrics and costs for the requested period. Supports summary totals and daily buckets for timestamped usage sources. Vault storage is intentionally omitted from totals because it is not yet periodized for arbitrary windows.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`V1RetrieveParams.Builder`	A builder for V1RetrieveParams.
`public final class`	`V1RetrieveParams.Granularity`	Whether to return period totals only or include daily buckets.

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 Optional<V1RetrieveParams.Granularity>`	`granularity()`	Whether to return period totals only or include daily buckets.
`final Optional<OffsetDateTime>`	`periodEnd()`	Period end date.
`final Optional<OffsetDateTime>`	`periodStart()`	Period start date.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final V1RetrieveParams.Builder`	`toBuilder()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static V1RetrieveParams`	`none()`
`final static V1RetrieveParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of V1RetrieveParams.

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

- Constructor Detail
- Method Detail
  - granularity
```
 final Optional<V1RetrieveParams.Granularity> granularity()
```
    Whether to return period totals only or include daily buckets.
  - periodEnd
```
 final Optional<OffsetDateTime> periodEnd()
```
    Period end date. Defaults to now.
  - periodStart
```
 final Optional<OffsetDateTime> periodStart()
```
    Period start date. Defaults to the start of the current calendar month.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final V1RetrieveParams.Builder toBuilder()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static V1RetrieveParams none()
```
  - builder
```
 final static V1RetrieveParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of V1RetrieveParams.