View Source ExOciSdk.Queue.QueueClient (ex_oci_sdk v0.2.0)

Client for interacting with OCI Queue Service messages and operations.

This module handles message-level operations for OCI Queues, including:

For queue administration operations like creating, deleting, and updating queues, see ExOciSdk.Queue.QueueAdminClient.

Summary

Types

t()

Queue client structure containing the base client and service configuration.

Functions

Creates a new QueueClient instance.

Deletes multiple messages from a queue in a single request.

Retrieves messages from a queue.

Retrieves statistics for a queue.

Returns defaults service configuration settings ExOciSdk.Queue.Types.service_settings/0.

Updates visibility timeout for multiple messages in a single request.

Types

t()

@type t() :: %ExOciSdk.Queue.QueueClient{
  client: ExOciSdk.Client.t(),
  service_endpoint: String.t() | nil
}

Queue client structure containing the base client and service configuration.

  • :client - The base OCI client instance, see ExOciSdk.Client.t/0
  • :service_endpoint - Optional custom service endpoint URL

Functions

create(client, opts \\ [])

Creates a new QueueClient instance.

Parameters

delete_message(queue_client, queue_id, message_receipt, opts \\ [])

Deletes a single message from a queue.

Parameters

Returns

  • {:ok, response} - On success
  • {:error, reason} - On failure

delete_messages(queue_client, queue_id, delete_messages_input, opts \\ [])

Deletes multiple messages from a queue in a single request.

Parameters

Returns

  • {:ok, response} - On success
  • {:error, reason} - On failure

get_messages(queue_client, queue_id, opts \\ [])

Retrieves messages from a queue.

Parameters

Returns

  • {:ok, response} - On success, where response contains the messages
  • {:error, reason} - On failure

get_stats(queue_client, queue_id, opts \\ [])

Retrieves statistics for a queue.

Parameters

Returns

  • {:ok, response} - On success, where response contains queue statistics
  • {:error, reason} - On failure

list_channels(queue_client, queue_id, opts \\ [])

Lists channels in a queue.

Parameters

Returns

  • {:ok, response} - On success, where response contains list of channels
  • {:error, reason} - On failure

put_messages(queue_client, queue_id, put_messages_input, opts \\ [])

Puts messages into a queue.

Parameters

Returns

  • {:ok, response} - On success
  • {:error, reason} - On failure

service_settings()

@spec service_settings() :: ExOciSdk.Queue.Types.service_settings()

Returns defaults service configuration settings ExOciSdk.Queue.Types.service_settings/0.

update_message(queue_client, queue_id, message_receipt, update_message_input, opts \\ [])

Updates a single message's visibility timeout.

Parameters

Returns

  • {:ok, response} - On success
  • {:error, reason} - On failure

update_messages(queue_client, queue_id, update_messages_input, opts \\ [])

Updates visibility timeout for multiple messages in a single request.

Parameters

Returns

  • {:ok, response} - On success
  • {:error, reason} - On failure