@azure/digital-twins-core/dist/react-native/generated/operations/importJobs.d.ts

An isomorphic client library for Azure Digital Twins

import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { ImportJobs } from "../operationsInterfaces/index.js";
import { AzureDigitalTwinsAPI } from "../azureDigitalTwinsAPI.js";
import { ImportJob, ImportJobsListOptionalParams, ImportJobsAddOptionalParams, ImportJobsAddResponse, ImportJobsGetByIdOptionalParams, ImportJobsGetByIdResponse, ImportJobsDeleteOptionalParams, ImportJobsCancelOptionalParams, ImportJobsCancelResponse } from "../models/index.js";
/** Class containing ImportJobs operations. */
export declare class ImportJobsImpl implements ImportJobs {
    private readonly client;
    /**
     * Initialize a new instance of the class ImportJobs class.
     * @param client Reference to the service client
     */
    constructor(client: AzureDigitalTwinsAPI);
    /**
     * Retrieves all import jobs.
     * Status codes:
     * * 200 OK
     * @param options The options parameters.
     */
    list(options?: ImportJobsListOptionalParams): PagedAsyncIterableIterator<ImportJob>;
    private listPagingPage;
    private listPagingAll;
    /**
     * Retrieves all import jobs.
     * Status codes:
     * * 200 OK
     * @param options The options parameters.
     */
    private _list;
    /**
     * Creates an import job.
     * Status codes:
     * * 201 Created
     * * 400 Bad Request
     *   * JobLimitReached - The maximum number of import jobs allowed has been reached.
     *   * ValidationFailed - The import job request is not valid.
     * @param id The id for the import job. The id is unique within the service and case sensitive.
     * @param importJob The import job being added.
     * @param options The options parameters.
     */
    add(id: string, importJob: ImportJob, options?: ImportJobsAddOptionalParams): Promise<ImportJobsAddResponse>;
    /**
     * Retrieves an import job.
     * Status codes:
     * * 200 OK
     * * 404 Not Found
     *   * ImportJobNotFound - The import job was not found.
     * @param id The id for the import job. The id is unique within the service and case sensitive.
     * @param options The options parameters.
     */
    getById(id: string, options?: ImportJobsGetByIdOptionalParams): Promise<ImportJobsGetByIdResponse>;
    /**
     * Deletes an import job. This is simply used to remove a job id, so it may be reused later. It can not
     * be used to stop entities from being imported.
     * Status codes:
     * * 204 No Content
     * * 400 Bad Request
     *   * ValidationFailed - The import job request is not valid.
     * @param id The id for the import job. The id is unique within the service and case sensitive.
     * @param options The options parameters.
     */
    delete(id: string, options?: ImportJobsDeleteOptionalParams): Promise<void>;
    /**
     * Cancels an import job that is currently running. Service will stop any import operations triggered
     * by the current import job that are in progress, and go to a cancelled state. Please note that this
     * will leave your instance in an unknown state as there won't be any rollback operation.
     * Status codes:
     * * 200 Request Accepted
     * * 400 Bad Request
     *   * ValidationFailed - The import job request is not valid.
     * @param id The id for the import job. The id is unique within the service and case sensitive.
     * @param options The options parameters.
     */
    cancel(id: string, options?: ImportJobsCancelOptionalParams): Promise<ImportJobsCancelResponse>;
    /**
     * ListNext
     * @param nextLink The nextLink from the previous successful call to the List method.
     * @param options The options parameters.
     */
    private _listNext;
}
//# sourceMappingURL=importJobs.d.ts.map