Queue client signatures

The queue client signatures the Java SDK declares, straight from its own declarations.

Signatures, parameters, defaults and return types come straight from the declarations, so they cannot drift from the code. Prose, examples and gotchas live on the hand-written pages this section sits beside.

Generated from sdks/java/src/main/java/org/byteveda/flexiq/*.java.

FlexiQ

`flexiq.ackMessage()`

java

boolean ackMessage(String topic, String name, String messageId)

`flexiq.ackTopic()`

java

boolean ackTopic(String topic, String name, String cursor)

`flexiq.analyzeArguments()`

java

InterceptionAnalysis analyzeArguments(String taskName, Object payload)

`flexiq.awaitJob()`

java

Optional<Job> awaitJob(String jobId, Duration timeout)

`FlexiQ.builder()`

java

static Builder builder()

`flexiq.cancel()`

java

boolean cancel(String jobId)

`flexiq.cancelWorkflow()`

java

void cancelWorkflow(String runId)

`flexiq.close()`

java

void close()

`flexiq.codel()`

java

FlexiQ codel(String queue, long targetMs, long intervalMs)

`flexiq.countPendingByQueue()`

java

long countPendingByQueue(String queue)

`flexiq.dashboard()`

java

DashboardServer dashboard(int port, boolean authEnabled)
DashboardServer dashboard(int port, String token)
DashboardServer dashboard(int port)

`flexiq.declareTopic()`

java

FlexiQ declareTopic(String name, @Nullable Duration retention)
FlexiQ declareTopic(String name)

`flexiq.deleteDead()`

java

boolean deleteDead(String deadId)

`flexiq.deletePeriodic()`

java

boolean deletePeriodic(String name)

`flexiq.deleteSetting()`

java

boolean deleteSetting(String key)

`flexiq.disableMiddleware()`

java

void disableMiddleware(String taskName, String middlewareName)

`flexiq.dispatchOrder()`

java

FlexiQ dispatchOrder(String queue, DispatchOrder order)
@Deprecated FlexiQ dispatchOrder(String queue, String order)

`flexiq.drainWorker()`

java

boolean drainWorker(String workerId)

`flexiq.dryRunRetention()`

java

RetentionPreview dryRunRetention()
RetentionPreview dryRunRetention(@Nullable Retention retention)

`flexiq.effectiveRetention()`

java

Optional<EffectiveRetention> effectiveRetention()

`flexiq.enableMiddleware()`

java

void enableMiddleware(String taskName, String middlewareName)

`flexiq.enqueue()`

java

<T> String enqueue(Task<T> task, T payload, EnqueueOptions options)
<T> String enqueue(Task<T> task, T payload)
String enqueue(String taskName, @Nullable Object payload)

`flexiq.enqueueAll()`

java

<T> List<String> enqueueAll(Task<T> task, List<T> payloads)

`flexiq.enqueueMany()`

java

<T> List<String> enqueueMany(
    Task<T> task,
    List<T> payloads,
    EnqueueOptions options
)
<T> List<String> enqueueMany(Task<T> task, List<T> payloads)

`flexiq.gate()`

java

FlexiQ gate(String taskName, EnqueueGate gate)

`flexiq.getJob()`

java

Optional<Job> getJob(String jobId)

`flexiq.getLockInfo()`

java

Optional<LockInfo> getLockInfo(String name)

`flexiq.getReplayHistory()`

java

List<ReplayEntry> getReplayHistory(String jobId)

`flexiq.getResult()`

java

<R> Optional<R> getResult(String jobId, Class<R> type)
Optional<byte[]> getResult(String jobId)

`flexiq.getTaskLogs()`

java

List<TaskLog> getTaskLogs(String jobId)

`flexiq.getTaskLogsAfter()`

java

List<TaskLog> getTaskLogsAfter(String jobId, String afterId)

`flexiq.getWorkflowChildren()`

java

List<WorkflowRunInfo> getWorkflowChildren(String runId)

`flexiq.getWorkflowDag()`

java

Optional<String> getWorkflowDag(String runId)

`flexiq.getWorkflowRun()`

java

Optional<WorkflowRunInfo> getWorkflowRun(String runId)

`flexiq.intercept()`

java

FlexiQ intercept(Interceptor interceptor)

`flexiq.isCancelRequested()`

java

boolean isCancelRequested(String jobId)

`flexiq.jobDag()`

java

JobDag jobDag(String jobId)

`flexiq.jobErrors()`

java

List<JobError> jobErrors(String jobId)

`flexiq.leaseTopic()`

java

List<TopicMessage> leaseTopic(
    String topic,
    String name,
    int limit,
    Duration visibility
)
List<TopicMessage> leaseTopic(String topic, String name)

`flexiq.listArchivedAfter()`

java

Page<Job> listArchivedAfter(long limit, String after)

`flexiq.listCircuitBreakers()`

java

List<CircuitBreakerState> listCircuitBreakers()

`flexiq.listDead()`

java

List<DeadJob> listDead(long limit, long offset)

`flexiq.listDeadByTask()`

java

List<DeadJob> listDeadByTask(String taskName, long limit, long offset)

`flexiq.listDeclaredTopics()`

java

List<Topic> listDeclaredTopics()

`flexiq.listDisabledMiddleware()`

java

List<String> listDisabledMiddleware(String taskName)

`flexiq.listJobs()`

java

List<Job> listJobs(JobFilter filter)

`flexiq.listJobsAfter()`

java

Page<Job> listJobsAfter(JobFilter filter, String after)

`flexiq.listPausedQueues()`

java

List<String> listPausedQueues()

`flexiq.listPeriodic()`

java

List<PeriodicInfo> listPeriodic()

`flexiq.listSettings()`

java

Map<String, String> listSettings()

`flexiq.listSubscriptions()`

java

List<Subscription> listSubscriptions()
List<Subscription> listSubscriptions(String topic)

`flexiq.listTopics()`

java

List<String> listTopics()

`flexiq.listWorkers()`

java

List<WorkerInfo> listWorkers()

`flexiq.listWorkflowRuns()`

java

List<WorkflowRunInfo> listWorkflowRuns(
    @Nullable String definitionName,
    @Nullable String state,
    long limit,
    long offset
)

`flexiq.lock()`

java

Lock lock(String name, long ttlMs)
Lock lock(String name)

`flexiq.lockInfo()`

java

Optional<LockInfo> lockInfo(String name)

`flexiq.logConsumer()`

java

<T> FlexiQ logConsumer(
    String topic,
    String name,
    Class<T> payloadType,
    Consumer<T> handler,
    LogConsumerOptions options
)
<T> FlexiQ logConsumer(
    String topic,
    String name,
    Class<T> payloadType,
    Consumer<T> handler
)

`flexiq.maxPending()`

java

FlexiQ maxPending(String queue, int cap)

`flexiq.metrics()`

java

List<TaskMetric> metrics(@Nullable String taskName, long sinceMs)

`flexiq.migrate()`

java

MigrationReport migrate()

`flexiq.minContract()`

java

int minContract()

`flexiq.nackMessage()`

java

boolean nackMessage(String topic, String name, String messageId)

`flexiq.namespace()`

java

Optional<String> namespace()

`flexiq.onEvent()`

java

FlexiQ onEvent(EventName name, Consumer<FlexiQEvent> listener)

`flexiq.pausePeriodic()`

java

boolean pausePeriodic(String name)

`flexiq.pauseSubscription()`

java

boolean pauseSubscription(String topic, String name)

`flexiq.predicate()`

java

FlexiQ predicate(String taskName, Predicate predicate)

`flexiq.predicateStats()`

java

PredicateStats predicateStats()

`flexiq.publish()`

java

List<Job> publish(String topic, Object payload, PublishOptions options)
List<Job> publish(String topic, Object payload)

`flexiq.purgeCompleted()`

java

long purgeCompleted(long olderThanMs)

`flexiq.purgeDead()`

java

long purgeDead(long olderThanMs)

`flexiq.purgeDeadByTask()`

java

long purgeDeadByTask(String taskName)

`flexiq.queryTaskLogs()`

java

List<TaskLog> queryTaskLogs(
    @Nullable String taskName,
    @Nullable String level,
    long sinceMs,
    long limit
)

`flexiq.queue()`

java

Queue queue(String name)

`flexiq.readTopic()`

java

List<TopicMessage> readTopic(String topic, String name, int limit)
List<TopicMessage> readTopic(String topic, String name)

`flexiq.registerPeriodic()`

java

long registerPeriodic(PeriodicTask task)

`flexiq.reloadResources()`

java

Map<String, Boolean> reloadResources()
Map<String, Boolean> reloadResources(Collection<String> names)

`flexiq.replayJob()`

java

String replayJob(String jobId)

`flexiq.requestCancel()`

java

boolean requestCancel(String jobId)

`flexiq.requeueJob()`

java

boolean requeueJob(String jobId)

`flexiq.resource()`

java

<T> FlexiQ resource(String name, Function<ResourceContext, T> factory)
<T> FlexiQ resource(
    String name,
    PoolConfig pool,
    Function<ResourceContext, T> factory,
    Consumer<T> dispose
)
<T> FlexiQ resource(
    String name,
    ResourceScope scope,
    Function<ResourceContext, T> factory,
    Consumer<T> dispose
)
<T> FlexiQ resource(
    String name,
    ResourceScope scope,
    Function<ResourceContext, T> factory
)
FlexiQ resource(String name, ResourceDefinition definition)

`flexiq.resourceMetrics()`

java

Map<String, ResourceStat> resourceMetrics()

`flexiq.resumePeriodic()`

java

boolean resumePeriodic(String name)

`flexiq.resumeSubscription()`

java

boolean resumeSubscription(String topic, String name)

`flexiq.retry()`

java

String retry(String deadId)

`flexiq.retryDead()`

java

String retryDead(String deadId)

`flexiq.setMinContract()`

java

void setMinContract(int level)

`flexiq.setProgress()`

java

void setProgress(String jobId, int progress)

`flexiq.setSetting()`

java

void setSetting(String key, String value)

`flexiq.shutdown()`

java

void shutdown()

`flexiq.stats()`

java

QueueStats stats()

`flexiq.statsAllQueues()`

java

Map<String, QueueStats> statsAllQueues()

`flexiq.statsByQueue()`

java

QueueStats statsByQueue(String queue)

`flexiq.submitWorkflow()`

java

WorkflowRun submitWorkflow(
    Workflow workflow,
    Map<String, Object> payloads,
    Map<String, String> traceContext
)
WorkflowRun submitWorkflow(
    Workflow workflow,
    Map<String, Object> payloads
)
WorkflowRun submitWorkflow(Workflow workflow)

`flexiq.subscribe()`

java

<T> FlexiQ subscribe(
    String topic,
    Task<T> task,
    SubscriptionOptions options
)
<T> FlexiQ subscribe(String topic, Task<T> task)

`flexiq.subscribeLog()`

java

void subscribeLog(String topic, String name)

`flexiq.supportsSteps()`

java

boolean supportsSteps()

`flexiq.topicLogStats()`

java

List<TopicLogStat> topicLogStats()

`flexiq.topicStats()`

java

List<TopicStat> topicStats()
List<TopicStat> topicStats(String topic)

`flexiq.tryEnqueue()`

java

<T> Optional<String> tryEnqueue(
    Task<T> task,
    T payload,
    EnqueueOptions options
)
<T> Optional<String> tryEnqueue(Task<T> task, T payload)
Optional<String> tryEnqueue(String taskName, Object payload)

`flexiq.unsubscribe()`

java

boolean unsubscribe(String topic, String name)

`flexiq.use()`

java

FlexiQ use(Middleware middleware)

`flexiq.withLock()`

java

boolean withLock(String name, long ttlMs, Runnable body)

`flexiq.worker()`

java

Worker.Builder worker()

`flexiq.workflowStatus()`

java

Optional<WorkflowStatus> workflowStatus(String runId)

`flexiq.writeTaskLog()`

java

@Deprecated void writeTaskLog(
    String jobId,
    String taskName,
    String level,
    String message,
    @Nullable String extra
)
@Deprecated void writeTaskLog(
    String jobId,
    String taskName,
    String level,
    String message
)
void writeTaskLog(
    String jobId,
    String taskName,
    TaskLogLevel level,
    String message,
    @Nullable String extra
)
void writeTaskLog(
    String jobId,
    String taskName,
    TaskLogLevel level,
    String message
)

FlexiQ.Builder

`builder.autoMigrate()`

java

Builder autoMigrate(boolean autoMigrate)

`builder.backend()`

java

Builder backend(StorageBackend backend)
Builder backend(String backend)

`builder.codec()`

java

Builder codec(PayloadCodec... codecs)
Builder codec(String name, PayloadCodec codec)

`builder.middlewareTimeout()`

java

Builder middlewareTimeout(Duration timeout)

`builder.namespace()`

java

Builder namespace(String namespace)

`builder.open()`

java

FlexiQ open()
FlexiQ open(QueueBackend backend)

`builder.poolSize()`

java

Builder poolSize(int poolSize)

`builder.postgres()`

java

Builder postgres(String url)

`builder.prefix()`

java

Builder prefix(String prefix)

`builder.redis()`

java

Builder redis(String url)

`builder.schema()`

java

Builder schema(String schema)

`builder.serializer()`

java

Builder serializer(Serializer serializer)

`builder.sqlite()`

java

Builder sqlite()
Builder sqlite(String path)

`builder.url()`

java

Builder url(String dsn)

Queue

`queue.isPaused()`

java

boolean isPaused()

`queue.name()`

java

String name()

`queue.pause()`

java

void pause()

`queue.resume()`

java

void resume()