Package dm.sent.client

Interface SentClient

  • All Implemented Interfaces:
    
public interface SentClient

    A client for interacting with the Sent REST API synchronously. You can also switch to asynchronous execution via the async method.

    This client performs best when you create a single instance and reuse it for all interactions with the REST API. This is because each client holds its own connection pool and thread pools. Reusing connections and threads reduces latency and saves memory. The client also handles rate limiting per client. This means that creating and using multiple instances at the same time will not respect rate limits.

    The threads and connections that are held will be released automatically if they remain idle. But if you are writing an application that needs to aggressively release unused resources, then you may call close.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public interface SentClient.WithRawResponse

      A view of SentClient that provides access to raw HTTP responses for each method.

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • async

         abstract SentClientAsync async()

        Returns a version of this client that uses asynchronous execution.

        The returned client shares its resources, like its connection pool and thread pools, with this client.

      • users

         abstract UserService users()

        Invite, update, and manage organization users and roles

      • close

         abstract Unit close()

        Closes this client, relinquishing any underlying resources.

        This is purposefully not inherited from AutoCloseable because the client is long-lived and usually should not be synchronously closed via try-with-resources.

        It's also usually not necessary to call this method at all. the default HTTP client automatically releases threads and connections if they remain idle, but if you are writing an application that needs to aggressively release unused resources, then you may call this method.