oci-dataflow 2.5.2 → 2.8.0

package/lib/client.d.ts

@@ -18,6 +18,9 @@ import * as responses from "./response";
 import { DataFlowWaiter } from "./dataflow-waiter";
 export declare enum DataFlowApiKeys {
 }
+/**
+ * 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 DataFlowClient {
     protected static serviceEndpointTemplate: string;
     protected "_endpoint": string;
@@ -69,19 +72,21 @@ export declare class DataFlowClient {
      * Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.
      * Associated resources, like runs, will not be automatically moved.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeApplicationCompartmentRequest
      * @return ChangeApplicationCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ChangeApplicationCompartment.ts.html |here} to see how to use ChangeApplicationCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ChangeApplicationCompartment.ts.html |here} to see how to use ChangeApplicationCompartment API.
      */
     changeApplicationCompartment(changeApplicationCompartmentRequest: requests.ChangeApplicationCompartmentRequest): Promise<responses.ChangeApplicationCompartmentResponse>;
     /**
      * Moves a private endpoint into a different compartment. 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 ChangePrivateEndpointCompartmentRequest
      * @return ChangePrivateEndpointCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ChangePrivateEndpointCompartment.ts.html |here} to see how to use ChangePrivateEndpointCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ChangePrivateEndpointCompartment.ts.html |here} to see how to use ChangePrivateEndpointCompartment API.
      */
     changePrivateEndpointCompartment(changePrivateEndpointCompartmentRequest: requests.ChangePrivateEndpointCompartmentRequest): Promise<responses.ChangePrivateEndpointCompartmentResponse>;
     /**
@@ -90,119 +95,132 @@ export declare class DataFlowClient {
      * automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in
      * order for it to be moved to a different compartment
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeRunCompartmentRequest
      * @return ChangeRunCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ChangeRunCompartment.ts.html |here} to see how to use ChangeRunCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ChangeRunCompartment.ts.html |here} to see how to use ChangeRunCompartment API.
      */
     changeRunCompartment(changeRunCompartmentRequest: requests.ChangeRunCompartmentRequest): Promise<responses.ChangeRunCompartmentResponse>;
     /**
      * Creates an application.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateApplicationRequest
      * @return CreateApplicationResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/CreateApplication.ts.html |here} to see how to use CreateApplication API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/CreateApplication.ts.html |here} to see how to use CreateApplication API.
      */
     createApplication(createApplicationRequest: requests.CreateApplicationRequest): Promise<responses.CreateApplicationResponse>;
     /**
      * Creates a private endpoint to be used by applications.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreatePrivateEndpointRequest
      * @return CreatePrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/CreatePrivateEndpoint.ts.html |here} to see how to use CreatePrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/CreatePrivateEndpoint.ts.html |here} to see how to use CreatePrivateEndpoint API.
      */
     createPrivateEndpoint(createPrivateEndpointRequest: requests.CreatePrivateEndpointRequest): Promise<responses.CreatePrivateEndpointResponse>;
     /**
      * Creates a run for an application.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateRunRequest
      * @return CreateRunResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/CreateRun.ts.html |here} to see how to use CreateRun API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/CreateRun.ts.html |here} to see how to use CreateRun API.
      */
     createRun(createRunRequest: requests.CreateRunRequest): Promise<responses.CreateRunResponse>;
     /**
      * Deletes an application using an `applicationId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteApplicationRequest
      * @return DeleteApplicationResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/DeleteApplication.ts.html |here} to see how to use DeleteApplication API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/DeleteApplication.ts.html |here} to see how to use DeleteApplication API.
      */
     deleteApplication(deleteApplicationRequest: requests.DeleteApplicationRequest): Promise<responses.DeleteApplicationResponse>;
     /**
      * Deletes a private endpoint using a `privateEndpointId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeletePrivateEndpointRequest
      * @return DeletePrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/DeletePrivateEndpoint.ts.html |here} to see how to use DeletePrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/DeletePrivateEndpoint.ts.html |here} to see how to use DeletePrivateEndpoint API.
      */
     deletePrivateEndpoint(deletePrivateEndpointRequest: requests.DeletePrivateEndpointRequest): Promise<responses.DeletePrivateEndpointResponse>;
     /**
      * Cancels the specified run if it has not already completed or was previously cancelled.
      * If a run is in progress, the executing job will be killed.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteRunRequest
      * @return DeleteRunResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/DeleteRun.ts.html |here} to see how to use DeleteRun API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/DeleteRun.ts.html |here} to see how to use DeleteRun API.
      */
     deleteRun(deleteRunRequest: requests.DeleteRunRequest): Promise<responses.DeleteRunResponse>;
     /**
      * Retrieves an application using an `applicationId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetApplicationRequest
      * @return GetApplicationResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/GetApplication.ts.html |here} to see how to use GetApplication API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/GetApplication.ts.html |here} to see how to use GetApplication API.
      */
     getApplication(getApplicationRequest: requests.GetApplicationRequest): Promise<responses.GetApplicationResponse>;
     /**
      * Retrieves an private endpoint using a `privateEndpointId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetPrivateEndpointRequest
      * @return GetPrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/GetPrivateEndpoint.ts.html |here} to see how to use GetPrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/GetPrivateEndpoint.ts.html |here} to see how to use GetPrivateEndpoint API.
      */
     getPrivateEndpoint(getPrivateEndpointRequest: requests.GetPrivateEndpointRequest): Promise<responses.GetPrivateEndpointResponse>;
     /**
      * Retrieves the run for the specified `runId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetRunRequest
      * @return GetRunResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/GetRun.ts.html |here} to see how to use GetRun API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/GetRun.ts.html |here} to see how to use GetRun API.
      */
     getRun(getRunRequest: requests.GetRunRequest): Promise<responses.GetRunResponse>;
     /**
      * Retrieves the content of an run log.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetRunLogRequest
      * @return GetRunLogResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/GetRunLog.ts.html |here} to see how to use GetRunLog API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/GetRunLog.ts.html |here} to see how to use GetRunLog API.
      */
     getRunLog(getRunLogRequest: requests.GetRunLogRequest): Promise<responses.GetRunLogResponse>;
     /**
      * Gets the status of the work request 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.5.2/dataflow/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
      * Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListApplicationsRequest
      * @return ListApplicationsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ListApplications.ts.html |here} to see how to use ListApplications API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ListApplications.ts.html |here} to see how to use ListApplications API.
      */
     listApplications(listApplicationsRequest: requests.ListApplicationsRequest): Promise<responses.ListApplicationsResponse>;
     /**
@@ -240,19 +258,21 @@ export declare class DataFlowClient {
     /**
      * Lists all private endpoints in the specified compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListPrivateEndpointsRequest
      * @return ListPrivateEndpointsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ListPrivateEndpoints.ts.html |here} to see how to use ListPrivateEndpoints API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ListPrivateEndpoints.ts.html |here} to see how to use ListPrivateEndpoints API.
      */
     listPrivateEndpoints(listPrivateEndpointsRequest: requests.ListPrivateEndpointsRequest): Promise<responses.ListPrivateEndpointsResponse>;
     /**
      * Retrieves summaries of the run's logs.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListRunLogsRequest
      * @return ListRunLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ListRunLogs.ts.html |here} to see how to use ListRunLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ListRunLogs.ts.html |here} to see how to use ListRunLogs API.
      */
     listRunLogs(listRunLogsRequest: requests.ListRunLogsRequest): Promise<responses.ListRunLogsResponse>;
     /**
@@ -290,10 +310,11 @@ export declare class DataFlowClient {
     /**
      * Lists all runs of an application in the specified compartment.  Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListRunsRequest
      * @return ListRunsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/ListRuns.ts.html |here} to see how to use ListRuns API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ListRuns.ts.html |here} to see how to use ListRuns API.
      */
     listRuns(listRunsRequest: requests.ListRunsRequest): Promise<responses.ListRunsResponse>;
     /**
@@ -331,37 +352,41 @@ export declare class DataFlowClient {
     /**
      * 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.5.2/dataflow/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/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.5.2/dataflow/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/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.5.2/dataflow/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
      * Updates an application using an `applicationId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateApplicationRequest
      * @return UpdateApplicationResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/UpdateApplication.ts.html |here} to see how to use UpdateApplication API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/UpdateApplication.ts.html |here} to see how to use UpdateApplication API.
      */
     updateApplication(updateApplicationRequest: requests.UpdateApplicationRequest): Promise<responses.UpdateApplicationResponse>;
     /**
@@ -369,19 +394,21 @@ export declare class DataFlowClient {
      * a previously defined private endpoint, then a 409 status code will be returned.  This indicates
      * that a conflict has been detected.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdatePrivateEndpointRequest
      * @return UpdatePrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/UpdatePrivateEndpoint.ts.html |here} to see how to use UpdatePrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/UpdatePrivateEndpoint.ts.html |here} to see how to use UpdatePrivateEndpoint API.
      */
     updatePrivateEndpoint(updatePrivateEndpointRequest: requests.UpdatePrivateEndpointRequest): Promise<responses.UpdatePrivateEndpointResponse>;
     /**
      * Updates a run using a `runId`.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateRunRequest
      * @return UpdateRunResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/dataflow/UpdateRun.ts.html |here} to see how to use UpdateRun API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/dataflow/UpdateRun.ts.html |here} to see how to use UpdateRun API.
      */
     updateRun(updateRunRequest: requests.UpdateRunRequest): Promise<responses.UpdateRunResponse>;
 }