1import type * as aiplatform from "@distilled.cloud/gcp/aiplatform_v1";
2import type * as Effect from "effect/Effect";
3import * as Binding from "../../Binding.ts";
4import type { RuntimeContext } from "../../RuntimeContext.ts";
5import type { TrainingPipeline } from "./TrainingPipeline.ts";
6
7export interface CancelTrainingPipelineRequest extends Omit<
8 aiplatform.CancelProjectsLocationsTrainingPipelinesRequest,
9 "name"
10> {}
11
12/**
13 * Runtime binding for Vertex AI `trainingPipelines.cancel`.
14 *
15 * Bind this operation to a {@link TrainingPipeline} in a Function/Action
16 * init phase. Provide {@link CancelTrainingPipelineHttp}.
17 *
18 * ### Cancelling
19 * **Example:** Cancel the bound pipeline
20 * ```typescript
21 * const cancel = yield* GCP.AIPlatform.CancelTrainingPipeline(pipeline);
22 * yield* cancel({ body: {} });
23 * ```
24 *
25 * @binding
26 * @category AIPlatform
27 */
28export interface CancelTrainingPipeline extends Binding.Service<
29 CancelTrainingPipeline,
30 "GCP.AIPlatform.CancelTrainingPipeline",
31 (
32 pipeline: TrainingPipeline,
33 ) => Effect.Effect<
34 (
35 request?: CancelTrainingPipelineRequest,
36 ) => Effect.Effect<
37 aiplatform.GoogleProtobufEmpty,
38 aiplatform.CancelProjectsLocationsTrainingPipelinesError,
39 RuntimeContext
40 >
41 >
42> {}
43
44export const CancelTrainingPipeline = Binding.Service<CancelTrainingPipeline>(
45 "GCP.AIPlatform.CancelTrainingPipeline",
46);