Package com.oracle.bmc.desktops

Class DesktopServiceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.desktops.DesktopServiceAsyncClient

All Implemented Interfaces:

DesktopServiceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220618")
public class DesktopServiceAsyncClient
extends BaseAsyncClient
implements DesktopServiceAsync

Async client implementation for DesktopService service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DesktopServiceAsyncClient.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
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static DesktopServiceAsyncClient.Builder	builder()	Create a builder for this client.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)	Cancel work request with the given ID.
Future<ChangeDesktopPoolCompartmentResponse>	changeDesktopPoolCompartment(ChangeDesktopPoolCompartmentRequest request, AsyncHandler<ChangeDesktopPoolCompartmentRequest,ChangeDesktopPoolCompartmentResponse> handler)	Moves a desktop pool into a different compartment within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateDesktopPoolResponse>	createDesktopPool(CreateDesktopPoolRequest request, AsyncHandler<CreateDesktopPoolRequest,CreateDesktopPoolResponse> handler)	Creates a desktop pool with the given configuration parameters.
Future<DeleteDesktopResponse>	deleteDesktop(DeleteDesktopRequest request, AsyncHandler<DeleteDesktopRequest,DeleteDesktopResponse> handler)	Deletes the desktop with the specified OCID.
Future<DeleteDesktopPoolResponse>	deleteDesktopPool(DeleteDesktopPoolRequest request, AsyncHandler<DeleteDesktopPoolRequest,DeleteDesktopPoolResponse> handler)	Deletes a desktop pool with the specified OCID.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDesktopResponse>	getDesktop(GetDesktopRequest request, AsyncHandler<GetDesktopRequest,GetDesktopResponse> handler)	Provides information about the desktop with the specified OCID.
Future<GetDesktopPoolResponse>	getDesktopPool(GetDesktopPoolRequest request, AsyncHandler<GetDesktopPoolRequest,GetDesktopPoolResponse> handler)	Returns information about the desktop pool including all configuration parameters and the current state.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets the status of the work request with the given ID.
Future<ListDesktopPoolDesktopsResponse>	listDesktopPoolDesktops(ListDesktopPoolDesktopsRequest request, AsyncHandler<ListDesktopPoolDesktopsRequest,ListDesktopPoolDesktopsResponse> handler)	Returns a list of desktops within a given desktop pool.
Future<ListDesktopPoolsResponse>	listDesktopPools(ListDesktopPoolsRequest request, AsyncHandler<ListDesktopPoolsRequest,ListDesktopPoolsResponse> handler)	Returns a list of desktop pools within the given compartment.
Future<ListDesktopPoolVolumesResponse>	listDesktopPoolVolumes(ListDesktopPoolVolumesRequest request, AsyncHandler<ListDesktopPoolVolumesRequest,ListDesktopPoolVolumesResponse> handler)	Returns a list of volumes within the given desktop pool.
Future<ListDesktopsResponse>	listDesktops(ListDesktopsRequest request, AsyncHandler<ListDesktopsRequest,ListDesktopsResponse> handler)	Returns a list of desktops filtered by the specified parameters.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Return a (paginated) list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	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’).
Future<StartDesktopResponse>	startDesktop(StartDesktopRequest request, AsyncHandler<StartDesktopRequest,StartDesktopResponse> handler)	Starts the desktop with the specified OCID.
Future<StartDesktopPoolResponse>	startDesktopPool(StartDesktopPoolRequest request, AsyncHandler<StartDesktopPoolRequest,StartDesktopPoolResponse> handler)	Starts the desktop pool with the specified OCID.
Future<StopDesktopResponse>	stopDesktop(StopDesktopRequest request, AsyncHandler<StopDesktopRequest,StopDesktopResponse> handler)	Stops the desktop with the specified OCID.
Future<StopDesktopPoolResponse>	stopDesktopPool(StopDesktopPoolRequest request, AsyncHandler<StopDesktopPoolRequest,StopDesktopPoolResponse> handler)	Stops the desktop pool with the specified OCID.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateDesktopResponse>	updateDesktop(UpdateDesktopRequest request, AsyncHandler<UpdateDesktopRequest,UpdateDesktopResponse> handler)	Modifies information about the desktop such as the name.
Future<UpdateDesktopPoolResponse>	updateDesktopPool(UpdateDesktopPoolRequest request, AsyncHandler<UpdateDesktopPoolRequest,UpdateDesktopPoolResponse> handler)	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 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.DesktopServiceAsync

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

DesktopServiceAsyncClient

@Deprecated
public DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DesktopServiceAsyncClient

@Deprecated
public DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DesktopServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DesktopServiceAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DesktopServiceAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DesktopServiceAsyncClient

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

