@azure/quantum-jobs 1.0.0-beta.1 → 1.0.0-beta.2

package/types/latest/quantum-jobs.d.ts

@@ -1,534 +0,0 @@
-import * as coreHttp from '@azure/core-http';
-import { PagedAsyncIterableIterator } from '@azure/core-paging';
-
-/** Blob details. */
-export declare interface BlobDetails {
-    /** The container name. */
-    containerName: string;
-    /** The blob name. */
-    blobName?: string;
-}
-
-/**
- * Defines values for DimensionScope. \
- * {@link KnownDimensionScope} can be used interchangeably with DimensionScope,
- *  this enum contains the known values that the service supports.
- * ### Know values supported by the service
- * **Workspace** \
- * **Subscription**
- */
-export declare type DimensionScope = string;
-
-/** An error response from Azure. */
-export declare interface ErrorData {
-    /** An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */
-    code?: string;
-    /** A message describing the error, intended to be suitable for displaying in a user interface. */
-    message?: string;
-}
-
-/** Job details. */
-export declare interface JobDetails {
-    /** The job id. */
-    id?: string;
-    /** The job name. Is not required for the name to be unique and it's only used for display purposes. */
-    name?: string;
-    /** The blob container SAS uri, the container is used to host job data. */
-    containerUri: string;
-    /** The input blob SAS uri, if specified, it will override the default input blob in the container. */
-    inputDataUri?: string;
-    /** The format of the input data. */
-    inputDataFormat: string;
-    /** The input parameters for the job. JSON object used by the target solver. It is expected that the size of this object is small and only used to specify parameters for the execution target, not the input data. */
-    inputParams?: any;
-    /** The unique identifier for the provider. */
-    providerId: string;
-    /** The target identifier to run the job. */
-    target: string;
-    /** The job metadata. Metadata provides client the ability to store client-specific information */
-    metadata?: {
-        [propertyName: string]: string;
-    };
-    /** The output blob SAS uri. When a job finishes successfully, results will be uploaded to this blob. */
-    outputDataUri?: string;
-    /** The format of the output data. */
-    outputDataFormat?: string;
-    /**
-     * The job status.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly status?: JobStatus;
-    /**
-     * The creation time of the job.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly creationTime?: Date;
-    /**
-     * The time when the job began execution.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly beginExecutionTime?: Date;
-    /**
-     * The time when the job finished execution.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly endExecutionTime?: Date;
-    /**
-     * The time when a job was successfully cancelled.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly cancellationTime?: Date;
-    /**
-     * The error data for the job. This is expected only when Status 'Failed'.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly errorData?: ErrorData;
-}
-
-/** List of job details. */
-export declare interface JobDetailsList {
-    /** NOTE: This property will not be serialized. It can only be populated by the server. */
-    readonly value?: JobDetails[];
-    /** Total records count number. */
-    count?: number;
-    /**
-     * Link to the next page of results.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly nextLink?: string;
-}
-
-/** Class representing a Jobs. */
-export declare class Jobs {
-    private readonly client;
-    /**
-     * Initialize a new instance of the class Jobs class.
-     * @param client Reference to the service client
-     */
-    constructor(client: QuantumJobClient);
-    /**
-     * List jobs.
-     * @param options The options parameters.
-     */
-    list(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<JobDetails>;
-    private listPagingPage;
-    private listPagingAll;
-    /**
-     * List jobs.
-     * @param options The options parameters.
-     */
-    private _list;
-    /**
-     * Get job by id
-     * @param jobId Id of the job.
-     * @param options The options parameters.
-     */
-    get(jobId: string, options?: coreHttp.OperationOptions): Promise<JobsGetResponse>;
-    /**
-     * Create a job.
-     * @param jobId Id of the job.
-     * @param job The complete metadata of the job to submit.
-     * @param options The options parameters.
-     */
-    create(jobId: string, job: JobDetails, options?: coreHttp.OperationOptions): Promise<JobsCreateResponse>;
-    /**
-     * Cancel a job.
-     * @param jobId Id of the job.
-     * @param options The options parameters.
-     */
-    cancel(jobId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>;
-    /**
-     * ListNext
-     * @param nextLink The nextLink from the previous successful call to the List method.
-     * @param options The options parameters.
-     */
-    private _listNext;
-}
-
-/** Contains response data for the create operation. */
-export declare type JobsCreateResponse = JobDetails & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: JobDetails;
-    };
-};
-
-/** Contains response data for the get operation. */
-export declare type JobsGetResponse = JobDetails & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: JobDetails;
-    };
-};
-
-/** Contains response data for the listNext operation. */
-export declare type JobsListNextResponse = JobDetailsList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: JobDetailsList;
-    };
-};
-
-/** Contains response data for the list operation. */
-export declare type JobsListResponse = JobDetailsList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: JobDetailsList;
-    };
-};
-
-/**
- * Defines values for JobStatus. \
- * {@link KnownJobStatus} can be used interchangeably with JobStatus,
- *  this enum contains the known values that the service supports.
- * ### Know values supported by the service
- * **Waiting** \
- * **Executing** \
- * **Succeeded** \
- * **Failed** \
- * **Cancelled**
- */
-export declare type JobStatus = string;
-
-/** Known values of {@link DimensionScope} that the service accepts. */
-export declare const enum KnownDimensionScope {
-    Workspace = "Workspace",
-    Subscription = "Subscription"
-}
-
-/** Known values of {@link JobStatus} that the service accepts. */
-export declare const enum KnownJobStatus {
-    Waiting = "Waiting",
-    Executing = "Executing",
-    Succeeded = "Succeeded",
-    Failed = "Failed",
-    Cancelled = "Cancelled"
-}
-
-/** Known values of {@link MeterPeriod} that the service accepts. */
-export declare const enum KnownMeterPeriod {
-    None = "None",
-    Monthly = "Monthly"
-}
-
-/** Known values of {@link ProviderAvailability} that the service accepts. */
-export declare const enum KnownProviderAvailability {
-    Available = "Available",
-    Degraded = "Degraded",
-    Unavailable = "Unavailable"
-}
-
-/** Known values of {@link TargetAvailability} that the service accepts. */
-export declare const enum KnownTargetAvailability {
-    Available = "Available",
-    Degraded = "Degraded",
-    Unavailable = "Unavailable"
-}
-
-/**
- * Defines values for MeterPeriod. \
- * {@link KnownMeterPeriod} can be used interchangeably with MeterPeriod,
- *  this enum contains the known values that the service supports.
- * ### Know values supported by the service
- * **None** \
- * **Monthly**
- */
-export declare type MeterPeriod = string;
-
-/**
- * Defines values for ProviderAvailability. \
- * {@link KnownProviderAvailability} can be used interchangeably with ProviderAvailability,
- *  this enum contains the known values that the service supports.
- * ### Know values supported by the service
- * **Available** \
- * **Degraded** \
- * **Unavailable**
- */
-export declare type ProviderAvailability = string;
-
-/** Class representing a Providers. */
-export declare class Providers {
-    private readonly client;
-    /**
-     * Initialize a new instance of the class Providers class.
-     * @param client Reference to the service client
-     */
-    constructor(client: QuantumJobClient);
-    /**
-     * Get provider status.
-     * @param options The options parameters.
-     */
-    listStatus(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<ProviderStatus>;
-    private getStatusPagingPage;
-    private getStatusPagingAll;
-    /**
-     * Get provider status.
-     * @param options The options parameters.
-     */
-    private _getStatus;
-    /**
-     * GetStatusNext
-     * @param nextLink The nextLink from the previous successful call to the GetStatus method.
-     * @param options The options parameters.
-     */
-    private _getStatusNext;
-}
-
-/** Contains response data for the getStatusNext operation. */
-export declare type ProvidersGetStatusNextResponse = ProviderStatusList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: ProviderStatusList;
-    };
-};
-
-/** Contains response data for the getStatus operation. */
-export declare type ProvidersGetStatusResponse = ProviderStatusList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: ProviderStatusList;
-    };
-};
-
-/** Providers status. */
-export declare interface ProviderStatus {
-    /**
-     * Provider id.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly id?: string;
-    /**
-     * Provider availability.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly currentAvailability?: ProviderAvailability;
-    /** NOTE: This property will not be serialized. It can only be populated by the server. */
-    readonly targets?: TargetStatus[];
-}
-
-/** Providers status. */
-export declare interface ProviderStatusList {
-    /** NOTE: This property will not be serialized. It can only be populated by the server. */
-    readonly value?: ProviderStatus[];
-    /**
-     * Link to the next page of results.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly nextLink?: string;
-}
-
-export declare class QuantumJobClient extends QuantumJobClientContext {
-    /**
-     * Initializes a new instance of the QuantumJobClient class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
-     *                       00000000-0000-0000-0000-000000000000)
-     * @param resourceGroupName Name of an Azure resource group.
-     * @param workspaceName Name of the workspace.
-     * @param options The parameter options
-     */
-    constructor(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumJobClientOptionalParams);
-    jobs: Jobs;
-    providers: Providers;
-    storage: Storage;
-    quotas: Quotas;
-}
-
-export declare class QuantumJobClientContext extends coreHttp.ServiceClient {
-    $host: string;
-    subscriptionId: string;
-    resourceGroupName: string;
-    workspaceName: string;
-    /**
-     * Initializes a new instance of the QuantumJobClientContext class.
-     * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId The Azure subscription ID. This is a GUID-formatted string (e.g.
-     *                       00000000-0000-0000-0000-000000000000)
-     * @param resourceGroupName Name of an Azure resource group.
-     * @param workspaceName Name of the workspace.
-     * @param options The parameter options
-     */
-    constructor(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, subscriptionId: string, resourceGroupName: string, workspaceName: string, options?: QuantumJobClientOptionalParams);
-}
-
-/** Optional parameters. */
-export declare interface QuantumJobClientOptionalParams extends coreHttp.ServiceClientOptions {
-    /** server parameter */
-    $host?: string;
-    /** Overrides client endpoint. */
-    endpoint?: string;
-}
-
-/** Quota information. */
-export declare interface Quota {
-    /** The name of the dimension associated with the quota. */
-    dimension?: string;
-    /** The scope at which the quota is applied. */
-    scope?: DimensionScope;
-    /** The unique identifier for the provider. */
-    providerId?: string;
-    /** The amount of the usage that has been applied for the current period. */
-    utilization?: number;
-    /** The amount of the usage that has been reserved but not applied for the current period. */
-    holds?: number;
-    /** The maximum amount of usage allowed for the current period. */
-    limit?: number;
-    /** The time period in which the quota's underlying meter is accumulated. Based on calendar year. 'None' is used for concurrent quotas. */
-    period?: MeterPeriod;
-}
-
-/** List of quotas. */
-export declare interface QuotaList {
-    /** NOTE: This property will not be serialized. It can only be populated by the server. */
-    readonly value?: Quota[];
-    /**
-     * Link to the next page of results.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly nextLink?: string;
-}
-
-/** Class representing a Quotas. */
-export declare class Quotas {
-    private readonly client;
-    /**
-     * Initialize a new instance of the class Quotas class.
-     * @param client Reference to the service client
-     */
-    constructor(client: QuantumJobClient);
-    /**
-     * List quotas for the given workspace.
-     * @param options The options parameters.
-     */
-    list(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<Quota>;
-    private listPagingPage;
-    private listPagingAll;
-    /**
-     * List quotas for the given workspace.
-     * @param options The options parameters.
-     */
-    private _list;
-    /**
-     * ListNext
-     * @param nextLink The nextLink from the previous successful call to the List method.
-     * @param options The options parameters.
-     */
-    private _listNext;
-}
-
-/** Contains response data for the listNext operation. */
-export declare type QuotasListNextResponse = QuotaList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: QuotaList;
-    };
-};
-
-/** Contains response data for the list operation. */
-export declare type QuotasListResponse = QuotaList & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: QuotaList;
-    };
-};
-
-/** Error information returned by the API */
-export declare interface RestError {
-    /** An error response from Azure. */
-    error?: ErrorData;
-}
-
-/** Get SAS URL operation response. */
-export declare interface SasUriResponse {
-    /** A URL with a SAS token to upload a blob for execution in the given workspace. */
-    sasUri?: string;
-}
-
-/** Class representing a Storage. */
-export declare class Storage {
-    private readonly client;
-    /**
-     * Initialize a new instance of the class Storage class.
-     * @param client Reference to the service client
-     */
-    constructor(client: QuantumJobClient);
-    /**
-     * Gets a URL with SAS token for a container/blob in the storage account associated with the workspace.
-     * The SAS URL can be used to upload job input and/or download job output.
-     * @param blobDetails The details (name and container) of the blob to store or download data.
-     * @param options The options parameters.
-     */
-    sasUri(blobDetails: BlobDetails, options?: coreHttp.OperationOptions): Promise<StorageSasUriResponse>;
-}
-
-/** Contains response data for the sasUri operation. */
-export declare type StorageSasUriResponse = SasUriResponse & {
-    /** The underlying HTTP response. */
-    _response: coreHttp.HttpResponse & {
-        /** The response body as text (string format) */
-        bodyAsText: string;
-        /** The response body as parsed JSON or XML */
-        parsedBody: SasUriResponse;
-    };
-};
-
-/**
- * Defines values for TargetAvailability. \
- * {@link KnownTargetAvailability} can be used interchangeably with TargetAvailability,
- *  this enum contains the known values that the service supports.
- * ### Know values supported by the service
- * **Available** \
- * **Degraded** \
- * **Unavailable**
- */
-export declare type TargetAvailability = string;
-
-/** Target status. */
-export declare interface TargetStatus {
-    /**
-     * Target id.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly id?: string;
-    /**
-     * Target availability.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly currentAvailability?: TargetAvailability;
-    /**
-     * Average queue time in seconds.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly averageQueueTime?: number;
-    /**
-     * A page with detailed status of the provider.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly statusPage?: string;
-}
-
-export { }