Package com.oracle.bmc.desktops

Class DesktopServiceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.desktops.DesktopServiceClient

All Implemented Interfaces:

DesktopService, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220618")
public class DesktopServiceClient
extends BaseSyncClient
implements DesktopService

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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 DesktopService.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DesktopServiceClient.Builder	builder()	Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request)	Cancel work request with the given ID.
ChangeDesktopPoolCompartmentResponse	changeDesktopPoolCompartment(ChangeDesktopPoolCompartmentRequest request)	Moves a desktop pool into a different compartment within the same tenancy.
void	close()
CreateDesktopPoolResponse	createDesktopPool(CreateDesktopPoolRequest request)	Creates a desktop pool with the given configuration parameters.
DeleteDesktopResponse	deleteDesktop(DeleteDesktopRequest request)	Deletes the desktop with the specified OCID.
DeleteDesktopPoolResponse	deleteDesktopPool(DeleteDesktopPoolRequest request)	Deletes a desktop pool with the specified OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDesktopResponse	getDesktop(GetDesktopRequest request)	Provides information about the desktop with the specified OCID.
GetDesktopPoolResponse	getDesktopPool(GetDesktopPoolRequest request)	Returns information about the desktop pool including all configuration parameters and the current state.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DesktopServicePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DesktopServiceWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request)	Gets the status of the work request with the given ID.
ListDesktopPoolDesktopsResponse	listDesktopPoolDesktops(ListDesktopPoolDesktopsRequest request)	Returns a list of desktops within a given desktop pool.
ListDesktopPoolsResponse	listDesktopPools(ListDesktopPoolsRequest request)	Returns a list of desktop pools within the given compartment.
ListDesktopPoolVolumesResponse	listDesktopPoolVolumes(ListDesktopPoolVolumesRequest request)	Returns a list of volumes within the given desktop pool.
ListDesktopsResponse	listDesktops(ListDesktopsRequest request)	Returns a list of desktops filtered by the specified parameters.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request)	Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request)	Return a (paginated) list of logs for a given 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’).
StartDesktopResponse	startDesktop(StartDesktopRequest request)	Starts the desktop with the specified OCID.
StartDesktopPoolResponse	startDesktopPool(StartDesktopPoolRequest request)	Starts the desktop pool with the specified OCID.
StopDesktopResponse	stopDesktop(StopDesktopRequest request)	Stops the desktop with the specified OCID.
StopDesktopPoolResponse	stopDesktopPool(StopDesktopPoolRequest request)	Stops the desktop pool with the specified OCID.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateDesktopResponse	updateDesktop(UpdateDesktopRequest request)	Modifies information about the desktop such as the name.
UpdateDesktopPoolResponse	updateDesktopPool(UpdateDesktopPoolRequest request)	Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.desktops.DesktopService

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DesktopService.

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

DesktopServiceClient

@Deprecated
public DesktopServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DesktopServiceClient

@Deprecated
public DesktopServiceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DesktopServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DesktopServiceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DesktopServiceClient

