All Implemented Interfaces:: com.courier.core.Params


public final class JourneyInvokeParams
 implements Params

Invoke a journey run from a journey template.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`JourneyInvokeParams.Builder`	A builder for JourneyInvokeParams.

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<String>`	`templateId()`
`final JourneysInvokeRequest`	`journeysInvokeRequest()`	Request body for invoking a journey.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final JourneyInvokeParams.Builder`	`toBuilder()`
`final JourneysInvokeRequest`	`_body()`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static JourneyInvokeParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of JourneyInvokeParams.

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

- Constructor Detail
- Method Detail
  - templateId
```
 final Optional<String> templateId()
```
  - journeysInvokeRequest
```
 final JourneysInvokeRequest journeysInvokeRequest()
```
    Request body for invoking a journey. Requires either a user identifier or a profile with contact information. User identifiers can be provided via user_id field, or resolved from profile/data objects (user_id, userId, or anonymousId fields).
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _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 JourneyInvokeParams.Builder toBuilder()
```
  - _body
```
 final JourneysInvokeRequest _body()
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static JourneyInvokeParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of JourneyInvokeParams.
    The following fields are required:
    .journeysInvokeRequest()

Class JourneyInvokeParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

templateId

journeysInvokeRequest

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder