oci-dataflow 2.38.0 → 2.39.0

package/lib/client.d.ts

@@ -79,7 +79,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/ChangeApplicationCompartment.ts.html |here} to see how to use ChangeApplicationCompartment API.
      */
     changeApplicationCompartment(changeApplicationCompartmentRequest: requests.ChangeApplicationCompartmentRequest): Promise<responses.ChangeApplicationCompartmentResponse>;
     /**
@@ -89,7 +89,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/ChangePrivateEndpointCompartment.ts.html |here} to see how to use ChangePrivateEndpointCompartment API.
      */
     changePrivateEndpointCompartment(changePrivateEndpointCompartmentRequest: requests.ChangePrivateEndpointCompartmentRequest): Promise<responses.ChangePrivateEndpointCompartmentResponse>;
     /**
@@ -102,7 +102,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/ChangeRunCompartment.ts.html |here} to see how to use ChangeRunCompartment API.
      */
     changeRunCompartment(changeRunCompartmentRequest: requests.ChangeRunCompartmentRequest): Promise<responses.ChangeRunCompartmentResponse>;
     /**
@@ -112,7 +112,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/CreateApplication.ts.html |here} to see how to use CreateApplication API.
      */
     createApplication(createApplicationRequest: requests.CreateApplicationRequest): Promise<responses.CreateApplicationResponse>;
     /**
@@ -122,7 +122,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/CreatePrivateEndpoint.ts.html |here} to see how to use CreatePrivateEndpoint API.
      */
     createPrivateEndpoint(createPrivateEndpointRequest: requests.CreatePrivateEndpointRequest): Promise<responses.CreatePrivateEndpointResponse>;
     /**
@@ -132,7 +132,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/CreateRun.ts.html |here} to see how to use CreateRun API.
      */
     createRun(createRunRequest: requests.CreateRunRequest): Promise<responses.CreateRunResponse>;
     /**
@@ -142,7 +142,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/DeleteApplication.ts.html |here} to see how to use DeleteApplication API.
      */
     deleteApplication(deleteApplicationRequest: requests.DeleteApplicationRequest): Promise<responses.DeleteApplicationResponse>;
     /**
@@ -152,7 +152,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/DeletePrivateEndpoint.ts.html |here} to see how to use DeletePrivateEndpoint API.
      */
     deletePrivateEndpoint(deletePrivateEndpointRequest: requests.DeletePrivateEndpointRequest): Promise<responses.DeletePrivateEndpointResponse>;
     /**
@@ -163,67 +163,67 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.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.
+     * 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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.0/dataflow/ListApplications.ts.html |here} to see how to use ListApplications API.
      */
     listApplications(listApplicationsRequest: requests.ListApplicationsRequest): Promise<responses.ListApplicationsResponse>;
     /**
@@ -259,23 +259,23 @@ export declare class DataFlowClient {
      */
     listApplicationsResponseIterator(request: requests.ListApplicationsRequest): AsyncIterableIterator<responses.ListApplicationsResponse>;
     /**
-     * Lists all private endpoints in the specified compartment.
+     * Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with 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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.0/dataflow/ListRunLogs.ts.html |here} to see how to use ListRunLogs API.
      */
     listRunLogs(listRunLogsRequest: requests.ListRunLogsRequest): Promise<responses.ListRunLogsResponse>;
     /**
@@ -313,11 +313,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.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @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.38.0/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.39.0/dataflow/ListRuns.ts.html |here} to see how to use ListRuns API.
      */
     listRuns(listRunsRequest: requests.ListRunsRequest): Promise<responses.ListRunsResponse>;
     /**
@@ -355,31 +355,31 @@ 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.
+     * 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.38.0/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.39.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.
+     * 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.38.0/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.39.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.
+     * 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.38.0/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.39.0/dataflow/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
@@ -389,7 +389,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/UpdateApplication.ts.html |here} to see how to use UpdateApplication API.
      */
     updateApplication(updateApplicationRequest: requests.UpdateApplicationRequest): Promise<responses.UpdateApplicationResponse>;
     /**
@@ -401,7 +401,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/UpdatePrivateEndpoint.ts.html |here} to see how to use UpdatePrivateEndpoint API.
      */
     updatePrivateEndpoint(updatePrivateEndpointRequest: requests.UpdatePrivateEndpointRequest): Promise<responses.UpdatePrivateEndpointResponse>;
     /**
@@ -411,7 +411,7 @@ export declare class DataFlowClient {
      * @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.38.0/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.39.0/dataflow/UpdateRun.ts.html |here} to see how to use UpdateRun API.
      */
     updateRun(updateRunRequest: requests.UpdateRunRequest): Promise<responses.UpdateRunResponse>;
 }