DesktopServiceAsyncClient

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

Method Detail

builder

public static DesktopServiceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

regionId - The public region ID.

cancelWorkRequest

public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Description copied from interface: DesktopServiceAsync

Cancel work request with the given ID.

Specified by:

cancelWorkRequest in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

changeDesktopPoolCompartment

public Future<ChangeDesktopPoolCompartmentResponse> changeDesktopPoolCompartment(ChangeDesktopPoolCompartmentRequest request,
                                                                                 AsyncHandler<ChangeDesktopPoolCompartmentRequest,ChangeDesktopPoolCompartmentResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createDesktopPool

public Future<CreateDesktopPoolResponse> createDesktopPool(CreateDesktopPoolRequest request,
                                                           AsyncHandler<CreateDesktopPoolRequest,CreateDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

Creates a desktop pool with the given configuration parameters.

Specified by:

createDesktopPool in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteDesktop

public Future<DeleteDesktopResponse> deleteDesktop(DeleteDesktopRequest request,
                                                   AsyncHandler<DeleteDesktopRequest,DeleteDesktopResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteDesktopPool

public Future<DeleteDesktopPoolResponse> deleteDesktopPool(DeleteDesktopPoolRequest request,
                                                           AsyncHandler<DeleteDesktopPoolRequest,DeleteDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDesktop

public Future<GetDesktopResponse> getDesktop(GetDesktopRequest request,
                                             AsyncHandler<GetDesktopRequest,GetDesktopResponse> handler)

Description copied from interface: DesktopServiceAsync

Provides information about the desktop with the specified OCID.

Specified by:

getDesktop in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getDesktopPool

public Future<GetDesktopPoolResponse> getDesktopPool(GetDesktopPoolRequest request,
                                                     AsyncHandler<GetDesktopPoolRequest,GetDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

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

Specified by:

getDesktopPool in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: DesktopServiceAsync

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

Specified by:

getWorkRequest in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDesktopPoolDesktops

public Future<ListDesktopPoolDesktopsResponse> listDesktopPoolDesktops(ListDesktopPoolDesktopsRequest request,
                                                                       AsyncHandler<ListDesktopPoolDesktopsRequest,ListDesktopPoolDesktopsResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDesktopPoolVolumes

public Future<ListDesktopPoolVolumesResponse> listDesktopPoolVolumes(ListDesktopPoolVolumesRequest request,
                                                                     AsyncHandler<ListDesktopPoolVolumesRequest,ListDesktopPoolVolumesResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDesktopPools

public Future<ListDesktopPoolsResponse> listDesktopPools(ListDesktopPoolsRequest request,
                                                         AsyncHandler<ListDesktopPoolsRequest,ListDesktopPoolsResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listDesktops

public Future<ListDesktopsResponse> listDesktops(ListDesktopsRequest request,
                                                 AsyncHandler<ListDesktopsRequest,ListDesktopsResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: DesktopServiceAsync

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

Specified by:

listWorkRequestErrors in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: DesktopServiceAsync

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

Specified by:

listWorkRequestLogs in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: DesktopServiceAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startDesktop

public Future<StartDesktopResponse> startDesktop(StartDesktopRequest request,
                                                 AsyncHandler<StartDesktopRequest,StartDesktopResponse> handler)

Description copied from interface: DesktopServiceAsync

Starts the desktop with the specified OCID.

Specified by:

startDesktop in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startDesktopPool

public Future<StartDesktopPoolResponse> startDesktopPool(StartDesktopPoolRequest request,
                                                         AsyncHandler<StartDesktopPoolRequest,StartDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopDesktop

public Future<StopDesktopResponse> stopDesktop(StopDesktopRequest request,
                                               AsyncHandler<StopDesktopRequest,StopDesktopResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopDesktopPool

public Future<StopDesktopPoolResponse> stopDesktopPool(StopDesktopPoolRequest request,
                                                       AsyncHandler<StopDesktopPoolRequest,StopDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateDesktop

public Future<UpdateDesktopResponse> updateDesktop(UpdateDesktopRequest request,
                                                   AsyncHandler<UpdateDesktopRequest,UpdateDesktopResponse> handler)

Description copied from interface: DesktopServiceAsync

Modifies information about the desktop such as the name.

Specified by:

updateDesktop in interface DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateDesktopPool

public Future<UpdateDesktopPoolResponse> updateDesktopPool(UpdateDesktopPoolRequest request,
                                                           AsyncHandler<UpdateDesktopPoolRequest,UpdateDesktopPoolResponse> handler)

Description copied from interface: DesktopServiceAsync

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 DesktopServiceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)