Interface OpenlayerClientAsync
-
- All Implemented Interfaces:
public interface OpenlayerClientAsyncA client for interacting with the Openlayer 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 interfaceOpenlayerClientAsync.WithRawResponseA view of OpenlayerClientAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract OpenlayerClientsync()Returns a version of this client that uses synchronous execution. abstract OpenlayerClientAsync.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract OpenlayerClientAsyncwithOptions(Consumer<ClientOptions.Builder> modifier)Returns a view of this service with the given option modifications applied. abstract ProjectServiceAsyncprojects()abstract WorkspaceServiceAsyncworkspaces()abstract CommitServiceAsynccommits()abstract InferencePipelineServiceAsyncinferencePipelines()abstract StorageServiceAsyncstorage()abstract TestServiceAsynctests()abstract Unitclose()Closes this client, relinquishing any underlying resources. -
-
Method Detail
-
sync
abstract OpenlayerClient 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 OpenlayerClientAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract OpenlayerClientAsync withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
projects
abstract ProjectServiceAsync projects()
-
workspaces
abstract WorkspaceServiceAsync workspaces()
-
commits
abstract CommitServiceAsync commits()
-
inferencePipelines
abstract InferencePipelineServiceAsync inferencePipelines()
-
storage
abstract StorageServiceAsync storage()
-
tests
abstract TestServiceAsync tests()
-
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.
-
-
-
-