Interface CourierClientAsync
-
- All Implemented Interfaces:
public interface CourierClientAsyncA client for interacting with the Courier REST API asynchronously. You can also switch to synchronous execution via the sync 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 interfaceCourierClientAsync.WithRawResponseA view of CourierClientAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract CourierClientsync()Returns a version of this client that uses synchronous execution. abstract CourierClientAsync.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract CourierClientAsyncwithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. abstract SendServiceAsyncsend()abstract AudienceServiceAsyncaudiences()abstract AuditEventServiceAsyncauditEvents()abstract AuthServiceAsyncauth()abstract AutomationServiceAsyncautomations()abstract JourneyServiceAsyncjourneys()abstract BrandServiceAsyncbrands()abstract BulkServiceAsyncbulk()abstract InboundServiceAsyncinbound()abstract ListServiceAsynclists()abstract MessageServiceAsyncmessages()abstract RequestServiceAsyncrequests()abstract NotificationServiceAsyncnotifications()abstract ProfileServiceAsyncprofiles()abstract TenantServiceAsynctenants()abstract TranslationServiceAsynctranslations()abstract UserServiceAsyncusers()abstract Unitclose()Closes this client, relinquishing any underlying resources. -
-
Method Detail
-
sync
abstract CourierClient sync()
Returns a version of this client that uses synchronous execution.
The returned client shares its resources, like its connection pool and thread pools, with this client.
-
withRawResponse
abstract CourierClientAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract CourierClientAsync withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
send
abstract SendServiceAsync send()
-
audiences
abstract AudienceServiceAsync audiences()
-
auditEvents
abstract AuditEventServiceAsync auditEvents()
-
auth
abstract AuthServiceAsync auth()
-
automations
abstract AutomationServiceAsync automations()
-
journeys
abstract JourneyServiceAsync journeys()
-
brands
abstract BrandServiceAsync brands()
-
bulk
abstract BulkServiceAsync bulk()
-
inbound
abstract InboundServiceAsync inbound()
-
lists
abstract ListServiceAsync lists()
-
messages
abstract MessageServiceAsync messages()
-
requests
abstract RequestServiceAsync requests()
-
notifications
abstract NotificationServiceAsync notifications()
-
profiles
abstract ProfileServiceAsync profiles()
-
tenants
abstract TenantServiceAsync tenants()
-
translations
abstract TranslationServiceAsync translations()
-
users
abstract UserServiceAsync users()
-
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.
-
-
-
-