nominal-api-conjure 0.1331.0

use conjure_http::endpoint;
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization
)]
pub trait IngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a single ingest transform by RID. The caller must be authorized to read the dataset
    /// produced by the transform's parent ingest job; a transform whose parent job is not visible to
    /// the caller is reported as IngestTransformNotFound rather than leaking its existence.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-transform/{ingestTransformRid}",
        name = "getIngestTransform",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_ingest_transform(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestTransformRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestTransformRid",
            safe
        )]
        ingest_transform_rid: super::super::super::super::objects::ingest::api::IngestTransformRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestTransform,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of the transforms belonging to a single ingest job, oldest-first and
    /// optionally filtered by status. The caller must be authorized to read the parent job's dataset;
    /// a job that is not visible to the caller is reported as IngestJobNotFound.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-transforms/search",
        name = "searchIngestTransforms",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn search_ingest_transforms(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestTransformsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestTransformsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Returns the number of ingest jobs matching the filter, applying the same visibility rules as
    /// searchIngestJobs: jobs without a persisted dataset are excluded, and only jobs whose dataset
    /// the caller is authorized to read are counted. Intended for cheap polling (e.g. an active-job
    /// indicator) instead of paginating searchIngestJobs just to count results. Throws
    /// INVALID_ARGUMENT when the filter matches jobs across more distinct datasets than can be
    /// authorized in one request; narrow the filter in that case.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/count",
        name = "countIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn count_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CountIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::CountIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Cancels an ingest job. Jobs that have not yet started running (SUBMITTED, QUEUED) are
    /// transitioned directly to CANCELLED. Jobs that are IN_PROGRESS have their underlying
    /// Temporal workflow cancelled; the workflow is responsible for transitioning the job to
    /// CANCELLED and tearing down in-flight work. Cancelling a job that is already in a terminal
    /// state (COMPLETED, FAILED, CANCELLED) throws IngestJobNotCancellable.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-job/{ingestJobRid}/cancel",
        name = "cancelIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn cancel_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Cancels multiple ingest jobs in a single call. Each job is processed independently and
    /// best-effort: a job that cannot be cancelled (already terminal, missing, or not authorized for
    /// the caller) yields a `failed` result rather than aborting the batch. Per-job cancellation
    /// semantics match cancelIngestJob. At most 100 jobs may be requested per call.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/cancel",
        name = "batchCancelIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn batch_cancel_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::objects::ingest::api::BatchCancelIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::BatchCancelIngestJobsResponse,
        conjure_http::private::Error,
    >;
}
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization
)]
pub trait AsyncIngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a single ingest transform by RID. The caller must be authorized to read the dataset
    /// produced by the transform's parent ingest job; a transform whose parent job is not visible to
    /// the caller is reported as IngestTransformNotFound rather than leaking its existence.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-transform/{ingestTransformRid}",
        name = "getIngestTransform",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_transform(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestTransformRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestTransformRid",
            safe
        )]
        ingest_transform_rid: super::super::super::super::objects::ingest::api::IngestTransformRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestTransform,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of the transforms belonging to a single ingest job, oldest-first and
    /// optionally filtered by status. The caller must be authorized to read the parent job's dataset;
    /// a job that is not visible to the caller is reported as IngestJobNotFound.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-transforms/search",
        name = "searchIngestTransforms",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_transforms(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestTransformsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestTransformsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Returns the number of ingest jobs matching the filter, applying the same visibility rules as
    /// searchIngestJobs: jobs without a persisted dataset are excluded, and only jobs whose dataset
    /// the caller is authorized to read are counted. Intended for cheap polling (e.g. an active-job
    /// indicator) instead of paginating searchIngestJobs just to count results. Throws
    /// INVALID_ARGUMENT when the filter matches jobs across more distinct datasets than can be
    /// authorized in one request; narrow the filter in that case.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/count",
        name = "countIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn count_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CountIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::CountIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Cancels an ingest job. Jobs that have not yet started running (SUBMITTED, QUEUED) are
    /// transitioned directly to CANCELLED. Jobs that are IN_PROGRESS have their underlying
    /// Temporal workflow cancelled; the workflow is responsible for transitioning the job to
    /// CANCELLED and tearing down in-flight work. Cancelling a job that is already in a terminal
    /// state (COMPLETED, FAILED, CANCELLED) throws IngestJobNotCancellable.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-job/{ingestJobRid}/cancel",
        name = "cancelIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn cancel_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Cancels multiple ingest jobs in a single call. Each job is processed independently and
    /// best-effort: a job that cannot be cancelled (already terminal, missing, or not authorized for
    /// the caller) yields a `failed` result rather than aborting the batch. Per-job cancellation
    /// semantics match cancelIngestJob. At most 100 jobs may be requested per call.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/cancel",
        name = "batchCancelIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_cancel_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::objects::ingest::api::BatchCancelIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::BatchCancelIngestJobsResponse,
        conjure_http::private::Error,
    >;
}
/// Public API for querying ingest jobs.
#[conjure_http::conjure_endpoints(
    name = "IngestJobService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncIngestJobService {
    /// Returns a single ingest job by RID. Does not include the full ingest request details.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-job/{ingestJobRid}",
        name = "getIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Returns a single ingest transform by RID. The caller must be authorized to read the dataset
    /// produced by the transform's parent ingest job; a transform whose parent job is not visible to
    /// the caller is reported as IngestTransformNotFound rather than leaking its existence.
    #[endpoint(
        method = GET,
        path = "/ingest/v1/ingest-transform/{ingestTransformRid}",
        name = "getIngestTransform",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_ingest_transform(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestTransformRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestTransformRid",
            safe
        )]
        ingest_transform_rid: super::super::super::super::objects::ingest::api::IngestTransformRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestTransform,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of the transforms belonging to a single ingest job, oldest-first and
    /// optionally filtered by status. The caller must be authorized to read the parent job's dataset;
    /// a job that is not visible to the caller is reported as IngestJobNotFound.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-transforms/search",
        name = "searchIngestTransforms",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_transforms(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestTransformsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestTransformsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a paginated list of ingest jobs, optionally filtered by dataset.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/search",
        name = "searchIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn search_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::SearchIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::SearchIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Returns the number of ingest jobs matching the filter, applying the same visibility rules as
    /// searchIngestJobs: jobs without a persisted dataset are excluded, and only jobs whose dataset
    /// the caller is authorized to read are counted. Intended for cheap polling (e.g. an active-job
    /// indicator) instead of paginating searchIngestJobs just to count results. Throws
    /// INVALID_ARGUMENT when the filter matches jobs across more distinct datasets than can be
    /// authorized in one request; narrow the filter in that case.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/count",
        name = "countIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn count_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::ingest::api::CountIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::CountIngestJobsResponse,
        conjure_http::private::Error,
    >;
    /// Cancels an ingest job. Jobs that have not yet started running (SUBMITTED, QUEUED) are
    /// transitioned directly to CANCELLED. Jobs that are IN_PROGRESS have their underlying
    /// Temporal workflow cancelled; the workflow is responsible for transitioning the job to
    /// CANCELLED and tearing down in-flight work. Cancelling a job that is already in a terminal
    /// state (COMPLETED, FAILED, CANCELLED) throws IngestJobNotCancellable.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-job/{ingestJobRid}/cancel",
        name = "cancelIngestJob",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn cancel_ingest_job(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "ingestJobRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "ingestJobRid",
            safe
        )]
        ingest_job_rid: super::super::super::super::objects::ingest::api::IngestJobRid,
    ) -> Result<
        super::super::super::super::objects::ingest::api::IngestJob,
        conjure_http::private::Error,
    >;
    /// Cancels multiple ingest jobs in a single call. Each job is processed independently and
    /// best-effort: a job that cannot be cancelled (already terminal, missing, or not authorized for
    /// the caller) yields a `failed` result rather than aborting the batch. Per-job cancellation
    /// semantics match cancelIngestJob. At most 100 jobs may be requested per call.
    #[endpoint(
        method = POST,
        path = "/ingest/v1/ingest-jobs/cancel",
        name = "batchCancelIngestJobs",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn batch_cancel_ingest_jobs(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
        request: super::super::super::super::objects::ingest::api::BatchCancelIngestJobsRequest,
    ) -> Result<
        super::super::super::super::objects::ingest::api::BatchCancelIngestJobsResponse,
        conjure_http::private::Error,
    >;
}