sailfork / t3code-github / .repos/ alchemy-effect/ packages/ gcp/ src/ DataPipelines/ RunPipeline.ts

import type * as datapipelines from "@distilled.cloud/gcp/datapipelines_v1";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { Pipeline } from "./Pipeline.ts";

export interface RunPipelineRequest extends Omit<
  datapipelines.RunProjectsLocationsPipelinesRequest,
  "name"
> {}

/**
 * Runtime binding for Data Pipelines `pipelines.run`.
 *
 * Creates a job for the bound pipeline immediately. Use this when the
 * internal scheduler is not configured. Bind in a Function/Action init
 * phase and provide {@link RunPipelineHttp}.
 *
 * ### Running Pipelines
 * **Example:** Run the bound pipeline now
 * ```typescript
 * const runPipeline = yield* GCP.DataPipelines.RunPipeline(batch);
 * const response = yield* runPipeline();
 * ```
 *
 * @binding
 * @category DataPipelines
 */
export interface RunPipeline extends Binding.Service<
  RunPipeline,
  "GCP.DataPipelines.RunPipeline",
  (
    pipeline: Pipeline,
  ) => Effect.Effect<
    (
      request?: RunPipelineRequest,
    ) => Effect.Effect<
      datapipelines.GoogleCloudDatapipelinesV1RunPipelineResponse,
      datapipelines.RunProjectsLocationsPipelinesError,
      RuntimeContext
    >
  >
> {}

export const RunPipeline = Binding.Service<RunPipeline>("GCP.DataPipelines.RunPipeline");