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

Client for interacting with OCI Queue Service messages and operations.

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

Reading messages (get_messages/3)
Writing messages (put_messages/4)
Deleting messages (delete_message/4, delete_messages/4)
Updating messages (update_message/5, update_messages/4)
Retrieving queue stats (get_stats/3)
Listing channels (list_channels/3)

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

create(client, opts \\ [])

Creates a new QueueClient instance.

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

Deletes a single message from a queue.

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

Deletes multiple messages from a queue in a single request.

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

Retrieves messages from a queue.

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

Retrieves statistics for a queue.

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

Lists channels in a queue.

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

Puts messages into a queue.

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.

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

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 \\ [])

@spec create(ExOciSdk.Client.t(), ExOciSdk.Queue.Types.queue_client_create_opts()) ::
  t()

Creates a new QueueClient instance.

Parameters

client - Base sdk client, see ExOciSdk.Client.t/0
opts - Options list, see ExOciSdk.Queue.Types.queue_client_create_opts/0

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

@spec delete_message(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.message_receipt(),
  ExOciSdk.Queue.Types.queue_default_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Deletes a single message from a queue.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
message_receipt - Receipt of the message to delete
opts - Options list, see ExOciSdk.Queue.Types.queue_default_opts/0

Returns

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

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

@spec delete_messages(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.delete_messages_input(),
  ExOciSdk.Queue.Types.queue_default_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Deletes multiple messages from a queue in a single request.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
delete_messages_input - input of messages to delete, see ExOciSdk.Queue.Types.delete_messages_input/0
opts - Options list, see ExOciSdk.Queue.Types.queue_default_opts/0

Returns

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

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

@spec get_messages(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.get_messages_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Retrieves messages from a queue.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
opts - Options list, see ExOciSdk.Queue.Types.get_messages_opts/0

Returns

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

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

@spec get_stats(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.get_stats_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Retrieves statistics for a queue.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
opts - Options list, see ExOciSdk.Queue.Types.get_stats_opts/0

Returns

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

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

@spec list_channels(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.list_channels_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Lists channels in a queue.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
opts - Options list, see ExOciSdk.Queue.Types.list_channels_opts/0

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 \\ [])

@spec put_messages(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.put_messages_input(),
  ExOciSdk.Queue.Types.queue_default_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Puts messages into a queue.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
put_messages_input - Message input, see ExOciSdk.Queue.Types.put_messages_input/0
opts - Options list, see ExOciSdk.Queue.Types.queue_default_opts/0

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 \\ [])

@spec update_message(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.message_receipt(),
  ExOciSdk.Queue.Types.update_message_input(),
  ExOciSdk.Queue.Types.queue_default_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Updates a single message's visibility timeout.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
message_receipt - Receipt of the message to update
update_message_input - Update input, see ExOciSdk.Queue.Types.update_message_input/0
opts - Options list, see ExOciSdk.Queue.Types.queue_default_opts/0

Returns

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

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

@spec update_messages(
  t(),
  ExOciSdk.Queue.Types.queue_id(),
  ExOciSdk.Queue.Types.update_messages_input(),
  ExOciSdk.Queue.Types.queue_default_opts()
) ::
  {:ok, ExOciSdk.Response.Types.response_success()}
  | {:error, ExOciSdk.Response.Types.response_error()}

Updates visibility timeout for multiple messages in a single request.

Parameters

queue_client - Queue client instance t/0
queue_id - Target queue identifier
update_messages_input - Update input, see ExOciSdk.Queue.Types.update_messages_input/0
opts - Options list, see ExOciSdk.Queue.Types.queue_default_opts/0

Returns

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