com.oracle.bmc.generativeai

Class GenerativeAiClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.generativeai.GenerativeAiClient

All Implemented Interfaces:

GenerativeAi, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public class GenerativeAiClient
extends BaseSyncClient
implements GenerativeAi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerativeAiClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for GenerativeAi.

Constructor Summary

Constructors

Constructor and Description
GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static GenerativeAiClient.Builder	builder() Create a builder for this client.
ChangeDedicatedAiClusterCompartmentResponse	changeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request) Moves a dedicated AI cluster into a different compartment within the same tenancy.
ChangeEndpointCompartmentResponse	changeEndpointCompartment(ChangeEndpointCompartmentRequest request) Moves an endpoint into a different compartment within the same tenancy.
ChangeModelCompartmentResponse	changeModelCompartment(ChangeModelCompartmentRequest request) Moves a custom model into a different compartment.
void	close()
CreateDedicatedAiClusterResponse	createDedicatedAiCluster(CreateDedicatedAiClusterRequest request) Creates a dedicated AI cluster.
CreateEndpointResponse	createEndpoint(CreateEndpointRequest request) Creates an endpoint.
CreateModelResponse	createModel(CreateModelRequest request) Creates a custom model by fine-tuning a base model with your own dataset.
DeleteDedicatedAiClusterResponse	deleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request) Deletes a dedicated AI cluster.
DeleteEndpointResponse	deleteEndpoint(DeleteEndpointRequest request) Deletes an endpoint.
DeleteModelResponse	deleteModel(DeleteModelRequest request) Deletes a custom model.
String	getClientCommonLibraryVersion()
GetDedicatedAiClusterResponse	getDedicatedAiCluster(GetDedicatedAiClusterRequest request) Gets information about a dedicated AI cluster.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetEndpointResponse	getEndpoint(GetEndpointRequest request) Gets information about an endpoint.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetModelResponse	getModel(GetModelRequest request) Gets information about a custom model.
GenerativeAiPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GenerativeAiWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the details of a work request.
ListDedicatedAiClustersResponse	listDedicatedAiClusters(ListDedicatedAiClustersRequest request) Lists the dedicated AI clusters in a specific compartment.
ListEndpointsResponse	listEndpoints(ListEndpointsRequest request) Lists the endpoints of a specific compartment.
ListModelsResponse	listModels(ListModelsRequest request) Lists the models in a specific compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Lists the errors for a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Lists the logs for a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateDedicatedAiClusterResponse	updateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request) Updates a dedicated AI cluster.
UpdateEndpointResponse	updateEndpoint(UpdateEndpointRequest request) Updates the properties of an endpoint.
UpdateModelResponse	updateModel(UpdateModelRequest request) Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.generativeai.GenerativeAi

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GenerativeAi.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

GenerativeAiClient

@Deprecated
public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

GenerativeAiClient

@Deprecated
public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

GenerativeAiClient

@Deprecated
public GenerativeAiClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

GenerativeAiClient

@Deprecated
public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GenerativeAiClient

@Deprecated
public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GenerativeAiClient

@Deprecated
public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

GenerativeAiClient

@Deprecated
public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

GenerativeAiClient

@Deprecated
public GenerativeAiClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory,
                                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                      List<ClientConfigurator> additionalClientConfigurators,
                                      String endpoint,
                                      ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - GenerativeAiClient.Builder.executorService

Method Detail

builder

public static GenerativeAiClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GenerativeAi

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface GenerativeAi

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GenerativeAi

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface GenerativeAi

Parameters:

regionId - The public region ID.

changeDedicatedAiClusterCompartment

public ChangeDedicatedAiClusterCompartmentResponse changeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request)

Description copied from interface: GenerativeAi

Moves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeDedicatedAiClusterCompartment in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeEndpointCompartment

public ChangeEndpointCompartmentResponse changeEndpointCompartment(ChangeEndpointCompartmentRequest request)

