@Generated(value="OracleSDKGenerator", comments="API Version: 20220618") public class DesktopServiceAsyncClient extends Object implements DesktopServiceAsync
Async client implementation for DesktopService service.
There are two ways to use async client:
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. | Modifier and Type | Class and Description |
|---|---|
static class |
DesktopServiceAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for DesktopService.
|
| Constructor and Description |
|---|
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for DesktopService.
public DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public DesktopServiceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public DesktopServiceAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static DesktopServiceAsyncClient.Builder builder()
Create a builder for this client.
public void refreshClient()
DesktopServiceAsyncRebuilds the client from scratch. Useful to refresh certificates.
refreshClient in interface DesktopServiceAsyncpublic void setEndpoint(String endpoint)
DesktopServiceAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface DesktopServiceAsyncendpoint - The endpoint of the serice.public String getEndpoint()
DesktopServiceAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface DesktopServiceAsyncpublic void setRegion(Region region)
DesktopServiceAsyncSets 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.
setRegion in interface DesktopServiceAsyncregion - The region of the service.public void setRegion(String regionId)
DesktopServiceAsyncSets 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.
setRegion in interface DesktopServiceAsyncregionId - The public region ID.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
useRealmSpecificEndpointTemplate in interface DesktopServiceAsyncuseOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic void close()
close in interface AutoCloseablepublic Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
DesktopServiceAsyncCancel work request with the given ID.
cancelWorkRequest in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeDesktopPoolCompartmentResponse> changeDesktopPoolCompartment(ChangeDesktopPoolCompartmentRequest request, AsyncHandler<ChangeDesktopPoolCompartmentRequest,ChangeDesktopPoolCompartmentResponse> handler)
DesktopServiceAsyncMoves 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.
changeDesktopPoolCompartment in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateDesktopPoolResponse> createDesktopPool(CreateDesktopPoolRequest request, AsyncHandler<CreateDesktopPoolRequest,CreateDesktopPoolResponse> handler)
DesktopServiceAsyncCreates a desktop pool with the given configuration parameters.
createDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteDesktopResponse> deleteDesktop(DeleteDesktopRequest request, AsyncHandler<DeleteDesktopRequest,DeleteDesktopResponse> handler)
DesktopServiceAsyncDeletes 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.
deleteDesktop in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteDesktopPoolResponse> deleteDesktopPool(DeleteDesktopPoolRequest request, AsyncHandler<DeleteDesktopPoolRequest,DeleteDesktopPoolResponse> handler)
DesktopServiceAsyncDeletes 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.
deleteDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetDesktopResponse> getDesktop(GetDesktopRequest request, AsyncHandler<GetDesktopRequest,GetDesktopResponse> handler)
DesktopServiceAsyncProvides information about the desktop with the specified OCID.
getDesktop in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetDesktopPoolResponse> getDesktopPool(GetDesktopPoolRequest request, AsyncHandler<GetDesktopPoolRequest,GetDesktopPoolResponse> handler)
DesktopServiceAsyncReturns information about the desktop pool including all configuration parameters and the current state.
getDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
DesktopServiceAsyncGets the status of the work request with the given ID.
getWorkRequest in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListDesktopPoolDesktopsResponse> listDesktopPoolDesktops(ListDesktopPoolDesktopsRequest request, AsyncHandler<ListDesktopPoolDesktopsRequest,ListDesktopPoolDesktopsResponse> handler)
DesktopServiceAsyncReturns 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.
listDesktopPoolDesktops in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListDesktopPoolVolumesResponse> listDesktopPoolVolumes(ListDesktopPoolVolumesRequest request, AsyncHandler<ListDesktopPoolVolumesRequest,ListDesktopPoolVolumesResponse> handler)
DesktopServiceAsyncReturns 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.
listDesktopPoolVolumes in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListDesktopPoolsResponse> listDesktopPools(ListDesktopPoolsRequest request, AsyncHandler<ListDesktopPoolsRequest,ListDesktopPoolsResponse> handler)
DesktopServiceAsyncReturns 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.
listDesktopPools in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListDesktopsResponse> listDesktops(ListDesktopsRequest request, AsyncHandler<ListDesktopsRequest,ListDesktopsResponse> handler)
DesktopServiceAsyncReturns 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.
listDesktops in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
DesktopServiceAsyncReturn a (paginated) list of errors for a given work request.
listWorkRequestErrors in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
DesktopServiceAsyncReturn a (paginated) list of logs for a given work request.
listWorkRequestLogs in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
DesktopServiceAsyncLists the work requests in a compartment.
listWorkRequests in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StartDesktopResponse> startDesktop(StartDesktopRequest request, AsyncHandler<StartDesktopRequest,StartDesktopResponse> handler)
DesktopServiceAsyncStarts the desktop with the specified OCID.
startDesktop in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StartDesktopPoolResponse> startDesktopPool(StartDesktopPoolRequest request, AsyncHandler<StartDesktopPoolRequest,StartDesktopPoolResponse> handler)
DesktopServiceAsyncStarts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.
startDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StopDesktopResponse> stopDesktop(StopDesktopRequest request, AsyncHandler<StopDesktopRequest,StopDesktopResponse> handler)
DesktopServiceAsyncStops 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.
stopDesktop in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<StopDesktopPoolResponse> stopDesktopPool(StopDesktopPoolRequest request, AsyncHandler<StopDesktopPoolRequest,StopDesktopPoolResponse> handler)
DesktopServiceAsyncStops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.
stopDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateDesktopResponse> updateDesktop(UpdateDesktopRequest request, AsyncHandler<UpdateDesktopRequest,UpdateDesktopResponse> handler)
DesktopServiceAsyncModifies information about the desktop such as the name.
updateDesktop in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateDesktopPoolResponse> updateDesktopPool(UpdateDesktopPoolRequest request, AsyncHandler<UpdateDesktopPoolRequest,UpdateDesktopPoolResponse> handler)
DesktopServiceAsyncModifies 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.
updateDesktopPool in interface DesktopServiceAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.