oci-opa 2.35.1

package/lib/client.d.ts

@@ -0,0 +1,176 @@
+/**
+ * OracleProcessAutomation API
+ * A description of the OracleProcessAutomation API
+ * OpenAPI spec version: 20210621
+ *
+ *
+ * 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 { OpaInstanceWaiter } from "./opainstance-waiter";
+export declare enum OpaInstanceApiKeys {
+}
+/**
+ * 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 OpaInstanceClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": OpaInstanceWaiter;
+    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 OpaInstanceWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): OpaInstanceWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): OpaInstanceWaiter;
+    /**
+     * Cancel work request with the given ID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.35.1/opa/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
+     */
+    cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
+    /**
+     * Moves a OpaInstance resource from one compartment identifier 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 ChangeOpaInstanceCompartmentRequest
+     * @return ChangeOpaInstanceCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/ChangeOpaInstanceCompartment.ts.html |here} to see how to use ChangeOpaInstanceCompartment API.
+     */
+    changeOpaInstanceCompartment(changeOpaInstanceCompartmentRequest: requests.ChangeOpaInstanceCompartmentRequest): Promise<responses.ChangeOpaInstanceCompartmentResponse>;
+    /**
+     * Creates a new OpaInstance.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateOpaInstanceRequest
+     * @return CreateOpaInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/CreateOpaInstance.ts.html |here} to see how to use CreateOpaInstance API.
+     */
+    createOpaInstance(createOpaInstanceRequest: requests.CreateOpaInstanceRequest): Promise<responses.CreateOpaInstanceResponse>;
+    /**
+     * Deletes a OpaInstance resource by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteOpaInstanceRequest
+     * @return DeleteOpaInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/DeleteOpaInstance.ts.html |here} to see how to use DeleteOpaInstance API.
+     */
+    deleteOpaInstance(deleteOpaInstanceRequest: requests.DeleteOpaInstanceRequest): Promise<responses.DeleteOpaInstanceResponse>;
+    /**
+     * Gets a OpaInstance by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetOpaInstanceRequest
+     * @return GetOpaInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/GetOpaInstance.ts.html |here} to see how to use GetOpaInstance API.
+     */
+    getOpaInstance(getOpaInstanceRequest: requests.GetOpaInstanceRequest): Promise<responses.GetOpaInstanceResponse>;
+    /**
+     * Gets the status of the work request with the given ID.
+     * 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.35.1/opa/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Returns a list of OpaInstances.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListOpaInstancesRequest
+     * @return ListOpaInstancesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/ListOpaInstances.ts.html |here} to see how to use ListOpaInstances API.
+     */
+    listOpaInstances(listOpaInstancesRequest: requests.ListOpaInstancesRequest): Promise<responses.ListOpaInstancesResponse>;
+    /**
+     * Return a (paginated) list of errors for a given 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/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 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.35.1/opa/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 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.35.1/opa/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates the OpaInstance
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateOpaInstanceRequest
+     * @return UpdateOpaInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.35.1/opa/UpdateOpaInstance.ts.html |here} to see how to use UpdateOpaInstance API.
+     */
+    updateOpaInstance(updateOpaInstanceRequest: requests.UpdateOpaInstanceRequest): Promise<responses.UpdateOpaInstanceResponse>;
+}