Skip to main content
Use client.queues() to inspect pending message and operation queues for an instance. Common fields on every call:
FieldTypeRequiredDescription
instanceIdstringYesInstance ID.
instanceTokenstringYesInstance token.

​
client.queues().listMessages(...)

Lists the pending message queue. 
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().listMessages(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with count and messages[] (id, type, status, etc.).

​
client.queues().removeMessage(...)

Removes one specific message from the queue. 
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().removeMessage(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with message_id, count, details.

​
client.queues().purgeMessages(...)

Removes all pending items from the message queue. Use only when you are sure.
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().purgeMessages(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with removed count.

​
client.queues().listOperations(...)

Lists the pending operation queue. 
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().listOperations(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with pending operations queue.

​
client.queues().removeOperation(...)

Removes one specific operation from the queue. 
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().removeOperation(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with message_id, count, details.

​
client.queues().purgeOperations(...)

Removes all pending items from the operation queue. Use only when you are sure.
var options = InstanceRequestOptions.builder().instanceToken(instanceToken).build();
JsonNode result = client.queues().purgeOperations(GenericInstanceRequest.builder()
    .instanceId(instanceId)
    .instanceToken(instanceToken)
    .build());
// Example: tipagem estrita com DTOs publicados quando disponivel
Return: envelope { code, success, data } with removed count.