BulkDeleteParams 1.0.0 API

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 class`	`BulkDeleteParams.Builder`	A builder for BulkDeleteParams.
`public final class`	`BulkDeleteParams.Body`	Request body for bulk deleting objects.

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 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.Builder`	`toBuilder()`
`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.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BulkDeleteParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BulkDeleteParams.

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()
```
  - objectIds
```
 final List<String> objectIds()
```
    List of object IDs to delete.
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BulkDeleteParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BulkDeleteParams.
    The following fields are required:
    .objectIds()