Interface KnockClient
-
- All Implemented Interfaces:
public interface KnockClientA client for interacting with the Knock 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 interfaceKnockClient.WithRawResponseA view of KnockClient that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract KnockClientAsyncasync()Returns a version of this client that uses asynchronous execution. abstract KnockClient.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract SharedServiceshared()abstract RecipientServicerecipients()abstract UserServiceusers()abstract ObjectServiceobjects()abstract TenantServicetenants()abstract BulkOperationServicebulkOperations()abstract MessageServicemessages()abstract ProviderServiceproviders()abstract IntegrationServiceintegrations()abstract WorkflowServiceworkflows()abstract ScheduleServiceschedules()abstract ChannelServicechannels()abstract AudienceServiceaudiences()abstract Unitclose()Closes this client, relinquishing any underlying resources. -
-
Method Detail
-
async
abstract KnockClientAsync 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.
-
withRawResponse
abstract KnockClient.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
shared
abstract SharedService shared()
-
recipients
abstract RecipientService recipients()
-
users
abstract UserService users()
-
objects
abstract ObjectService objects()
-
tenants
abstract TenantService tenants()
-
bulkOperations
abstract BulkOperationService bulkOperations()
-
messages
abstract MessageService messages()
-
providers
abstract ProviderService providers()
-
integrations
abstract IntegrationService integrations()
-
workflows
abstract WorkflowService workflows()
-
schedules
abstract ScheduleService schedules()
-
channels
abstract ChannelService channels()
-
audiences
abstract AudienceService audiences()
-
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.
-
-
-
-