oci-waa 2.31.0

package/lib/client.d.ts

@@ -0,0 +1,298 @@
+/**
+ * Web Application Acceleration (WAA) API
+ * API for the Web Application Acceleration service.
+Use this API to manage regional Web App Acceleration policies such as Caching and Compression
+for accelerating HTTP services.
+
+ * OpenAPI spec version: 20211230
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2022, 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 { WaaWaiter } from "./waa-waiter";
+import { WorkRequestWaiter } from "./workrequest-waiter";
+export declare enum WaaApiKeys {
+}
+/**
+ * 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 WaaClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": WaaWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: 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;
+    /**
+     * 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 WaaWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): WaaWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): WaaWaiter;
+    /**
+     * Moves a Web App Acceleration resource from one compartment to another.
+     * When provided, If-Match is checked against ETag values of the resource.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeWebAppAccelerationCompartmentRequest
+     * @return ChangeWebAppAccelerationCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ChangeWebAppAccelerationCompartment.ts.html |here} to see how to use ChangeWebAppAccelerationCompartment API.
+     */
+    changeWebAppAccelerationCompartment(changeWebAppAccelerationCompartmentRequest: requests.ChangeWebAppAccelerationCompartmentRequest): Promise<responses.ChangeWebAppAccelerationCompartmentResponse>;
+    /**
+     * Moves a WebAppAccelerationfPolicy resource from one compartment to another.
+     * When provided, If-Match is checked against ETag values of the resource.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeWebAppAccelerationPolicyCompartmentRequest
+     * @return ChangeWebAppAccelerationPolicyCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ChangeWebAppAccelerationPolicyCompartment.ts.html |here} to see how to use ChangeWebAppAccelerationPolicyCompartment API.
+     */
+    changeWebAppAccelerationPolicyCompartment(changeWebAppAccelerationPolicyCompartmentRequest: requests.ChangeWebAppAccelerationPolicyCompartmentRequest): Promise<responses.ChangeWebAppAccelerationPolicyCompartmentResponse>;
+    /**
+     * Creates a new WebAppAcceleration.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateWebAppAccelerationRequest
+     * @return CreateWebAppAccelerationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/CreateWebAppAcceleration.ts.html |here} to see how to use CreateWebAppAcceleration API.
+     */
+    createWebAppAcceleration(createWebAppAccelerationRequest: requests.CreateWebAppAccelerationRequest): Promise<responses.CreateWebAppAccelerationResponse>;
+    /**
+     * Creates a new WebAppAccelerationPolicy.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateWebAppAccelerationPolicyRequest
+     * @return CreateWebAppAccelerationPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/CreateWebAppAccelerationPolicy.ts.html |here} to see how to use CreateWebAppAccelerationPolicy API.
+     */
+    createWebAppAccelerationPolicy(createWebAppAccelerationPolicyRequest: requests.CreateWebAppAccelerationPolicyRequest): Promise<responses.CreateWebAppAccelerationPolicyResponse>;
+    /**
+     * Deletes a WebAppAcceleration resource identified by the OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteWebAppAccelerationRequest
+     * @return DeleteWebAppAccelerationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/DeleteWebAppAcceleration.ts.html |here} to see how to use DeleteWebAppAcceleration API.
+     */
+    deleteWebAppAcceleration(deleteWebAppAccelerationRequest: requests.DeleteWebAppAccelerationRequest): Promise<responses.DeleteWebAppAccelerationResponse>;
+    /**
+     * Deletes a WebAppAccelerationPolicy resource identified by the OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteWebAppAccelerationPolicyRequest
+     * @return DeleteWebAppAccelerationPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/DeleteWebAppAccelerationPolicy.ts.html |here} to see how to use DeleteWebAppAccelerationPolicy API.
+     */
+    deleteWebAppAccelerationPolicy(deleteWebAppAccelerationPolicyRequest: requests.DeleteWebAppAccelerationPolicyRequest): Promise<responses.DeleteWebAppAccelerationPolicyResponse>;
+    /**
+     * Gets a WebAppAcceleration by OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetWebAppAccelerationRequest
+     * @return GetWebAppAccelerationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/GetWebAppAcceleration.ts.html |here} to see how to use GetWebAppAcceleration API.
+     */
+    getWebAppAcceleration(getWebAppAccelerationRequest: requests.GetWebAppAccelerationRequest): Promise<responses.GetWebAppAccelerationResponse>;
+    /**
+     * Gets a WebAppAccelerationPolicy with the given OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetWebAppAccelerationPolicyRequest
+     * @return GetWebAppAccelerationPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/GetWebAppAccelerationPolicy.ts.html |here} to see how to use GetWebAppAccelerationPolicy API.
+     */
+    getWebAppAccelerationPolicy(getWebAppAccelerationPolicyRequest: requests.GetWebAppAccelerationPolicyRequest): Promise<responses.GetWebAppAccelerationPolicyResponse>;
+    /**
+     * Gets a list of all WebAppAccelerationPolicies in a compartment.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListWebAppAccelerationPoliciesRequest
+     * @return ListWebAppAccelerationPoliciesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ListWebAppAccelerationPolicies.ts.html |here} to see how to use ListWebAppAccelerationPolicies API.
+     */
+    listWebAppAccelerationPolicies(listWebAppAccelerationPoliciesRequest: requests.ListWebAppAccelerationPoliciesRequest): Promise<responses.ListWebAppAccelerationPoliciesResponse>;
+    /**
+     * Gets a list of all WebAppAccelerations in a compartment.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListWebAppAccelerationsRequest
+     * @return ListWebAppAccelerationsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ListWebAppAccelerations.ts.html |here} to see how to use ListWebAppAccelerations API.
+     */
+    listWebAppAccelerations(listWebAppAccelerationsRequest: requests.ListWebAppAccelerationsRequest): Promise<responses.ListWebAppAccelerationsResponse>;
+    /**
+     * Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be
+     * forwarded to the origin server to fetch a new version of the resource.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param PurgeWebAppAccelerationCacheRequest
+     * @return PurgeWebAppAccelerationCacheResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/PurgeWebAppAccelerationCache.ts.html |here} to see how to use PurgeWebAppAccelerationCache API.
+     */
+    purgeWebAppAccelerationCache(purgeWebAppAccelerationCacheRequest: requests.PurgeWebAppAccelerationCacheRequest): Promise<responses.PurgeWebAppAccelerationCacheResponse>;
+    /**
+     * Updates the WebAppAcceleration identified by the OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateWebAppAccelerationRequest
+     * @return UpdateWebAppAccelerationResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/UpdateWebAppAcceleration.ts.html |here} to see how to use UpdateWebAppAcceleration API.
+     */
+    updateWebAppAcceleration(updateWebAppAccelerationRequest: requests.UpdateWebAppAccelerationRequest): Promise<responses.UpdateWebAppAccelerationResponse>;
+    /**
+     * Update the WebAppAccelerationPolicy identified by the OCID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateWebAppAccelerationPolicyRequest
+     * @return UpdateWebAppAccelerationPolicyResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/UpdateWebAppAccelerationPolicy.ts.html |here} to see how to use UpdateWebAppAccelerationPolicy API.
+     */
+    updateWebAppAccelerationPolicy(updateWebAppAccelerationPolicyRequest: requests.UpdateWebAppAccelerationPolicyRequest): Promise<responses.UpdateWebAppAccelerationPolicyResponse>;
+}
+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 "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": WorkRequestWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: 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;
+    /**
+     * 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;
+    /**
+     * Gets the status of the WorkRequest with the given OCID.
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Return a (paginated) list of errors for a given WorkRequest.
+     *
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/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 WorkRequest.
+     *
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * Lists the WorkRequests in a compartment.
+     *
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/waa/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+}