Package com.openai.core
Class ClientOptions.Builder
-
- All Implemented Interfaces:
public final class ClientOptions.Builder
A builder for ClientOptions.
-
-
Method Summary
-
-
Method Detail
-
httpClient
final ClientOptions.Builder httpClient(HttpClient httpClient)
-
checkJacksonVersionCompatibility
final ClientOptions.Builder checkJacksonVersionCompatibility(Boolean checkJacksonVersionCompatibility)
-
jsonMapper
final ClientOptions.Builder jsonMapper(JsonMapper jsonMapper)
-
streamHandlerExecutor
final ClientOptions.Builder streamHandlerExecutor(Executor streamHandlerExecutor)
-
clock
final ClientOptions.Builder clock(Clock clock)
-
baseUrl
final ClientOptions.Builder baseUrl(String baseUrl)
-
responseValidation
final ClientOptions.Builder responseValidation(Boolean responseValidation)
-
timeout
final ClientOptions.Builder timeout(Timeout timeout)
-
maxRetries
final ClientOptions.Builder maxRetries(Integer maxRetries)
-
apiKey
final ClientOptions.Builder apiKey(String apiKey)
-
credential
final ClientOptions.Builder credential(Credential credential)
-
azureServiceVersion
final ClientOptions.Builder azureServiceVersion(AzureOpenAIServiceVersion azureServiceVersion)
-
organization
final ClientOptions.Builder organization(String organization)
-
organization
final ClientOptions.Builder organization(Optional<String> organization)
Alias for calling Builder.organization with
organization.orElse(null)
.
-
project
final ClientOptions.Builder project(String project)
-
project
final ClientOptions.Builder project(Optional<String> project)
Alias for calling Builder.project with
project.orElse(null)
.
-
headers
final ClientOptions.Builder headers(Headers headers)
-
putHeader
final ClientOptions.Builder putHeader(String name, String value)
-
putHeaders
final ClientOptions.Builder putHeaders(String name, Iterable<String> values)
-
putAllHeaders
final ClientOptions.Builder putAllHeaders(Headers headers)
-
putAllHeaders
final ClientOptions.Builder putAllHeaders(Map<String, Iterable<String>> headers)
-
replaceHeaders
final ClientOptions.Builder replaceHeaders(String name, String value)
-
replaceHeaders
final ClientOptions.Builder replaceHeaders(String name, Iterable<String> values)
-
replaceAllHeaders
final ClientOptions.Builder replaceAllHeaders(Headers headers)
-
replaceAllHeaders
final ClientOptions.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)
-
removeHeaders
final ClientOptions.Builder removeHeaders(String name)
-
removeAllHeaders
final ClientOptions.Builder removeAllHeaders(Set<String> names)
-
queryParams
final ClientOptions.Builder queryParams(QueryParams queryParams)
-
queryParams
final ClientOptions.Builder queryParams(Map<String, Iterable<String>> queryParams)
-
putQueryParam
final ClientOptions.Builder putQueryParam(String key, String value)
-
putQueryParams
final ClientOptions.Builder putQueryParams(String key, Iterable<String> values)
-
putAllQueryParams
final ClientOptions.Builder putAllQueryParams(QueryParams queryParams)
-
putAllQueryParams
final ClientOptions.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)
-
replaceQueryParams
final ClientOptions.Builder replaceQueryParams(String key, String value)
-
replaceQueryParams
final ClientOptions.Builder replaceQueryParams(String key, Iterable<String> values)
-
replaceAllQueryParams
final ClientOptions.Builder replaceAllQueryParams(QueryParams queryParams)
-
replaceAllQueryParams
final ClientOptions.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)
-
removeQueryParams
final ClientOptions.Builder removeQueryParams(String key)
-
removeAllQueryParams
final ClientOptions.Builder removeAllQueryParams(Set<String> keys)
-
fromEnv
final ClientOptions.Builder fromEnv()
-
build
final ClientOptions build()
Returns an immutable instance of ClientOptions.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.httpClient() .apiKey()
-
-
-
-