Class ObjectSetPreferencesParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class ObjectSetPreferencesParams implements Params
Sets preferences within the given preference set. This is a destructive operation and will replace any existing preferences with the preferences given. If no object exists in the current environment for the given
:collectionand:object_id, Knock will create the object as part of this request. The preference set:idcan be eitherdefaultor atenant.id. Learn more about /preferences/tenant-preferences.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classObjectSetPreferencesParams.BuilderA builder for ObjectSetPreferencesParams.
-
Method Summary
Modifier and Type Method Description final Optional<String>collection()final Optional<String>objectId()final Optional<String>id()final PreferenceSetRequestpreferenceSetRequest()A request to set a preference set for a recipient. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ObjectSetPreferencesParams.BuildertoBuilder()final PreferenceSetRequest_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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ObjectSetPreferencesParams.Builderbuilder()Returns a mutable builder for constructing an instance of ObjectSetPreferencesParams. -
-
Method Detail
-
collection
final Optional<String> collection()
-
preferenceSetRequest
final PreferenceSetRequest preferenceSetRequest()
A request to set a preference set for a recipient.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ObjectSetPreferencesParams.Builder toBuilder()
-
_body
final PreferenceSetRequest _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.
-
builder
final static ObjectSetPreferencesParams.Builder builder()
Returns a mutable builder for constructing an instance of ObjectSetPreferencesParams.
The following fields are required:
.preferenceSetRequest()
-
-
-
-