nv_ingest_api.util.service_clients package

Subpackages

• nv_ingest_api.util.service_clients.kafka package
  • Module contents
• nv_ingest_api.util.service_clients.redis package
  • Submodules
  • nv_ingest_api.util.service_clients.redis.redis_client module
    • RedisClient
      • fetch_message()
      • get_client()
      • max_retries
      • ping()
      • submit_message()
  • Module contents
• nv_ingest_api.util.service_clients.rest package
  • Submodules
  • nv_ingest_api.util.service_clients.rest.rest_client module
    • RestClient
      • fetch_message()
      • get_client()
      • max_retries
      • perform_retry_backoff()
      • ping()
      • submit_message()
  • Module contents

Submodules

nv_ingest_api.util.service_clients.client_base module

class nv_ingest_api.util.service_clients.client_base.FetchMode(value)

Bases: Enum

An enumeration.

CACHE_BEFORE_DELETE = 3

DESTRUCTIVE = 1

NON_DESTRUCTIVE = 2

class nv_ingest_api.util.service_clients.client_base.MessageBrokerClientBase(

host: str,

port: int,

db: int = 0,

max_retries: int = 0,

max_backoff: int = 32,

connection_timeout: int = 300,

max_pool_size: int = 128,

use_ssl: bool = False,

)

Bases: ABC

Abstract base class for a messaging client to interface with various messaging systems.

Provides a standard interface for sending and receiving messages with connection management and retry logic.

abstract fetch_message(

job_index: str,

timeout: Tuple[int, float] = (100, None),

override_fetch_mode: FetchMode | None = None,

) → ResponseSchema

Fetches a message from the specified queue with retries on failure.

Parameters:

• job_index (str) – The index of the job to fetch the message for.

• timeout (float) – The timeout in seconds for blocking until a message is available.

• override_fetch_mode – Optional; overrides the default fetch mode.

Returns:

The fetched message, or None if no message could be fetched.

abstract get_client()

Returns the client instance, reconnecting if necessary.

Returns:

The client instance.

abstract ping() → bool

Checks if the server is responsive.

Returns:

True if the server responds to a ping, False otherwise.

abstract submit_message(

channel_name: str,

message: str,

for_nv_ingest=False,

) → ResponseSchema

Submits a message to a specified queue with retries on failure.

Parameters:

• channel_name (str) – The name of the queue to submit the message to.

• message (str) – The message to submit.

• for_nv_ingest (bool) – Whether the message is for NV Ingest.

Module contents