@origincloud/dns 0.0.0-stage → 0.15.0

package/src/v1beta1/record_set.ts

@@ -0,0 +1,379 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/dns/v1beta1/record_set.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls RecordSetService.
+ *
+ * Record sets: every record of one name and type in a hosted zone. A zone
+ * holds one record set per name and type, whatever its kind. A CNAME is
+ * alone at its name and never at the zone's apex. The apex's SOA and NS
+ * records are the platform's, written from the zone's name servers; they
+ * aren't record sets, and no NS record delegates a name below the apex.
+ *
+ * A change is recorded when its method answers, and answered wherever the
+ * zone is served. `BatchChangeRecordSets` makes several changes at once,
+ * all or none.
+ */
+export class RecordSetClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of RecordSetService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("dns", false);
+  }
+
+  /** Returns a record set. */
+  async getRecordSet(request: GetRecordSetRequest, options?: CallOptions): Promise<RecordSet> {
+    const p0 = pathValue("name", request.name, "projects/*/hostedZones/*/recordSets/*");
+    return this.service.call<RecordSet>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /** Lists a zone's record sets by `dnsName`, then by `type`. */
+  async listRecordSets(request: ListRecordSetsRequest, options?: CallOptions): Promise<ListRecordSetsResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/hostedZones/*");
+    return this.service.call<ListRecordSetsResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/recordSets`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listRecordSets lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allRecordSets(request: ListRecordSetsRequest, options?: CallOptions): AsyncGenerator<RecordSet, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listRecordSets(page, options);
+      yield* response.recordSets ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Creates a record set. Refused with `CONFLICT` when the zone holds a
+   * record set of that name and type, or when a CNAME would share its name.
+   * Refused with `BAD_REQUEST` for a name outside the zone, a value its
+   * type doesn't take, an alias to a Floating IP outside the zone's
+   * project, or once the project's or organization's quota of record sets
+   * is used up. An alias to a Floating IP that was created moments ago may
+   * be refused with `SERVICE_UNAVAILABLE`, retryable.
+   */
+  async createRecordSet(request: CreateRecordSetRequest, options?: CallOptions): Promise<RecordSet> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/hostedZones/*");
+    return this.service.call<RecordSet>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/recordSets`,
+        body: request.recordSet,
+        query: query(request, ["parent", "recordSet"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Replaces a record set's TTL or what it answers with: `ttl`, `basic` or
+   * `alias`, or `*`. Naming one kind in `updateMask` replaces the kind the
+   * record set had. With `*`, a TTL left out keeps the record set's; naming
+   * `ttl` without one sets the default, 300 seconds. Its name and type
+   * stay; another type is a new record set.
+   */
+  async updateRecordSet(request: UpdateRecordSetRequest, options?: CallOptions): Promise<RecordSet> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("recordSet.name", request.recordSet?.name, "projects/*/hostedZones/*/recordSets/*");
+    return this.service.call<RecordSet>(
+      {
+        method: "PATCH",
+        path: `/v1beta1/${p0}`,
+        body: request.recordSet,
+        query: query(request, ["recordSet.name", "recordSet"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /** Deletes a record set. */
+  async deleteRecordSet(request: DeleteRecordSetRequest, options?: CallOptions): Promise<Empty> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/hostedZones/*/recordSets/*");
+    return this.service.call<Empty>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Deletes, replaces and creates record sets of one zone together, all or
+   * none. The zone is checked as the changes leave it, not after each
+   * change, so a CNAME may take the place of the A record set it replaces
+   * in one call. A batch makes 1 to 1000 changes, and names a record set
+   * once at most across `deletions` and `updates`. Each change is refused
+   * as its own method would refuse it, naming the change; then none is
+   * made.
+   */
+  async batchChangeRecordSets(request: BatchChangeRecordSetsRequest, options?: CallOptions): Promise<BatchChangeRecordSetsResponse> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/hostedZones/*");
+    return this.service.call<BatchChangeRecordSetsResponse>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/recordSets:batchChange`,
+        body: request,
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** Every record of one name and type in a hosted zone. */
+export interface RecordSet {
+  /** The record set's resource name. */
+  name?: string;
+  /**
+   * The record set's URN, the identifier access policies and the audit log
+   * use.
+   */
+  urn?: string;
+  /**
+   * The name the records answer for: the zone's `dnsName` or a name below
+   * it, written in full, such as `www.example.com`, without the final dot;
+   * answered in lowercase. Labels may hold `_` (`_dmarc.example.com`), and
+   * `*` only as the whole leftmost label, for a wildcard.
+   */
+  dnsName?: string;
+  /** The records' type. An alias is `A`. */
+  type?: RecordSet_Type;
+  /**
+   * How long resolvers may keep the answer, from 30 seconds to 7 days, in
+   * whole seconds. 300 seconds when left out.
+   */
+  ttl?: string;
+  /** Values of its own. */
+  basic?: BasicRecordData;
+  /** The address of a platform resource, followed as it changes. */
+  alias?: AliasRecordData;
+  /** When the record set was created. */
+  createTime?: string;
+  /** When the record set was last changed. */
+  updateTime?: string;
+}
+
+/** A record type. */
+export const RecordSet_Type = {
+  /** Not set. */
+  TYPE_UNSPECIFIED: "TYPE_UNSPECIFIED",
+  /** IPv4 addresses. */
+  A: "A",
+  /** IPv6 addresses. */
+  AAAA: "AAAA",
+  /** Another name this one is an alias of. */
+  CNAME: "CNAME",
+  /** Text. */
+  TXT: "TXT",
+  /** Mail exchangers. */
+  MX: "MX",
+  /** Service locations. */
+  SRV: "SRV",
+  /** The certificate authorities that may issue for the name. */
+  CAA: "CAA",
+} as const;
+
+/** A record type. */
+export type RecordSet_Type = (typeof RecordSet_Type)[keyof typeof RecordSet_Type];
+
+/** A record set's own values. */
+export interface BasicRecordData {
+  /**
+   * The records' values, 1 to 100, each once, written as `type` says. Names
+   * are written in full without the final dot, and answered in lowercase.
+   * - `A`: an IPv4 address, `192.0.2.10`.
+   * - `AAAA`: an IPv6 address, `2001:db8::10`.
+   * - `CNAME`: one name, `www.example.net`.
+   * - `TXT`: the text as it is, printable ASCII, up to 4000 characters,
+   *   without quotes; it is split into strings of 255 characters on the
+   *   wire.
+   * - `MX`: `{preference} {exchange}`, `10 mail.example.com`. `0 .`, alone,
+   *   says the name takes no mail.
+   * - `SRV`: `{priority} {weight} {port} {target}`,
+   *   `10 5 5060 sip.example.com`. A target of `.`, alone, says the service
+   *   isn't offered.
+   * - `CAA`: `{flags} {tag} {value}`, `0 issue letsencrypt.org`: flags 0 or
+   *   128, the value as it is, without quotes.
+   *
+   * A record set's records take at most 16 KiB on the wire.
+   */
+  values?: string[];
+}
+
+/**
+ * An alias: the record set answers with a platform resource's address, and
+ * follows it as it changes.
+ */
+export interface AliasRecordData {
+  /**
+   * The Floating IP whose address the record set answers with, in the
+   * zone's project. A Floating IP's address is an IPv4 address, so the
+   * record set is of type `A`; an `AAAA` alias is refused.
+   */
+  floatingIp?: string;
+}
+
+/** The request for GetRecordSet. */
+export interface GetRecordSetRequest {
+  /** The record set to return. */
+  name?: string;
+}
+
+/** The request for ListRecordSets. */
+export interface ListRecordSetsRequest {
+  /**
+   * The zone whose record sets to list,
+   * `projects/{project}/hostedZones/{hosted_zone}`.
+   */
+  parent?: string;
+  /**
+   * The most record sets to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+  /**
+   * Only the record sets of this name, written as `dnsName` is; every
+   * name's when left empty.
+   */
+  dnsName?: string;
+  /** Only the record sets of this type; every type's when left unset. */
+  type?: RecordSet_Type;
+}
+
+/** The response for ListRecordSets. */
+export interface ListRecordSetsResponse {
+  /** The record sets on this page. */
+  recordSets?: RecordSet[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateRecordSet. */
+export interface CreateRecordSetRequest {
+  /**
+   * The zone to create the record set in,
+   * `projects/{project}/hostedZones/{hosted_zone}`.
+   */
+  parent?: string;
+  /**
+   * The record set to create: its `dnsName`, `type`, optionally its
+   * `ttl`, and one of `basic` and `alias`.
+   */
+  recordSet?: RecordSet;
+  /**
+   * A UUID; a repeat with the same id within a day returns the record set
+   * the first request created, as it is now, instead of being refused as a
+   * conflict.
+   */
+  requestId?: string;
+}
+
+/** The request for UpdateRecordSet. */
+export interface UpdateRecordSetRequest {
+  /** The record set, by its name, with the fields to change. */
+  recordSet?: RecordSet;
+  /** The fields to change: `ttl`, `basic`, `alias`, or `*`. */
+  updateMask?: string;
+  /**
+   * A UUID; a repeat with the same id within a day returns the record set
+   * as the first request left it, instead of changing it again.
+   */
+  requestId?: string;
+}
+
+/** The request for DeleteRecordSet. */
+export interface DeleteRecordSetRequest {
+  /** The record set to delete. */
+  name?: string;
+  /**
+   * A UUID; a repeat with the same id within a day succeeds as the first
+   * did, instead of answering `NOT_FOUND`.
+   */
+  requestId?: string;
+}
+
+/** The request for BatchChangeRecordSets. */
+export interface BatchChangeRecordSetsRequest {
+  /**
+   * The zone whose record sets to change,
+   * `projects/{project}/hostedZones/{hosted_zone}`.
+   */
+  parent?: string;
+  /** The record sets to delete, by name. */
+  deletions?: string[];
+  /**
+   * The record sets to change, each with the fields to change, as
+   * `UpdateRecordSet` takes them.
+   */
+  updates?: RecordSetUpdate[];
+  /** The record sets to create, as `CreateRecordSet` takes them. */
+  creations?: RecordSet[];
+  /**
+   * A UUID; a repeat with the same id within a day answers with the record
+   * sets the first request changed and created, as they are now, instead of
+   * making the changes again.
+   */
+  requestId?: string;
+}
+
+/** One change of a `BatchChangeRecordSets` request. */
+export interface RecordSetUpdate {
+  /** The record set, by its name, with the fields to change. */
+  recordSet?: RecordSet;
+  /** The fields to change: `ttl`, `basic`, `alias`, or `*`. */
+  updateMask?: string;
+}
+
+/** The response for BatchChangeRecordSets. */
+export interface BatchChangeRecordSetsResponse {
+  /**
+   * The record sets changed, then those created, each in the order of the
+   * request.
+   */
+  recordSets?: RecordSet[];
+}

package/src/v1beta1/vpc_attachment.ts

@@ -0,0 +1,201 @@
+// Code generated by the SDK's generator (generator/). DO NOT EDIT.
+// source: origincloud/dns/v1beta1/vpc_attachment.proto
+
+import {
+  type CallOptions,
+  type Client,
+  type Empty,
+  type Service,
+  newRequestId,
+  pathValue,
+  query,
+} from "@origincloud/core";
+
+/**
+ * Calls VpcAttachmentService.
+ *
+ * VPC attachments: the VPCs a private zone answers in. Each attachment
+ * makes the zone's names resolve from every instance in one VPC, in every
+ * zone the VPC spans, and from no other VPC. A private zone attaches only
+ * to VPCs of its own project, and a VPC holds at most one attached zone of
+ * a name. An attachment's id is the VPC's id, so a client that knows the
+ * zone and the VPC names the attachment without listing. Deleting a VPC
+ * deletes its attachments. Attaching a public zone is refused: it answers on
+ * the internet, in every VPC alike.
+ */
+export class VpcAttachmentClient {
+  /**
+   * The endpoint the client sends its calls to, which also serves the
+   * operations its methods answer with.
+   */
+  readonly service: Service;
+
+  /** A client of VpcAttachmentService that sends its calls through `client`. */
+  constructor(client: Client) {
+    this.service = client.service("dns", false);
+  }
+
+  /** Returns a VPC attachment. */
+  async getVpcAttachment(request: GetVpcAttachmentRequest, options?: CallOptions): Promise<VpcAttachment> {
+    const p0 = pathValue("name", request.name, "projects/*/hostedZones/*/vpcAttachments/*");
+    return this.service.call<VpcAttachment>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Lists a private zone's VPC attachments, oldest first. With `-` for the
+   * zone, lists every zone's in the project, which with `vpc` finds the
+   * zones attached to a VPC.
+   */
+  async listVpcAttachments(request: ListVpcAttachmentsRequest, options?: CallOptions): Promise<ListVpcAttachmentsResponse> {
+    const p0 = pathValue("parent", request.parent, "projects/*/hostedZones/*");
+    return this.service.call<ListVpcAttachmentsResponse>(
+      {
+        method: "GET",
+        path: `/v1beta1/${p0}/vpcAttachments`,
+        query: query(request, ["parent"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Iterates over everything listVpcAttachments lists from the request's page on,
+   * fetching the next page as the loop reaches it. A page that fails ends
+   * the iteration with its error.
+   */
+  async *allVpcAttachments(request: ListVpcAttachmentsRequest, options?: CallOptions): AsyncGenerator<VpcAttachment, void, undefined> {
+    for (let page = request; ; ) {
+      const response = await this.listVpcAttachments(page, options);
+      yield* response.vpcAttachments ?? [];
+      if (!response.nextPageToken) return;
+      page = { ...page, pageToken: response.nextPageToken };
+    }
+  }
+
+  /**
+   * Attaches a private zone to a VPC of the zone's project. Refused with
+   * `BAD_REQUEST` for a public zone, or for a VPC that isn't in the zone's
+   * project, with the same words whichever project it is in. Refused with
+   * `CONFLICT` when the VPC holds an attached zone of the same name. A VPC
+   * created moments ago may be refused with `SERVICE_UNAVAILABLE`,
+   * retryable. The VPC's instances resolve the zone's names once the VPC's
+   * hosts serve the zone.
+   */
+  async createVpcAttachment(request: CreateVpcAttachmentRequest, options?: CallOptions): Promise<VpcAttachment> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("parent", request.parent, "projects/*/hostedZones/*");
+    return this.service.call<VpcAttachment>(
+      {
+        method: "POST",
+        path: `/v1beta1/${p0}/vpcAttachments`,
+        body: request.vpcAttachment,
+        query: query(request, ["parent", "vpcAttachment"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+
+  /**
+   * Detaches a private zone from a VPC. The VPC's instances stop resolving
+   * the zone's names once the VPC's hosts drop the zone.
+   */
+  async deleteVpcAttachment(request: DeleteVpcAttachmentRequest, options?: CallOptions): Promise<Empty> {
+    if (!request.requestId) request = { ...request, requestId: newRequestId() };
+    const p0 = pathValue("name", request.name, "projects/*/hostedZones/*/vpcAttachments/*");
+    return this.service.call<Empty>(
+      {
+        method: "DELETE",
+        path: `/v1beta1/${p0}`,
+        query: query(request, ["name"]),
+        idempotent: true,
+      },
+      options,
+    );
+  }
+}
+
+/** A VPC a private zone answers in. */
+export interface VpcAttachment {
+  /** The attachment's resource name. Its last segment is the VPC's id. */
+  name?: string;
+  /**
+   * The attachment's URN, the identifier access policies and the audit log
+   * use.
+   */
+  urn?: string;
+  /** The VPC the zone answers in, in the zone's project. */
+  vpc?: string;
+  /** When the zone was attached. */
+  createTime?: string;
+}
+
+/** The request for GetVpcAttachment. */
+export interface GetVpcAttachmentRequest {
+  /** The attachment to return. */
+  name?: string;
+}
+
+/** The request for ListVpcAttachments. */
+export interface ListVpcAttachmentsRequest {
+  /**
+   * The private zone whose attachments to list,
+   * `projects/{project}/hostedZones/{hosted_zone}`, or `-` for the zone to
+   * list every zone's in the project.
+   */
+  parent?: string;
+  /**
+   * The most attachments to return; the server clamps it, and 0 means its
+   * default.
+   */
+  pageSize?: number;
+  /** A previous response's `nextPageToken`, for the page after it. */
+  pageToken?: string;
+  /** Only the attachments to this VPC; every VPC's when left empty. */
+  vpc?: string;
+}
+
+/** The response for ListVpcAttachments. */
+export interface ListVpcAttachmentsResponse {
+  /** The attachments on this page. */
+  vpcAttachments?: VpcAttachment[];
+  /** The token for the next page; empty on the last one. */
+  nextPageToken?: string;
+}
+
+/** The request for CreateVpcAttachment. */
+export interface CreateVpcAttachmentRequest {
+  /**
+   * The private zone to attach,
+   * `projects/{project}/hostedZones/{hosted_zone}`.
+   */
+  parent?: string;
+  /** The attachment to create: its `vpc`. */
+  vpcAttachment?: VpcAttachment;
+  /**
+   * A UUID; a repeat with the same id within a day returns the attachment
+   * the first request created, as it is now, instead of being refused as a
+   * conflict.
+   */
+  requestId?: string;
+}
+
+/** The request for DeleteVpcAttachment. */
+export interface DeleteVpcAttachmentRequest {
+  /** The attachment to delete. */
+  name?: string;
+  /**
+   * A UUID; a repeat with the same id within a day succeeds as the first
+   * did, instead of answering `NOT_FOUND`.
+   */
+  requestId?: string;
+}