@Deprecated
public DesktopServiceClient(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 DesktopServiceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DesktopServiceClient

@Deprecated
public DesktopServiceClient(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 DesktopServiceClient.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)

DesktopServiceClient

@Deprecated
public DesktopServiceClient(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 DesktopServiceClient.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

DesktopServiceClient

@Deprecated
public DesktopServiceClient(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 DesktopServiceClient.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 - DesktopServiceClient.Builder.executorService

Method Detail

builder

public static DesktopServiceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DesktopService

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 DesktopService

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DesktopService

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 DesktopService

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: DesktopService

Cancel work request with the given ID.

Specified by:

cancelWorkRequest in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDesktopPoolCompartment

public ChangeDesktopPoolCompartmentResponse changeDesktopPoolCompartment(ChangeDesktopPoolCompartmentRequest request)

Description copied from interface: DesktopService

Moves a desktop pool into a different compartment within the same tenancy.

You must provide the OCID of the desktop pool and the OCID of the compartment that you are moving the pool to.

Specified by:

changeDesktopPoolCompartment in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDesktopPool

public CreateDesktopPoolResponse createDesktopPool(CreateDesktopPoolRequest request)

Description copied from interface: DesktopService

Creates a desktop pool with the given configuration parameters.

Specified by:

createDesktopPool in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDesktop

public DeleteDesktopResponse deleteDesktop(DeleteDesktopRequest request)

Description copied from interface: DesktopService

Deletes the desktop with the specified OCID.

The service terminates the associated compute instance. The end-user loses access to the desktop instance permanently. Any associated block volume becomes inactive but is not deleted.

Specified by:

deleteDesktop in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDesktopPool

public DeleteDesktopPoolResponse deleteDesktopPool(DeleteDesktopPoolRequest request)

Description copied from interface: DesktopService

Deletes a desktop pool with the specified OCID.

The service terminates all compute instances and users immediately lose access to their desktops. You can choose to preserve the block volumes associated with the pool.

Specified by:

deleteDesktopPool in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDesktop

public GetDesktopResponse getDesktop(GetDesktopRequest request)

Description copied from interface: DesktopService

Provides information about the desktop with the specified OCID.

Specified by:

getDesktop in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDesktopPool

public GetDesktopPoolResponse getDesktopPool(GetDesktopPoolRequest request)

Description copied from interface: DesktopService

Returns information about the desktop pool including all configuration parameters and the current state.

Specified by:

getDesktopPool in interface DesktopService

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: DesktopService

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDesktopPoolDesktops

public ListDesktopPoolDesktopsResponse listDesktopPoolDesktops(ListDesktopPoolDesktopsRequest request)

Description copied from interface: DesktopService

Returns a list of desktops within a given desktop pool.

You can limit the results to an availability domain, desktop name, or desktop state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Specified by:

listDesktopPoolDesktops in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDesktopPoolVolumes

public ListDesktopPoolVolumesResponse listDesktopPoolVolumes(ListDesktopPoolVolumesRequest request)

Description copied from interface: DesktopService

Returns a list of volumes within the given desktop pool.

You can limit the results to an availability domain, volume name, or volume state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Specified by:

listDesktopPoolVolumes in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDesktopPools

public ListDesktopPoolsResponse listDesktopPools(ListDesktopPoolsRequest request)

Description copied from interface: DesktopService

Returns a list of desktop pools within the given compartment.

You can limit the results to an availability domain, pool name, or pool state. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Specified by:

listDesktopPools in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDesktops

public ListDesktopsResponse listDesktops(ListDesktopsRequest request)

Description copied from interface: DesktopService

Returns a list of desktops filtered by the specified parameters.

You can limit the results to an availability domain, desktop name, desktop OCID, desktop state, pool OCID, or compartment OCID. You can limit the number of results returned, sort the results by time or name, and sort in ascending or descending order.

Specified by:

listDesktops in interface DesktopService

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: DesktopService

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface DesktopService

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: DesktopService

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface DesktopService

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: DesktopService

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDesktop

public StartDesktopResponse startDesktop(StartDesktopRequest request)

Description copied from interface: DesktopService

Starts the desktop with the specified OCID.

Specified by:

startDesktop in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDesktopPool

public StartDesktopPoolResponse startDesktopPool(StartDesktopPoolRequest request)

Description copied from interface: DesktopService

Starts the desktop pool with the specified OCID.

Once the pool is ACTIVE, users will have access to their desktops within the pool.

Specified by:

startDesktopPool in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDesktop

public StopDesktopResponse stopDesktop(StopDesktopRequest request)

Description copied from interface: DesktopService

Stops the desktop with the specified OCID.

Stopping a desktop causes the end-user to lose access to their desktop instance until the desktop is restarted.

Specified by:

stopDesktop in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDesktopPool

public StopDesktopPoolResponse stopDesktopPool(StopDesktopPoolRequest request)

Description copied from interface: DesktopService

Stops the desktop pool with the specified OCID.

Users will lose access to their desktops until you explicitly start the pool again.

Specified by:

stopDesktopPool in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDesktop

public UpdateDesktopResponse updateDesktop(UpdateDesktopRequest request)

Description copied from interface: DesktopService

Modifies information about the desktop such as the name.

Specified by:

updateDesktop in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDesktopPool

public UpdateDesktopPoolResponse updateDesktopPool(UpdateDesktopPoolRequest request)

Description copied from interface: DesktopService

Modifies the configuration of the desktop pool such as the availability, contact information, description, name, device policy, pool size, standby size, and start or stop time.

Specified by:

updateDesktopPool in interface DesktopService

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DesktopServiceWaiters getWaiters()

Description copied from interface: DesktopService

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

Specified by:

getWaiters in interface DesktopService

Returns:

The service waiters.

getPaginators

public DesktopServicePaginators getPaginators()

Description copied from interface: DesktopService

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 DesktopService

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()