Package com.courier.models.journeys
Class JourneyRetrieveParams
-
- All Implemented Interfaces:
-
com.courier.core.Params
public final class JourneyRetrieveParams implements Params
Fetch a journey by id. Pass
?version=draft(defaultpublished) to retrieve the working draft, or?version=vNto retrieve a historical version.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classJourneyRetrieveParams.BuilderA builder for JourneyRetrieveParams.
-
Method Summary
Modifier and Type Method Description final Optional<String>templateId()final Optional<String>version()Version selector: draft,published(default), orvN.final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final JourneyRetrieveParams.BuildertoBuilder()final String_pathParam(Integer index)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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static JourneyRetrieveParamsnone()final static JourneyRetrieveParams.Builderbuilder()Returns a mutable builder for constructing an instance of JourneyRetrieveParams. -
-
Method Detail
-
templateId
final Optional<String> templateId()
-
_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 JourneyRetrieveParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_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.
-
none
final static JourneyRetrieveParams none()
-
builder
final static JourneyRetrieveParams.Builder builder()
Returns a mutable builder for constructing an instance of JourneyRetrieveParams.
-
-
-
-