@alicloud/emr-serverless-spark20230808 2.1.0 → 2.2.0

package/dist/client.js

@@ -820,7 +820,7 @@ class Client extends openapi_core_1.default {
         return await this.createRayClusterWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Creates a session cluster.
+     * Creates a session.
      *
      * @param request - CreateSessionClusterRequest
      * @param headers - map
@@ -889,7 +889,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateSessionClusterResponse({}));
     }
     /**
-     * Creates a session cluster.
+     * Creates a session.
      *
      * @param request - CreateSessionClusterRequest
      * @returns CreateSessionClusterResponse
@@ -900,7 +900,7 @@ class Client extends openapi_core_1.default {
         return await this.createSessionClusterWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Creates an SQL statement.
+     * Creates an SQL query.
      *
      * @param request - CreateSqlStatementRequest
      * @param headers - map
@@ -951,7 +951,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateSqlStatementResponse({}));
     }
     /**
-     * Creates an SQL statement.
+     * Creates an SQL query.
      *
      * @param request - CreateSqlStatementRequest
      * @returns CreateSqlStatementResponse
@@ -1478,7 +1478,7 @@ class Client extends openapi_core_1.default {
         return await this.generateTaskCodesWithOptions(bizId, request, headers, runtime);
     }
     /**
-     * Gets the state of an AI center.
+     * Retrieves the status of AI Hub.
      *
      * @param request - GetAICenterStateRequest
      * @param headers - map
@@ -1504,7 +1504,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetAICenterStateResponse({}));
     }
     /**
-     * Gets the state of an AI center.
+     * Retrieves the status of AI Hub.
      *
      * @param request - GetAICenterStateRequest
      * @returns GetAICenterStateResponse
@@ -1602,7 +1602,7 @@ class Client extends openapi_core_1.default {
         return await this.getCuHoursWithOptions(workspaceId, queue, request, headers, runtime);
     }
     /**
-     * Obtains job analysis information on E-MapReduce (EMR) Doctor.
+     * Retrieves the diagnostic information for a Serverless Spark job.
      *
      * @param request - GetDoctorApplicationRequest
      * @param headers - map
@@ -1639,7 +1639,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetDoctorApplicationResponse({}));
     }
     /**
-     * Obtains job analysis information on E-MapReduce (EMR) Doctor.
+     * Retrieves the diagnostic information for a Serverless Spark job.
      *
      * @param request - GetDoctorApplicationRequest
      * @returns GetDoctorApplicationResponse
@@ -1650,7 +1650,7 @@ class Client extends openapi_core_1.default {
         return await this.getDoctorApplicationWithOptions(workspaceId, runId, request, headers, runtime);
     }
     /**
-     * Retrieves the details of a job run by calling GetJobRun.
+     * Retrieves the details of a Spark job run by calling GetJobRun.
      *
      * @param request - GetJobRunRequest
      * @param headers - map
@@ -1681,7 +1681,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetJobRunResponse({}));
     }
     /**
-     * Retrieves the details of a job run by calling GetJobRun.
+     * Retrieves the details of a Spark job run by calling GetJobRun.
      *
      * @param request - GetJobRunRequest
      * @returns GetJobRunResponse
@@ -1692,7 +1692,7 @@ class Client extends openapi_core_1.default {
         return await this.getJobRunWithOptions(workspaceId, jobRunId, request, headers, runtime);
     }
     /**
-     * Retrieves the details of a Kyuubi Gateway.
+     * Retrieves a Kyuubi Gateway.
      *
      * @param headers - map
      * @param runtime - runtime options for this request RuntimeOptions
@@ -1716,7 +1716,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetKyuubiServiceResponse({}));
     }
     /**
-     * Retrieves the details of a Kyuubi Gateway.
+     * Retrieves a Kyuubi Gateway.
      * @returns GetKyuubiServiceResponse
      */
     async getKyuubiService(workspaceId, kyuubiServiceId) {
@@ -1725,7 +1725,7 @@ class Client extends openapi_core_1.default {
         return await this.getKyuubiServiceWithOptions(workspaceId, kyuubiServiceId, headers, runtime);
     }
     /**
-     * Obtains an authentication token for Kyuubi Gateway.
+     * Retrieves the Kyuubi Gateway authentication token.
      *
      * @param request - GetKyuubiTokenRequest
      * @param headers - map
@@ -1756,7 +1756,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetKyuubiTokenResponse({}));
     }
     /**
-     * Obtains an authentication token for Kyuubi Gateway.
+     * Retrieves the Kyuubi Gateway authentication token.
      *
      * @param request - GetKyuubiTokenRequest
      * @returns GetKyuubiTokenResponse
@@ -1767,7 +1767,7 @@ class Client extends openapi_core_1.default {
         return await this.getKyuubiTokenWithOptions(workspaceId, kyuubiServiceId, tokenId, request, headers, runtime);
     }
     /**
-     * Retrieves information about a Livy Gateway.
+     * Retrieves the Livy Gateway information.
      *
      * @param request - GetLivyComputeRequest
      * @param headers - map
@@ -1798,7 +1798,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetLivyComputeResponse({}));
     }
     /**
-     * Retrieves information about a Livy Gateway.
+     * Retrieves the Livy Gateway information.
      *
      * @param request - GetLivyComputeRequest
      * @returns GetLivyComputeResponse
@@ -1809,7 +1809,7 @@ class Client extends openapi_core_1.default {
         return await this.getLivyComputeWithOptions(workspaceBizId, livyComputeId, request, headers, runtime);
     }
     /**
-     * Retrieves a token for a Livy Gateway.
+     * Retrieves the token for a Livy Gateway.
      *
      * @param request - GetLivyComputeTokenRequest
      * @param headers - map
@@ -1840,7 +1840,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetLivyComputeTokenResponse({}));
     }
     /**
-     * Retrieves a token for a Livy Gateway.
+     * Retrieves the token for a Livy Gateway.
      *
      * @param request - GetLivyComputeTokenRequest
      * @returns GetLivyComputeTokenResponse
@@ -2008,7 +2008,7 @@ class Client extends openapi_core_1.default {
         return await this.getRunConfigurationWithOptions(workspaceId, runId, request, headers, runtime);
     }
     /**
-     * Retrieves session details.
+     * Retrieves the details of a session.
      *
      * @param request - GetSessionClusterRequest
      * @param headers - map
@@ -2039,7 +2039,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetSessionClusterResponse({}));
     }
     /**
-     * Retrieves session details.
+     * Retrieves the details of a session.
      *
      * @param request - GetSessionClusterRequest
      * @returns GetSessionClusterResponse
@@ -2139,6 +2139,48 @@ class Client extends openapi_core_1.default {
         let headers = {};
         return await this.getTemplateWithOptions(workspaceBizId, request, headers, runtime);
     }
+    /**
+     * Retrieves the details of a workspace.
+     *
+     * @param request - GetWorkspaceRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns GetWorkspaceResponse
+     */
+    async getWorkspaceWithOptions(workspaceId, request, headers, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.regionId)) {
+            query["regionId"] = request.regionId;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            headers: headers,
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "GetWorkspace",
+            version: "2023-08-08",
+            protocol: "HTTPS",
+            pathname: `/api/v1/workspaces/${$dara.URL.percentEncode(workspaceId)}`,
+            method: "GET",
+            authType: "AK",
+            style: "ROA",
+            reqBodyType: "json",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetWorkspaceResponse({}));
+    }
+    /**
+     * Retrieves the details of a workspace.
+     *
+     * @param request - GetWorkspaceRequest
+     * @returns GetWorkspaceResponse
+     */
+    async getWorkspace(workspaceId, request) {
+        let runtime = new $dara.RuntimeOptions({});
+        let headers = {};
+        return await this.getWorkspaceWithOptions(workspaceId, request, headers, runtime);
+    }
     /**
      * Assigns a specified role to users.
      *
@@ -2235,7 +2277,7 @@ class Client extends openapi_core_1.default {
         return await this.listCatalogsWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Lists the log files for a job executor.
+     * Lists the log files of a job executor.
      *
      * @param request - ListExecutorLogsRequest
      * @param headers - map
@@ -2275,7 +2317,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListExecutorLogsResponse({}));
     }
     /**
-     * Lists the log files for a job executor.
+     * Lists the log files of a job executor.
      *
      * @param request - ListExecutorLogsRequest
      * @returns ListExecutorLogsResponse
@@ -2340,7 +2382,7 @@ class Client extends openapi_core_1.default {
         return await this.listJobExecutorsWithOptions(workspaceId, jobRunId, request, headers, runtime);
     }
     /**
-     * Queries a list of Spark jobs.
+     * Lists Spark job runs.
      *
      * @param tmpReq - ListJobRunsRequest
      * @param headers - map
@@ -2433,7 +2475,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListJobRunsResponse({}));
     }
     /**
-     * Queries a list of Spark jobs.
+     * Lists Spark job runs.
      *
      * @param request - ListJobRunsRequest
      * @returns ListJobRunsResponse
@@ -2486,7 +2528,7 @@ class Client extends openapi_core_1.default {
         return await this.listKyuubiServicesWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Lists Kyuubi Spark applications.
+     * Queries the Spark applications submitted by Kyuubi.
      *
      * @param tmpReq - ListKyuubiSparkApplicationsRequest
      * @param headers - map
@@ -2561,7 +2603,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListKyuubiSparkApplicationsResponse({}));
     }
     /**
-     * Lists Kyuubi Spark applications.
+     * Queries the Spark applications submitted by Kyuubi.
      *
      * @param request - ListKyuubiSparkApplicationsRequest
      * @returns ListKyuubiSparkApplicationsResponse
@@ -2572,7 +2614,7 @@ class Client extends openapi_core_1.default {
         return await this.listKyuubiSparkApplicationsWithOptions(workspaceId, kyuubiServiceId, request, headers, runtime);
     }
     /**
-     * Lists KyuubiServer authentication tokens.
+     * Lists the Kyuubi Server authentication tokens.
      *
      * @param request - ListKyuubiTokenRequest
      * @param headers - map
@@ -2603,7 +2645,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListKyuubiTokenResponse({}));
     }
     /**
-     * Lists KyuubiServer authentication tokens.
+     * Lists the Kyuubi Server authentication tokens.
      *
      * @param request - ListKyuubiTokenRequest
      * @returns ListKyuubiTokenResponse
@@ -2614,7 +2656,7 @@ class Client extends openapi_core_1.default {
         return await this.listKyuubiTokenWithOptions(workspaceId, kyuubiServiceId, request, headers, runtime);
     }
     /**
-     * Lists Livy Gateways.
+     * Lists Livy gateways.
      *
      * @param request - ListLivyComputeRequest
      * @param headers - map
@@ -2648,7 +2690,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListLivyComputeResponse({}));
     }
     /**
-     * Lists Livy Gateways.
+     * Lists Livy gateways.
      *
      * @param request - ListLivyComputeRequest
      * @returns ListLivyComputeResponse
@@ -2659,7 +2701,7 @@ class Client extends openapi_core_1.default {
         return await this.listLivyComputeWithOptions(workspaceBizId, request, headers, runtime);
     }
     /**
-     * Lists the historical sessions for a Livy Gateway.
+     * Retrieves the historical sessions of a Livy Gateway.
      *
      * @param request - ListLivyComputeSessionsRequest
      * @param headers - map
@@ -2696,7 +2738,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListLivyComputeSessionsResponse({}));
     }
     /**
-     * Lists the historical sessions for a Livy Gateway.
+     * Retrieves the historical sessions of a Livy Gateway.
      *
      * @param request - ListLivyComputeSessionsRequest
      * @returns ListLivyComputeSessionsResponse
@@ -2707,7 +2749,7 @@ class Client extends openapi_core_1.default {
         return await this.listLivyComputeSessionsWithOptions(workspaceId, livyComputeId, request, headers, runtime);
     }
     /**
-     * Lists the tokens of a Livy Gateway.
+     * Lists the tokens of a Livy gateway.
      *
      * @param request - ListLivyComputeTokenRequest
      * @param headers - map
@@ -2738,7 +2780,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListLivyComputeTokenResponse({}));
     }
     /**
-     * Lists the tokens of a Livy Gateway.
+     * Lists the tokens of a Livy gateway.
      *
      * @param request - ListLivyComputeTokenRequest
      * @returns ListLivyComputeTokenResponse
@@ -2800,7 +2842,7 @@ class Client extends openapi_core_1.default {
         return await this.listLogContentsWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Retrieves the list of members in the workspace.
+     * Queries the list of members in a workspace.
      *
      * @param request - ListMembersRequest
      * @param headers - map
@@ -2837,7 +2879,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListMembersResponse({}));
     }
     /**
-     * Retrieves the list of members in the workspace.
+     * Queries the list of members in a workspace.
      *
      * @param request - ListMembersRequest
      * @returns ListMembersResponse
@@ -2889,6 +2931,51 @@ class Client extends openapi_core_1.default {
         let headers = {};
         return await this.listNetworkServicesWithOptions(workspaceId, request, headers, runtime);
     }
+    /**
+     * Queries the jobs with the highest CU usage in a queue.
+     *
+     * @param request - ListQueueTopJobsRequest
+     * @param headers - map
+     * @param runtime - runtime options for this request RuntimeOptions
+     * @returns ListQueueTopJobsResponse
+     */
+    async listQueueTopJobsWithOptions(workspaceId, queueName, request, headers, runtime) {
+        request.validate();
+        let query = {};
+        if (!$dara.isNull(request.regionId)) {
+            query["regionId"] = request.regionId;
+        }
+        if (!$dara.isNull(request.topN)) {
+            query["topN"] = request.topN;
+        }
+        let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
+            headers: headers,
+            query: openapi_core_2.OpenApiUtil.query(query),
+        });
+        let params = new openapi_core_2.$OpenApiUtil.Params({
+            action: "ListQueueTopJobs",
+            version: "2023-08-08",
+            protocol: "HTTPS",
+            pathname: `/api/v1/workspaces/${$dara.URL.percentEncode(workspaceId)}/queues/${$dara.URL.percentEncode(queueName)}/topJobs`,
+            method: "GET",
+            authType: "AK",
+            style: "ROA",
+            reqBodyType: "json",
+            bodyType: "json",
+        });
+        return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListQueueTopJobsResponse({}));
+    }
+    /**
+     * Queries the jobs with the highest CU usage in a queue.
+     *
+     * @param request - ListQueueTopJobsRequest
+     * @returns ListQueueTopJobsResponse
+     */
+    async listQueueTopJobs(workspaceId, queueName, request) {
+        let runtime = new $dara.RuntimeOptions({});
+        let headers = {};
+        return await this.listQueueTopJobsWithOptions(workspaceId, queueName, request, headers, runtime);
+    }
     /**
      * Lists Ray clusters.
      *
@@ -2935,7 +3022,7 @@ class Client extends openapi_core_1.default {
         return await this.listRayClusterWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Lists Ray Job information.
+     * Lists Ray job information.
      *
      * @param tmpReq - ListRayJobRequest
      * @param headers - map
@@ -2986,7 +3073,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListRayJobResponse({}));
     }
     /**
-     * Lists Ray Job information.
+     * Lists Ray job information.
      *
      * @param request - ListRayJobRequest
      * @returns ListRayJobResponse
@@ -3108,7 +3195,7 @@ class Client extends openapi_core_1.default {
         return await this.listReleaseVersionsWithOptions(request, headers, runtime);
     }
     /**
-     * Retrieves a list of session clusters.
+     * Retrieves a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @param headers - map
@@ -3154,7 +3241,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListSessionClustersResponse({}));
     }
     /**
-     * Retrieves a list of session clusters.
+     * Retrieves a list of sessions.
      *
      * @param request - ListSessionClustersRequest
      * @returns ListSessionClustersResponse
@@ -3255,7 +3342,7 @@ class Client extends openapi_core_1.default {
         return await this.listTemplateWithOptions(workspaceBizId, request, headers, runtime);
     }
     /**
-     * Queries the list of queues in a workspace.
+     * Queries the queues in a workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @param headers - map
@@ -3289,7 +3376,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListWorkspaceQueuesResponse({}));
     }
     /**
-     * Queries the list of queues in a workspace.
+     * Queries the queues in a workspace.
      *
      * @param request - ListWorkspaceQueuesRequest
      * @returns ListWorkspaceQueuesResponse
@@ -3300,7 +3387,7 @@ class Client extends openapi_core_1.default {
         return await this.listWorkspaceQueuesWithOptions(workspaceId, request, headers, runtime);
     }
     /**
-     * Queries a list of workspaces.
+     * Retrieves a list of workspaces.
      *
      * @param tmpReq - ListWorkspacesRequest
      * @param headers - map
@@ -3354,7 +3441,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListWorkspacesResponse({}));
     }
     /**
-     * Queries a list of workspaces.
+     * Retrieves a list of workspaces.
      *
      * @param request - ListWorkspacesRequest
      * @returns ListWorkspacesResponse
@@ -4438,7 +4525,7 @@ class Client extends openapi_core_1.default {
         return await this.updateLivyComputeWithOptions(workspaceBizId, livyComputeId, request, headers, runtime);
     }
     /**
-     * Updates a workflow definition and its timed scheduling.
+     * Updates the workflow definition and timed scheduling.
      *
      * @param tmpReq - UpdateProcessDefinitionWithScheduleRequest
      * @param headers - map
@@ -4537,7 +4624,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateProcessDefinitionWithScheduleResponse({}));
     }
     /**
-     * Updates a workflow definition and its timed scheduling.
+     * Updates the workflow definition and timed scheduling.
      *
      * @param request - UpdateProcessDefinitionWithScheduleRequest
      * @returns UpdateProcessDefinitionWithScheduleResponse
@@ -4611,7 +4698,7 @@ class Client extends openapi_core_1.default {
         return await this.updateRayClusterWithOptions(workspaceId, clusterId, request, headers, runtime);
     }
     /**
-     * Updates the properties of a workspace.
+     * Updates the attributes of a workspace.
      *
      * @param request - UpdateWorkspaceRequest
      * @param headers - map
@@ -4671,7 +4758,7 @@ class Client extends openapi_core_1.default {
         return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateWorkspaceResponse({}));
     }
     /**
-     * Updates the properties of a workspace.
+     * Updates the attributes of a workspace.
      *
      * @param request - UpdateWorkspaceRequest
      * @returns UpdateWorkspaceResponse