oci-desktops 2.80.0

package/lib/client.d.ts

@@ -0,0 +1,292 @@
+/**
+ * Secure Desktops API
+ * Create and manage cloud-hosted desktops which can be accessed from a web browser or installed client.
+
+ * OpenAPI spec version: 20220618
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { DesktopServiceWaiter } from "./desktopservice-waiter";
+declare const Breaker: any;
+export declare enum DesktopServiceApiKeys {
+}
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+export declare class DesktopServiceClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": DesktopServiceWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Determines whether realm specific endpoint should be used or not.
+     * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Creates a new DesktopServiceWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): DesktopServiceWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): DesktopServiceWaiter;
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Cancel work request with the given ID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelWorkRequestRequest
+     * @return CancelWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangeDesktopPoolCompartmentRequest
+     * @return ChangeDesktopPoolCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ChangeDesktopPoolCompartment.ts.html |here} to see how to use ChangeDesktopPoolCompartment API.
+     */
+    changeDesktopPoolCompartment(changeDesktopPoolCompartmentRequest: requests.ChangeDesktopPoolCompartmentRequest): Promise<responses.ChangeDesktopPoolCompartmentResponse>;
+    /**
+     * Creates a desktop pool with the given configuration parameters.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateDesktopPoolRequest
+     * @return CreateDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/CreateDesktopPool.ts.html |here} to see how to use CreateDesktopPool API.
+     */
+    createDesktopPool(createDesktopPoolRequest: requests.CreateDesktopPoolRequest): Promise<responses.CreateDesktopPoolResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteDesktopRequest
+     * @return DeleteDesktopResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/DeleteDesktop.ts.html |here} to see how to use DeleteDesktop API.
+     */
+    deleteDesktop(deleteDesktopRequest: requests.DeleteDesktopRequest): Promise<responses.DeleteDesktopResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteDesktopPoolRequest
+     * @return DeleteDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/DeleteDesktopPool.ts.html |here} to see how to use DeleteDesktopPool API.
+     */
+    deleteDesktopPool(deleteDesktopPoolRequest: requests.DeleteDesktopPoolRequest): Promise<responses.DeleteDesktopPoolResponse>;
+    /**
+     * Provides information about the desktop with the specified OCID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetDesktopRequest
+     * @return GetDesktopResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/GetDesktop.ts.html |here} to see how to use GetDesktop API.
+     */
+    getDesktop(getDesktopRequest: requests.GetDesktopRequest): Promise<responses.GetDesktopResponse>;
+    /**
+     * Returns information about the desktop pool including all configuration parameters and the current state.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetDesktopPoolRequest
+     * @return GetDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/GetDesktopPool.ts.html |here} to see how to use GetDesktopPool API.
+     */
+    getDesktopPool(getDesktopPoolRequest: requests.GetDesktopPoolRequest): Promise<responses.GetDesktopPoolResponse>;
+    /**
+     * Gets the status of the work request with the given ID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetWorkRequestRequest
+     * @return GetWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListDesktopPoolDesktopsRequest
+     * @return ListDesktopPoolDesktopsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListDesktopPoolDesktops.ts.html |here} to see how to use ListDesktopPoolDesktops API.
+     */
+    listDesktopPoolDesktops(listDesktopPoolDesktopsRequest: requests.ListDesktopPoolDesktopsRequest): Promise<responses.ListDesktopPoolDesktopsResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListDesktopPoolVolumesRequest
+     * @return ListDesktopPoolVolumesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListDesktopPoolVolumes.ts.html |here} to see how to use ListDesktopPoolVolumes API.
+     */
+    listDesktopPoolVolumes(listDesktopPoolVolumesRequest: requests.ListDesktopPoolVolumesRequest): Promise<responses.ListDesktopPoolVolumesResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListDesktopPoolsRequest
+     * @return ListDesktopPoolsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListDesktopPools.ts.html |here} to see how to use ListDesktopPools API.
+     */
+    listDesktopPools(listDesktopPoolsRequest: requests.ListDesktopPoolsRequest): Promise<responses.ListDesktopPoolsResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListDesktopsRequest
+     * @return ListDesktopsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListDesktops.ts.html |here} to see how to use ListDesktops API.
+     */
+    listDesktops(listDesktopsRequest: requests.ListDesktopsRequest): Promise<responses.ListDesktopsResponse>;
+    /**
+     * Return a (paginated) list of errors for a given work request.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestErrorsRequest
+     * @return ListWorkRequestErrorsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     */
+    listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
+    /**
+     * Return a (paginated) list of logs for a given work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestLogsRequest
+     * @return ListWorkRequestLogsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * Lists the work requests in a compartment.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListWorkRequestsRequest
+     * @return ListWorkRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Starts the desktop with the specified OCID.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param StartDesktopRequest
+     * @return StartDesktopResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/StartDesktop.ts.html |here} to see how to use StartDesktop API.
+     */
+    startDesktop(startDesktopRequest: requests.StartDesktopRequest): Promise<responses.StartDesktopResponse>;
+    /**
+     * Starts the desktop pool with the specified OCID. Once the pool is ACTIVE, users will have access to their desktops within the pool.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param StartDesktopPoolRequest
+     * @return StartDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/StartDesktopPool.ts.html |here} to see how to use StartDesktopPool API.
+     */
+    startDesktopPool(startDesktopPoolRequest: requests.StartDesktopPoolRequest): Promise<responses.StartDesktopPoolResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param StopDesktopRequest
+     * @return StopDesktopResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/StopDesktop.ts.html |here} to see how to use StopDesktop API.
+     */
+    stopDesktop(stopDesktopRequest: requests.StopDesktopRequest): Promise<responses.StopDesktopResponse>;
+    /**
+     * Stops the desktop pool with the specified OCID. Users will lose access to their desktops until you explicitly start the pool again.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param StopDesktopPoolRequest
+     * @return StopDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/StopDesktopPool.ts.html |here} to see how to use StopDesktopPool API.
+     */
+    stopDesktopPool(stopDesktopPoolRequest: requests.StopDesktopPoolRequest): Promise<responses.StopDesktopPoolResponse>;
+    /**
+     * Modifies information about the desktop such as the name.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateDesktopRequest
+     * @return UpdateDesktopResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/UpdateDesktop.ts.html |here} to see how to use UpdateDesktop API.
+     */
+    updateDesktop(updateDesktopRequest: requests.UpdateDesktopRequest): Promise<responses.UpdateDesktopResponse>;
+    /**
+     * 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.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateDesktopPoolRequest
+     * @return UpdateDesktopPoolResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.80.0/desktops/UpdateDesktopPool.ts.html |here} to see how to use UpdateDesktopPool API.
+     */
+    updateDesktopPool(updateDesktopPoolRequest: requests.UpdateDesktopPoolRequest): Promise<responses.UpdateDesktopPoolResponse>;
+}
+export {};