sailfork / t3code-github / .repos/ alchemy-effect/ packages/ gcp/ src/ AlloyDB/ GetConnectionInfo.ts

import type * as alloydb from "@distilled.cloud/gcp/alloydb_v1";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { Instance } from "./Instance.ts";

export interface GetConnectionInfoRequest extends Omit<
  alloydb.GetConnectionInfoProjectsLocationsClustersInstancesRequest,
  "parent"
> {}

/**
 * Runtime binding for AlloyDB `instances.getConnectionInfo`.
 *
 * Bind this operation to an {@link Instance} in a Function/Action init
 * phase. Provide {@link GetConnectionInfoHttp}.
 *
 * ### Connection Info
 * **Example:** Read private and public IPs
 * ```typescript
 * const getConnectionInfo = yield* GCP.AlloyDB.GetConnectionInfo(primary);
 * const info = yield* getConnectionInfo();
 * ```
 *
 * @binding
 * @category AlloyDB
 */
export interface GetConnectionInfo extends Binding.Service<
  GetConnectionInfo,
  "GCP.AlloyDB.GetConnectionInfo",
  (
    instance: Instance,
  ) => Effect.Effect<
    (
      request?: GetConnectionInfoRequest,
    ) => Effect.Effect<
      alloydb.ConnectionInfo,
      alloydb.GetConnectionInfoProjectsLocationsClustersInstancesError,
      RuntimeContext
    >
  >
> {}

export const GetConnectionInfo = Binding.Service<GetConnectionInfo>(
  "GCP.AlloyDB.GetConnectionInfo",
);