Class BulkDeleteParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class BulkDeleteParams implements Params
Bulk deletes objects from the specified collection.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBulkDeleteParams.BuilderA builder for BulkDeleteParams.
public final classBulkDeleteParams.BodyRequest body for bulk deleting objects.
-
Method Summary
Modifier and Type Method Description final Optional<String>collection()final List<String>objectIds()List of object IDs to delete. final JsonField<List<String>>_objectIds()Returns the raw JSON value of objectIds. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final BulkDeleteParams.BuildertoBuilder()final BulkDeleteParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static BulkDeleteParams.Builderbuilder()Returns a mutable builder for constructing an instance of BulkDeleteParams. -
-
Method Detail
-
collection
final Optional<String> collection()
-
_objectIds
final JsonField<List<String>> _objectIds()
Returns the raw JSON value of objectIds.
Unlike objectIds, 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 BulkDeleteParams.Builder toBuilder()
-
_body
final BulkDeleteParams.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.
-
builder
final static BulkDeleteParams.Builder builder()
Returns a mutable builder for constructing an instance of BulkDeleteParams.
The following fields are required:
.objectIds()
-
-
-
-