All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ObjectSetParams
 implements Params
                    
```
Creates a new object or updates an existing one in the specified collection. This operation is used to identify objects with their properties, as well as optional preferences and channel data.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectSetParams.Builder`	A builder for ObjectSetParams.
`public final class`	`ObjectSetParams.Body`	A set of parameters to set an object with. Does not include the object id or collection.

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>`	`collection()`
`final Optional<String>`	`id()`
`final Optional<InlineChannelDataRequest>`	`channelData()`	A request to set channel data for a type of channel inline.
`final Optional<String>`	`locale()`	The locale of the object.
`final Optional<InlinePreferenceSetRequest>`	`preferences()`	Inline set preferences for a recipient, where the key is the preference set id.
`final Optional<String>`	`timezone()`	The timezone of the object.
`final JsonField<InlineChannelDataRequest>`	`_channelData()`	Returns the raw JSON value of channelData.
`final JsonField<String>`	`_locale()`	Returns the raw JSON value of locale.
`final JsonField<InlinePreferenceSetRequest>`	`_preferences()`	Returns the raw JSON value of preferences.
`final JsonField<String>`	`_timezone()`	Returns the raw JSON value of timezone.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ObjectSetParams.Builder`	`toBuilder()`
`final ObjectSetParams.Body`	`_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 ObjectSetParams`	`none()`
`final static ObjectSetParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectSetParams.

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

- Constructor Detail
- Method Detail
  - collection
```
 final Optional<String> collection()
```
  - id
```
 final Optional<String> id()
```
  - channelData
```
 final Optional<InlineChannelDataRequest> channelData()
```
    A request to set channel data for a type of channel inline.
  - locale
```
 final Optional<String> locale()
```
    The locale of the object. Used for /concepts/translations.
  - preferences
```
 final Optional<InlinePreferenceSetRequest> preferences()
```
    Inline set preferences for a recipient, where the key is the preference set id.
  - timezone
```
 final Optional<String> timezone()
```
    The timezone of the object. Must be a valid tz database time zone * string. Used for /concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients.
  - _channelData
```
 final JsonField<InlineChannelDataRequest> _channelData()
```
    Returns the raw JSON value of channelData.
    Unlike channelData, this method doesn't throw if the JSON field has an unexpected type.
  - _locale
```
 final JsonField<String> _locale()
```
    Returns the raw JSON value of locale.
    Unlike locale, this method doesn't throw if the JSON field has an unexpected type.
  - _preferences
```
 final JsonField<InlinePreferenceSetRequest> _preferences()
```
    Returns the raw JSON value of preferences.
    Unlike preferences, this method doesn't throw if the JSON field has an unexpected type.
  - _timezone
```
 final JsonField<String> _timezone()
```
    Returns the raw JSON value of timezone.
    Unlike timezone, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ObjectSetParams.Builder toBuilder()
```
  - _body
```
 final ObjectSetParams.Body _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()
```
  - none
```
 final static ObjectSetParams none()
```
  - builder
```
 final static ObjectSetParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ObjectSetParams.

Class ObjectSetParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

collection

id

channelData

locale

preferences

timezone

_channelData

_locale

_preferences

_timezone

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder