@azure/synapse-spark 1.0.0-alpha.20241125.1 → 1.0.0-alpha.20241127.1

package/package.json

@@ -5,11 +5,11 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/synapse/synapse-spark/README.md",
   "repository": "github:Azure/azure-sdk-for-js",
   "sdk-type": "client",
-  "version": "1.0.0-alpha.20241125.1",
+  "version": "1.0.0-alpha.20241127.1",
   "dependencies": {
     "@azure/core-auth": "^1.9.0",
     "@azure/core-client": "^1.9.2",
-    "@azure/core-rest-pipeline": ">=1.18.0-alpha <1.18.0-alphb",
+    "@azure/core-rest-pipeline": "^1.18.0",
     "@azure/core-tracing": "^1.2.0",
     "tslib": "^2.8.1"
   },

package/dist/synapse-spark.d.ts

@@ -1,716 +0,0 @@
-import type * as coreAuth from '@azure/core-auth';
-import * as coreClient from '@azure/core-client';
-
-/** Known values of {@link LivyStatementStates} that the service accepts. */
-export declare enum KnownLivyStatementStates {
-    /** Waiting */
-    Waiting = "waiting",
-    /** Running */
-    Running = "running",
-    /** Available */
-    Available = "available",
-    /** Error */
-    Error = "error",
-    /** Cancelling */
-    Cancelling = "cancelling",
-    /** Cancelled */
-    Cancelled = "cancelled"
-}
-
-/** Known values of {@link LivyStates} that the service accepts. */
-export declare enum KnownLivyStates {
-    /** NotStarted */
-    NotStarted = "not_started",
-    /** Starting */
-    Starting = "starting",
-    /** Idle */
-    Idle = "idle",
-    /** Busy */
-    Busy = "busy",
-    /** ShuttingDown */
-    ShuttingDown = "shutting_down",
-    /** Error */
-    Error = "error",
-    /** Dead */
-    Dead = "dead",
-    /** Killed */
-    Killed = "killed",
-    /** Success */
-    Success = "success",
-    /** Running */
-    Running = "running",
-    /** Recovering */
-    Recovering = "recovering"
-}
-
-/** Known values of {@link PluginCurrentState} that the service accepts. */
-export declare enum KnownPluginCurrentState {
-    /** Preparation */
-    Preparation = "Preparation",
-    /** ResourceAcquisition */
-    ResourceAcquisition = "ResourceAcquisition",
-    /** Queued */
-    Queued = "Queued",
-    /** Submission */
-    Submission = "Submission",
-    /** Monitoring */
-    Monitoring = "Monitoring",
-    /** Cleanup */
-    Cleanup = "Cleanup",
-    /** Ended */
-    Ended = "Ended"
-}
-
-/** Known values of {@link SchedulerCurrentState} that the service accepts. */
-export declare enum KnownSchedulerCurrentState {
-    /** Queued */
-    Queued = "Queued",
-    /** Scheduled */
-    Scheduled = "Scheduled",
-    /** Ended */
-    Ended = "Ended"
-}
-
-/** Known values of {@link SparkBatchJobResultType} that the service accepts. */
-export declare enum KnownSparkBatchJobResultType {
-    /** Uncertain */
-    Uncertain = "Uncertain",
-    /** Succeeded */
-    Succeeded = "Succeeded",
-    /** Failed */
-    Failed = "Failed",
-    /** Cancelled */
-    Cancelled = "Cancelled"
-}
-
-/** Known values of {@link SparkErrorSource} that the service accepts. */
-export declare enum KnownSparkErrorSource {
-    /** System */
-    System = "System",
-    /** User */
-    User = "User",
-    /** Unknown */
-    Unknown = "Unknown",
-    /** Dependency */
-    Dependency = "Dependency"
-}
-
-/** Known values of {@link SparkJobType} that the service accepts. */
-export declare enum KnownSparkJobType {
-    /** SparkBatch */
-    SparkBatch = "SparkBatch",
-    /** SparkSession */
-    SparkSession = "SparkSession"
-}
-
-/** Known values of {@link SparkSessionResultType} that the service accepts. */
-export declare enum KnownSparkSessionResultType {
-    /** Uncertain */
-    Uncertain = "Uncertain",
-    /** Succeeded */
-    Succeeded = "Succeeded",
-    /** Failed */
-    Failed = "Failed",
-    /** Cancelled */
-    Cancelled = "Cancelled"
-}
-
-/** Known values of {@link SparkStatementLanguageType} that the service accepts. */
-export declare enum KnownSparkStatementLanguageType {
-    /** Spark */
-    Spark = "spark",
-    /** PySpark */
-    PySpark = "pyspark",
-    /** DotNetSpark */
-    DotNetSpark = "dotnetspark",
-    /** Sql */
-    Sql = "sql"
-}
-
-/**
- * Defines values for LivyStatementStates.
- * {@link KnownLivyStatementStates} can be used interchangeably with LivyStatementStates,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **waiting**
- * **running**
- * **available**
- * **error**
- * **cancelling**
- * **cancelled**
- */
-export declare type LivyStatementStates = string;
-
-/**
- * Defines values for LivyStates.
- * {@link KnownLivyStates} can be used interchangeably with LivyStates,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **not_started**
- * **starting**
- * **idle**
- * **busy**
- * **shutting_down**
- * **error**
- * **dead**
- * **killed**
- * **success**
- * **running**
- * **recovering**
- */
-export declare type LivyStates = string;
-
-/**
- * Defines values for PluginCurrentState.
- * {@link KnownPluginCurrentState} can be used interchangeably with PluginCurrentState,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Preparation**
- * **ResourceAcquisition**
- * **Queued**
- * **Submission**
- * **Monitoring**
- * **Cleanup**
- * **Ended**
- */
-export declare type PluginCurrentState = string;
-
-/**
- * Defines values for SchedulerCurrentState.
- * {@link KnownSchedulerCurrentState} can be used interchangeably with SchedulerCurrentState,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Queued**
- * **Scheduled**
- * **Ended**
- */
-export declare type SchedulerCurrentState = string;
-
-/** Interface representing a SparkBatch. */
-export declare interface SparkBatch {
-    /**
-     * List all spark batch jobs which are running under a particular spark pool.
-     * @param options - The options parameters.
-     */
-    getSparkBatchJobs(options?: SparkBatchGetSparkBatchJobsOptionalParams): Promise<SparkBatchGetSparkBatchJobsResponse>;
-    /**
-     * Create new spark batch job.
-     * @param sparkBatchJobOptions - Livy compatible batch job request payload.
-     * @param options - The options parameters.
-     */
-    createSparkBatchJob(sparkBatchJobOptions: SparkBatchJobOptions, options?: SparkBatchCreateSparkBatchJobOptionalParams): Promise<SparkBatchCreateSparkBatchJobResponse>;
-    /**
-     * Gets a single spark batch job.
-     * @param batchId - Identifier for the batch job.
-     * @param options - The options parameters.
-     */
-    getSparkBatchJob(batchId: number, options?: SparkBatchGetSparkBatchJobOptionalParams): Promise<SparkBatchGetSparkBatchJobResponse>;
-    /**
-     * Cancels a running spark batch job.
-     * @param batchId - Identifier for the batch job.
-     * @param options - The options parameters.
-     */
-    cancelSparkBatchJob(batchId: number, options?: SparkBatchCancelSparkBatchJobOptionalParams): Promise<void>;
-}
-
-/** Optional parameters. */
-export declare interface SparkBatchCancelSparkBatchJobOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface SparkBatchCreateSparkBatchJobOptionalParams extends coreClient.OperationOptions {
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the createSparkBatchJob operation. */
-export declare type SparkBatchCreateSparkBatchJobResponse = SparkBatchJob;
-
-/** Optional parameters. */
-export declare interface SparkBatchGetSparkBatchJobOptionalParams extends coreClient.OperationOptions {
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the getSparkBatchJob operation. */
-export declare type SparkBatchGetSparkBatchJobResponse = SparkBatchJob;
-
-/** Optional parameters. */
-export declare interface SparkBatchGetSparkBatchJobsOptionalParams extends coreClient.OperationOptions {
-    /** Optional param specifying which index the list should begin from. */
-    fromParam?: number;
-    /**
-     * Optional param specifying the size of the returned list.
-     *             By default it is 20 and that is the maximum.
-     */
-    size?: number;
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the getSparkBatchJobs operation. */
-export declare type SparkBatchGetSparkBatchJobsResponse = SparkBatchJobCollection;
-
-export declare interface SparkBatchJob {
-    livyInfo?: SparkBatchJobState;
-    /** The batch name. */
-    name?: string;
-    /** The workspace name. */
-    workspaceName?: string;
-    /** The Spark pool name. */
-    sparkPoolName?: string;
-    /** The submitter name. */
-    submitterName?: string;
-    /** The submitter identifier. */
-    submitterId?: string;
-    /** The artifact identifier. */
-    artifactId?: string;
-    /** The job type. */
-    jobType?: SparkJobType;
-    /** The Spark batch job result. */
-    result?: SparkBatchJobResultType;
-    /** The scheduler information. */
-    scheduler?: SparkScheduler;
-    /** The plugin information. */
-    plugin?: SparkServicePlugin;
-    /** The error information. */
-    errors?: SparkServiceError[];
-    /** The tags. */
-    tags?: {
-        [propertyName: string]: string;
-    };
-    /** The session Id. */
-    id: number;
-    /** The application id of this session */
-    appId?: string;
-    /** The detailed application info. */
-    appInfo?: {
-        [propertyName: string]: string;
-    };
-    /** The batch state */
-    state?: LivyStates;
-    /** The log lines. */
-    logLines?: string[];
-}
-
-/** Response for batch list operation. */
-export declare interface SparkBatchJobCollection {
-    /** The start index of fetched sessions. */
-    from: number;
-    /** Number of sessions fetched. */
-    total: number;
-    /** Batch list */
-    sessions?: SparkBatchJob[];
-}
-
-export declare interface SparkBatchJobOptions {
-    /** Dictionary of <string> */
-    tags?: {
-        [propertyName: string]: string;
-    };
-    artifactId?: string;
-    name: string;
-    file: string;
-    className?: string;
-    arguments?: string[];
-    jars?: string[];
-    pythonFiles?: string[];
-    files?: string[];
-    archives?: string[];
-    /** Dictionary of <string> */
-    configuration?: {
-        [propertyName: string]: string;
-    };
-    driverMemory?: string;
-    driverCores?: number;
-    executorMemory?: string;
-    executorCores?: number;
-    executorCount?: number;
-}
-
-/**
- * Defines values for SparkBatchJobResultType.
- * {@link KnownSparkBatchJobResultType} can be used interchangeably with SparkBatchJobResultType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Uncertain**
- * **Succeeded**
- * **Failed**
- * **Cancelled**
- */
-export declare type SparkBatchJobResultType = string;
-
-export declare interface SparkBatchJobState {
-    /** the time that at which "not_started" livy state was first seen. */
-    notStartedAt?: Date;
-    /** the time that at which "starting" livy state was first seen. */
-    startingAt?: Date;
-    /** the time that at which "running" livy state was first seen. */
-    runningAt?: Date;
-    /** time that at which "dead" livy state was first seen. */
-    deadAt?: Date;
-    /** the time that at which "success" livy state was first seen. */
-    successAt?: Date;
-    /** the time that at which "killed" livy state was first seen. */
-    terminatedAt?: Date;
-    /** the time that at which "recovering" livy state was first seen. */
-    recoveringAt?: Date;
-    /** the Spark job state. */
-    currentState?: string;
-    jobCreationRequest?: SparkRequest;
-}
-
-/**
- * Represents the Synapse Spark client operations.
- */
-export declare class SparkClient extends coreClient.ServiceClient {
-    endpoint: string;
-    livyApiVersion: string;
-    sparkPoolName: string;
-    /**
-     * Initializes a new instance of the SparkClient class.
-     * @param credentials - Subscription credentials which uniquely identify client subscription.
-     * @param endpoint - The workspace development endpoint, for example
-     *                 https://myworkspace.dev.azuresynapse.net.
-     * @param sparkPoolName - Name of the spark pool.
-     * @param options - The parameter options
-     */
-    constructor(credentials: coreAuth.TokenCredential, endpoint: string, sparkPoolName: string, options?: SparkClientOptionalParams);
-    sparkBatch: SparkBatch;
-    sparkSessionOperations: SparkSessionOperations;
-}
-
-/** Optional parameters. */
-export declare interface SparkClientOptionalParams extends coreClient.ServiceClientOptions {
-    /** Valid api-version for the request. */
-    livyApiVersion?: string;
-    /** Overrides client endpoint. */
-    endpoint?: string;
-}
-
-/**
- * Defines values for SparkErrorSource.
- * {@link KnownSparkErrorSource} can be used interchangeably with SparkErrorSource,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **System**
- * **User**
- * **Unknown**
- * **Dependency**
- */
-export declare type SparkErrorSource = string;
-
-/**
- * Defines values for SparkJobType.
- * {@link KnownSparkJobType} can be used interchangeably with SparkJobType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **SparkBatch**
- * **SparkSession**
- */
-export declare type SparkJobType = string;
-
-export declare interface SparkRequest {
-    name?: string;
-    file?: string;
-    className?: string;
-    arguments?: string[];
-    jars?: string[];
-    pythonFiles?: string[];
-    files?: string[];
-    archives?: string[];
-    /** Dictionary of <string> */
-    configuration?: {
-        [propertyName: string]: string;
-    };
-    driverMemory?: string;
-    driverCores?: number;
-    executorMemory?: string;
-    executorCores?: number;
-    executorCount?: number;
-}
-
-export declare interface SparkScheduler {
-    submittedAt?: Date;
-    scheduledAt?: Date;
-    endedAt?: Date;
-    cancellationRequestedAt?: Date;
-    currentState?: SchedulerCurrentState;
-}
-
-export declare interface SparkServiceError {
-    message?: string;
-    errorCode?: string;
-    source?: SparkErrorSource;
-}
-
-export declare interface SparkServicePlugin {
-    preparationStartedAt?: Date;
-    resourceAcquisitionStartedAt?: Date;
-    submissionStartedAt?: Date;
-    monitoringStartedAt?: Date;
-    cleanupStartedAt?: Date;
-    currentState?: PluginCurrentState;
-}
-
-export declare interface SparkSession {
-    livyInfo?: SparkSessionState;
-    name?: string;
-    workspaceName?: string;
-    sparkPoolName?: string;
-    submitterName?: string;
-    submitterId?: string;
-    artifactId?: string;
-    /** The job type. */
-    jobType?: SparkJobType;
-    result?: SparkSessionResultType;
-    scheduler?: SparkScheduler;
-    plugin?: SparkServicePlugin;
-    errors?: SparkServiceError[];
-    /** Dictionary of <string> */
-    tags?: {
-        [propertyName: string]: string;
-    };
-    id: number;
-    appId?: string;
-    /** Dictionary of <string> */
-    appInfo?: {
-        [propertyName: string]: string;
-    };
-    /** The session state. */
-    state?: LivyStates;
-    logLines?: string[];
-}
-
-/** Optional parameters. */
-export declare interface SparkSessionCancelSparkSessionOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface SparkSessionCancelSparkStatementOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the cancelSparkStatement operation. */
-export declare type SparkSessionCancelSparkStatementResponse = SparkStatementCancellationResult;
-
-export declare interface SparkSessionCollection {
-    from: number;
-    total: number;
-    sessions?: SparkSession[];
-}
-
-/** Optional parameters. */
-export declare interface SparkSessionCreateSparkSessionOptionalParams extends coreClient.OperationOptions {
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the createSparkSession operation. */
-export declare type SparkSessionCreateSparkSessionResponse = SparkSession;
-
-/** Optional parameters. */
-export declare interface SparkSessionCreateSparkStatementOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the createSparkStatement operation. */
-export declare type SparkSessionCreateSparkStatementResponse = SparkStatement;
-
-/** Optional parameters. */
-export declare interface SparkSessionGetSparkSessionOptionalParams extends coreClient.OperationOptions {
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the getSparkSession operation. */
-export declare type SparkSessionGetSparkSessionResponse = SparkSession;
-
-/** Optional parameters. */
-export declare interface SparkSessionGetSparkSessionsOptionalParams extends coreClient.OperationOptions {
-    /** Optional param specifying which index the list should begin from. */
-    fromParam?: number;
-    /**
-     * Optional param specifying the size of the returned list.
-     *             By default it is 20 and that is the maximum.
-     */
-    size?: number;
-    /** Optional query param specifying whether detailed response is returned beyond plain livy. */
-    detailed?: boolean;
-}
-
-/** Contains response data for the getSparkSessions operation. */
-export declare type SparkSessionGetSparkSessionsResponse = SparkSessionCollection;
-
-/** Optional parameters. */
-export declare interface SparkSessionGetSparkStatementOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getSparkStatement operation. */
-export declare type SparkSessionGetSparkStatementResponse = SparkStatement;
-
-/** Optional parameters. */
-export declare interface SparkSessionGetSparkStatementsOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the getSparkStatements operation. */
-export declare type SparkSessionGetSparkStatementsResponse = SparkStatementCollection;
-
-/** Interface representing a SparkSessionOperations. */
-export declare interface SparkSessionOperations {
-    /**
-     * List all spark sessions which are running under a particular spark pool.
-     * @param options - The options parameters.
-     */
-    getSparkSessions(options?: SparkSessionGetSparkSessionsOptionalParams): Promise<SparkSessionGetSparkSessionsResponse>;
-    /**
-     * Create new spark session.
-     * @param sparkSessionOptions - Livy compatible batch job request payload.
-     * @param options - The options parameters.
-     */
-    createSparkSession(sparkSessionOptions: SparkSessionOptions, options?: SparkSessionCreateSparkSessionOptionalParams): Promise<SparkSessionCreateSparkSessionResponse>;
-    /**
-     * Gets a single spark session.
-     * @param sessionId - Identifier for the session.
-     * @param options - The options parameters.
-     */
-    getSparkSession(sessionId: number, options?: SparkSessionGetSparkSessionOptionalParams): Promise<SparkSessionGetSparkSessionResponse>;
-    /**
-     * Cancels a running spark session.
-     * @param sessionId - Identifier for the session.
-     * @param options - The options parameters.
-     */
-    cancelSparkSession(sessionId: number, options?: SparkSessionCancelSparkSessionOptionalParams): Promise<void>;
-    /**
-     * Sends a keep alive call to the current session to reset the session timeout.
-     * @param sessionId - Identifier for the session.
-     * @param options - The options parameters.
-     */
-    resetSparkSessionTimeout(sessionId: number, options?: SparkSessionResetSparkSessionTimeoutOptionalParams): Promise<void>;
-    /**
-     * Gets a list of statements within a spark session.
-     * @param sessionId - Identifier for the session.
-     * @param options - The options parameters.
-     */
-    getSparkStatements(sessionId: number, options?: SparkSessionGetSparkStatementsOptionalParams): Promise<SparkSessionGetSparkStatementsResponse>;
-    /**
-     * Create statement within a spark session.
-     * @param sessionId - Identifier for the session.
-     * @param sparkStatementOptions - Livy compatible batch job request payload.
-     * @param options - The options parameters.
-     */
-    createSparkStatement(sessionId: number, sparkStatementOptions: SparkStatementOptions, options?: SparkSessionCreateSparkStatementOptionalParams): Promise<SparkSessionCreateSparkStatementResponse>;
-    /**
-     * Gets a single statement within a spark session.
-     * @param sessionId - Identifier for the session.
-     * @param statementId - Identifier for the statement.
-     * @param options - The options parameters.
-     */
-    getSparkStatement(sessionId: number, statementId: number, options?: SparkSessionGetSparkStatementOptionalParams): Promise<SparkSessionGetSparkStatementResponse>;
-    /**
-     * Kill a statement within a session.
-     * @param sessionId - Identifier for the session.
-     * @param statementId - Identifier for the statement.
-     * @param options - The options parameters.
-     */
-    cancelSparkStatement(sessionId: number, statementId: number, options?: SparkSessionCancelSparkStatementOptionalParams): Promise<SparkSessionCancelSparkStatementResponse>;
-}
-
-export declare interface SparkSessionOptions {
-    /** Dictionary of <string> */
-    tags?: {
-        [propertyName: string]: string;
-    };
-    artifactId?: string;
-    name: string;
-    file?: string;
-    className?: string;
-    arguments?: string[];
-    jars?: string[];
-    pythonFiles?: string[];
-    files?: string[];
-    archives?: string[];
-    /** Dictionary of <string> */
-    configuration?: {
-        [propertyName: string]: string;
-    };
-    driverMemory?: string;
-    driverCores?: number;
-    executorMemory?: string;
-    executorCores?: number;
-    executorCount?: number;
-}
-
-/** Optional parameters. */
-export declare interface SparkSessionResetSparkSessionTimeoutOptionalParams extends coreClient.OperationOptions {
-}
-
-/**
- * Defines values for SparkSessionResultType.
- * {@link KnownSparkSessionResultType} can be used interchangeably with SparkSessionResultType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **Uncertain**
- * **Succeeded**
- * **Failed**
- * **Cancelled**
- */
-export declare type SparkSessionResultType = string;
-
-export declare interface SparkSessionState {
-    notStartedAt?: Date;
-    startingAt?: Date;
-    idleAt?: Date;
-    deadAt?: Date;
-    shuttingDownAt?: Date;
-    terminatedAt?: Date;
-    recoveringAt?: Date;
-    busyAt?: Date;
-    errorAt?: Date;
-    currentState?: string;
-    jobCreationRequest?: SparkRequest;
-}
-
-export declare interface SparkStatement {
-    id: number;
-    code?: string;
-    state?: LivyStatementStates;
-    output?: SparkStatementOutput;
-}
-
-export declare interface SparkStatementCancellationResult {
-    /** The msg property from the Livy API. The value is always "canceled". */
-    message?: string;
-}
-
-export declare interface SparkStatementCollection {
-    total: number;
-    statements?: SparkStatement[];
-}
-
-/**
- * Defines values for SparkStatementLanguageType.
- * {@link KnownSparkStatementLanguageType} can be used interchangeably with SparkStatementLanguageType,
- *  this enum contains the known values that the service supports.
- * ### Known values supported by the service
- * **spark**
- * **pyspark**
- * **dotnetspark**
- * **sql**
- */
-export declare type SparkStatementLanguageType = string;
-
-export declare interface SparkStatementOptions {
-    code?: string;
-    kind?: SparkStatementLanguageType;
-}
-
-export declare interface SparkStatementOutput {
-    status?: string;
-    executionCount: number;
-    /** Any object */
-    data?: Record<string, unknown>;
-    errorName?: string;
-    errorValue?: string;
-    traceback?: string[];
-}
-
-export { }