Package app.knock.api.models.schedules
Class ScheduleListParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class ScheduleListParams implements Params
Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classScheduleListParams.BuilderA builder for ScheduleListParams.
-
Method Summary
Modifier and Type Method Description final Stringworkflow()Filter by workflow key. final Optional<String>after()The cursor to fetch entries after. final Optional<String>before()The cursor to fetch entries before. final Optional<Long>pageSize()The number of items per page. final Optional<List<String>>recipients()Filter by recipient IDs. final Optional<String>tenant()Filter by tenant ID. final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ScheduleListParams.BuildertoBuilder()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 ScheduleListParams.Builderbuilder()Returns a mutable builder for constructing an instance of ScheduleListParams. -
-
Method Detail
-
recipients
final Optional<List<String>> recipients()
Filter by recipient IDs.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ScheduleListParams.Builder toBuilder()
-
_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 ScheduleListParams.Builder builder()
Returns a mutable builder for constructing an instance of ScheduleListParams.
The following fields are required:
.workflow()
-
-
-
-