Description copied from interface: GenerativeAi

Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeEndpointCompartment in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeModelCompartment

public ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)

Description copied from interface: GenerativeAi

Moves a custom model into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeModelCompartment in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDedicatedAiCluster

public CreateDedicatedAiClusterResponse createDedicatedAiCluster(CreateDedicatedAiClusterRequest request)

Description copied from interface: GenerativeAi

Creates a dedicated AI cluster.

Specified by:

createDedicatedAiCluster in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createEndpoint

public CreateEndpointResponse createEndpoint(CreateEndpointRequest request)

Description copied from interface: GenerativeAi

Creates an endpoint.

The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.

Specified by:

createEndpoint in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createModel

public CreateModelResponse createModel(CreateModelRequest request)

Description copied from interface: GenerativeAi

Creates a custom model by fine-tuning a base model with your own dataset. You can create a new custom models or create a new version of existing custom model..

The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.

Specified by:

createModel in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDedicatedAiCluster

public DeleteDedicatedAiClusterResponse deleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request)

Description copied from interface: GenerativeAi

Deletes a dedicated AI cluster.

You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.

Specified by:

deleteDedicatedAiCluster in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteEndpoint

public DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest request)

Description copied from interface: GenerativeAi

Deletes an endpoint.

Specified by:

deleteEndpoint in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteModel

public DeleteModelResponse deleteModel(DeleteModelRequest request)

Description copied from interface: GenerativeAi

Deletes a custom model. A model shouldn’t be deleted if there’s one or more active endpoints associated with that model.

Specified by:

deleteModel in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDedicatedAiCluster

public GetDedicatedAiClusterResponse getDedicatedAiCluster(GetDedicatedAiClusterRequest request)

Description copied from interface: GenerativeAi

Gets information about a dedicated AI cluster.

Specified by:

getDedicatedAiCluster in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEndpoint

public GetEndpointResponse getEndpoint(GetEndpointRequest request)

Description copied from interface: GenerativeAi

Gets information about an endpoint.

Specified by:

getEndpoint in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getModel

public GetModelResponse getModel(GetModelRequest request)

Description copied from interface: GenerativeAi

Gets information about a custom model.

Specified by:

getModel in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: GenerativeAi

Gets the details of a work request.

Specified by:

getWorkRequest in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDedicatedAiClusters

public ListDedicatedAiClustersResponse listDedicatedAiClusters(ListDedicatedAiClustersRequest request)

Description copied from interface: GenerativeAi

Lists the dedicated AI clusters in a specific compartment.

Specified by:

listDedicatedAiClusters in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEndpoints

public ListEndpointsResponse listEndpoints(ListEndpointsRequest request)

Description copied from interface: GenerativeAi

Lists the endpoints of a specific compartment.

Specified by:

listEndpoints in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listModels

public ListModelsResponse listModels(ListModelsRequest request)

Description copied from interface: GenerativeAi

Lists the models in a specific compartment. Includes pretrained base models and fine-tuned custom models.

Specified by:

listModels in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: GenerativeAi

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: GenerativeAi

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: GenerativeAi

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDedicatedAiCluster

public UpdateDedicatedAiClusterResponse updateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request)

Description copied from interface: GenerativeAi

Updates a dedicated AI cluster.

Specified by:

updateDedicatedAiCluster in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateEndpoint

public UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest request)

Description copied from interface: GenerativeAi

Updates the properties of an endpoint.

Specified by:

updateEndpoint in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateModel

public UpdateModelResponse updateModel(UpdateModelRequest request)

Description copied from interface: GenerativeAi

Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.

Specified by:

updateModel in interface GenerativeAi

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public GenerativeAiWaiters getWaiters()

Description copied from interface: GenerativeAi

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface GenerativeAi

Returns:

The service waiters.

getPaginators

public GenerativeAiPaginators getPaginators()

Description copied from interface: GenerativeAi

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface GenerativeAi

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()