sailfork / t3code-github / .repos/ alchemy-effect/ packages/ gcp/ src/ ParameterManager/ GetParameterVersion.ts

import type * as parametermanager from "@distilled.cloud/gcp/parametermanager_v1";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { ParametersVersion } from "./ParametersVersion.ts";

export interface GetParameterVersionRequest {
  /**
   * View of the ParameterVersion. `FULL` (the default) includes payload.
   * `BASIC` returns metadata only.
   * @default "FULL"
   */
  view?: parametermanager.GetProjectsLocationsParametersVersionsViewEnum | (string & {});
}

/**
 * Runtime binding for Parameter Manager `parameters.versions.get`.
 *
 * Bind this operation to a {@link ParametersVersion} in a Function/Action
 * init phase. Provide {@link GetParameterVersionHttp}.
 *
 * Grants `roles/parametermanager.parameterViewer` on the project under an
 * IAM Condition matching only this version: Parameter Manager has no
 * resource-level IAM.
 *
 * ### Reading a Parameter Version
 * **Example:** Get payload
 * ```typescript
 * const getVersion = yield* GCP.ParameterManager.GetParameterVersion(version);
 * const live = yield* getVersion();
 * ```
 *
 * **Example:** Metadata only
 * ```typescript
 * const getVersion = yield* GCP.ParameterManager.GetParameterVersion(version);
 * const live = yield* getVersion({ view: "BASIC" });
 * ```
 *
 * @binding
 * @category ParameterManager
 */
export interface GetParameterVersion extends Binding.Service<
  GetParameterVersion,
  "GCP.ParameterManager.GetParameterVersion",
  (
    version: ParametersVersion,
  ) => Effect.Effect<
    (
      request?: GetParameterVersionRequest,
    ) => Effect.Effect<
      parametermanager.ParameterVersion,
      parametermanager.GetProjectsLocationsParametersVersionsError,
      RuntimeContext
    >
  >
> {}

export const GetParameterVersion = Binding.Service<GetParameterVersion>(
  "GCP.ParameterManager.GetParameterVersion",
);