/** * Work Requests API * Many of the API operations that you use to create and configure Compute resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running workflows. For more information about work requests and the operations that spawn work requests, see [Viewing the State of a Compute Work Request](https://docs.oracle.com/iaas/Content/Compute/Tasks/viewingworkrequestcompute.htm). * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, 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 model from "./model"; import * as responses from "./response"; import { WorkRequestWaiter } from "./workrequest-waiter"; declare const Breaker: any; export declare enum WorkRequestApiKeys { } /** * 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 WorkRequestClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": WorkRequestWaiter; 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; protected _authProvider: common.AuthenticationDetailsProvider | undefined; 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 WorkRequestWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): WorkRequestWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): WorkRequestWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Gets the details of a work request. * This operation does not retry by default if the user has not defined a retry configuration. * @param GetWorkRequestRequest * @return GetWorkRequestResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/workrequests/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API. */ getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise; /** * Gets the errors for a work request. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListWorkRequestErrorsRequest * @return ListWorkRequestErrorsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/workrequests/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API. */ listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrors(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrorsResponses(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsRecordIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsResponseIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Gets the logs for a work request. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListWorkRequestLogsRequest * @return ListWorkRequestLogsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/workrequests/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API. */ listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogs(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogsResponses(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsRecordIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsResponseIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Lists the work requests in a compartment or for a specified resource. * * This operation does not retry by default if the user has not defined a retry configuration. * @param ListWorkRequestsRequest * @return ListWorkRequestsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/workrequests/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API. */ listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; } export {};