feat(rdb): add read replica

packages/clients/src/api/rdb/v1/api.gen.ts

@@ -23,6 +23,8 @@ import {
   marshalCreateEndpointRequest,
   marshalCreateInstanceFromSnapshotRequest,
   marshalCreateInstanceRequest,
+  marshalCreateReadReplicaEndpointRequest,
+  marshalCreateReadReplicaRequest,
   marshalCreateSnapshotRequest,
   marshalCreateUserRequest,
   marshalDeleteInstanceACLRulesRequest,
@@ -61,6 +63,7 @@ import {
   unmarshalListUsersResponse,
   unmarshalPrepareInstanceLogsResponse,
   unmarshalPrivilege,
+  unmarshalReadReplica,
   unmarshalSetInstanceACLRulesResponse,
   unmarshalSetInstanceSettingsResponse,
   unmarshalSnapshot,
@@ -77,6 +80,8 @@ import type {
   CreateEndpointRequest,
   CreateInstanceFromSnapshotRequest,
   CreateInstanceRequest,
+  CreateReadReplicaEndpointRequest,
+  CreateReadReplicaRequest,
   CreateSnapshotRequest,
   CreateUserRequest,
   Database,
@@ -89,6 +94,7 @@ import type {
   DeleteInstanceRequest,
   DeleteInstanceSettingsRequest,
   DeleteInstanceSettingsResponse,
+  DeleteReadReplicaRequest,
   DeleteSnapshotRequest,
   DeleteUserRequest,
   Endpoint,
@@ -99,6 +105,7 @@ import type {
   GetInstanceLogRequest,
   GetInstanceMetricsRequest,
   GetInstanceRequest,
+  GetReadReplicaRequest,
   GetSnapshotRequest,
   Instance,
   InstanceLog,
@@ -129,7 +136,9 @@ import type {
   PrepareInstanceLogsResponse,
   Privilege,
   PurgeInstanceLogsRequest,
+  ReadReplica,
   RenewInstanceCertificateRequest,
+  ResetReadReplicaRequest,
   RestartInstanceRequest,
   RestoreDatabaseBackupRequest,
   SetInstanceACLRulesRequest,
@@ -703,6 +712,123 @@ export class RdbV1GenAPI extends API {
       unmarshalInstanceMetrics,
     )
 
+  /**
+   * Create a read replica
+   *
+   * @param request - The request {@link CreateReadReplicaRequest}
+   * @returns A Promise of ReadReplica
+   */
+  createReadReplica = (request: Readonly<CreateReadReplicaRequest>) =>
+    this.client.fetch<ReadReplica>(
+      {
+        body: JSON.stringify(
+          marshalCreateReadReplicaRequest(request, this.client.settings),
+        ),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/rdb/v1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/read-replicas`,
+      },
+      unmarshalReadReplica,
+    )
+
+  /**
+   * Get a read replica
+   *
+   * @param request - The request {@link GetReadReplicaRequest}
+   * @returns A Promise of ReadReplica
+   */
+  getReadReplica = (request: Readonly<GetReadReplicaRequest>) =>
+    this.client.fetch<ReadReplica>(
+      {
+        method: 'GET',
+        path: `/rdb/v1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/read-replicas/${validatePathParam(
+          'readReplicaId',
+          request.readReplicaId,
+        )}`,
+      },
+      unmarshalReadReplica,
+    )
+
+  /**
+   * Delete a read replica
+   *
+   * @param request - The request {@link DeleteReadReplicaRequest}
+   * @returns A Promise of ReadReplica
+   */
+  deleteReadReplica = (request: Readonly<DeleteReadReplicaRequest>) =>
+    this.client.fetch<ReadReplica>(
+      {
+        method: 'DELETE',
+        path: `/rdb/v1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/read-replicas/${validatePathParam(
+          'readReplicaId',
+          request.readReplicaId,
+        )}`,
+      },
+      unmarshalReadReplica,
+    )
+
+  /**
+   * Reset a read replica
+   *
+   * @param request - The request {@link ResetReadReplicaRequest}
+   * @returns A Promise of ReadReplica
+   */
+  resetReadReplica = (request: Readonly<ResetReadReplicaRequest>) =>
+    this.client.fetch<ReadReplica>(
+      {
+        body: '{}',
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/rdb/v1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/read-replicas/${validatePathParam(
+          'readReplicaId',
+          request.readReplicaId,
+        )}/reset`,
+      },
+      unmarshalReadReplica,
+    )
+
+  /**
+   * Create a new endpoint for a given read replica
+   *
+   * @param request - The request {@link CreateReadReplicaEndpointRequest}
+   * @returns A Promise of ReadReplica
+   */
+  createReadReplicaEndpoint = (
+    request: Readonly<CreateReadReplicaEndpointRequest>,
+  ) =>
+    this.client.fetch<ReadReplica>(
+      {
+        body: JSON.stringify(
+          marshalCreateReadReplicaEndpointRequest(
+            request,
+            this.client.settings,
+          ),
+        ),
+        headers: jsonContentHeaders,
+        method: 'POST',
+        path: `/rdb/v1/regions/${validatePathParam(
+          'region',
+          request.region ?? this.client.settings.defaultRegion,
+        )}/read-replicas/${validatePathParam(
+          'readReplicaId',
+          request.readReplicaId,
+        )}/endpoints`,
+      },
+      unmarshalReadReplica,
+    )
+
   /**
    * Prepare your instance logs. Logs will be grouped on a minimum interval of a day.
    *

packages/clients/src/api/rdb/v1/marshalling.gen.ts

@@ -23,6 +23,8 @@ import type {
   CreateEndpointRequest,
   CreateInstanceFromSnapshotRequest,
   CreateInstanceRequest,
+  CreateReadReplicaEndpointRequest,
+  CreateReadReplicaRequest,
   CreateSnapshotRequest,
   CreateUserRequest,
   Database,
@@ -66,6 +68,10 @@ import type {
   PrepareInstanceLogsResponse,
   Privilege,
   PurgeInstanceLogsRequest,
+  ReadReplica,
+  ReadReplicaEndpointSpec,
+  ReadReplicaEndpointSpecDirectAccess,
+  ReadReplicaEndpointSpecPrivateNetwork,
   RestoreDatabaseBackupRequest,
   SetInstanceACLRulesRequest,
   SetInstanceACLRulesResponse,
@@ -116,6 +122,31 @@ const unmarshalEndpointPrivateNetworkDetails = (data: unknown) => {
   } as EndpointPrivateNetworkDetails
 }
 
+export const unmarshalEndpoint = (data: unknown) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Endpoint' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    directAccess: data.direct_access
+      ? unmarshalEndpointDirectAccessDetails(data.direct_access)
+      : undefined,
+    hostname: data.hostname,
+    id: data.id,
+    ip: data.ip,
+    loadBalancer: data.load_balancer
+      ? unmarshalEndpointLoadBalancerDetails(data.load_balancer)
+      : undefined,
+    name: data.name,
+    port: data.port,
+    privateNetwork: data.private_network
+      ? unmarshalEndpointPrivateNetworkDetails(data.private_network)
+      : undefined,
+  } as Endpoint
+}
+
 const unmarshalEngineSetting = (data: unknown) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -152,31 +183,6 @@ const unmarshalBackupSchedule = (data: unknown) => {
   } as BackupSchedule
 }
 
-export const unmarshalEndpoint = (data: unknown) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Endpoint' failed as data isn't a dictionary.`,
-    )
-  }
-
-  return {
-    directAccess: data.direct_access
-      ? unmarshalEndpointDirectAccessDetails(data.direct_access)
-      : undefined,
-    hostname: data.hostname,
-    id: data.id,
-    ip: data.ip,
-    loadBalancer: data.load_balancer
-      ? unmarshalEndpointLoadBalancerDetails(data.load_balancer)
-      : undefined,
-    name: data.name,
-    port: data.port,
-    privateNetwork: data.private_network
-      ? unmarshalEndpointPrivateNetworkDetails(data.private_network)
-      : undefined,
-  } as Endpoint
-}
-
 const unmarshalEngineVersion = (data: unknown) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -269,6 +275,21 @@ const unmarshalNodeTypeVolumeType = (data: unknown) => {
   } as NodeTypeVolumeType
 }
 
+export const unmarshalReadReplica = (data: unknown) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ReadReplica' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    endpoints: unmarshalArrayOfObject(data.endpoints, unmarshalEndpoint),
+    id: data.id,
+    region: data.region,
+    status: data.status,
+  } as ReadReplica
+}
+
 const unmarshalVolume = (data: unknown) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -384,6 +405,10 @@ export const unmarshalInstance = (data: unknown) => {
     nodeType: data.node_type,
     organizationId: data.organization_id,
     projectId: data.project_id,
+    readReplicas: unmarshalArrayOfObject(
+      data.read_replicas,
+      unmarshalReadReplica,
+    ),
     region: data.region,
     settings: unmarshalArrayOfObject(data.settings, unmarshalInstanceSetting),
     status: data.status,
@@ -760,6 +785,19 @@ const marshalEndpointSpecPrivateNetwork = (
   service_ip: request.serviceIp,
 })
 
+const marshalReadReplicaEndpointSpecDirectAccess = (
+  request: ReadReplicaEndpointSpecDirectAccess,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({})
+
+const marshalReadReplicaEndpointSpecPrivateNetwork = (
+  request: ReadReplicaEndpointSpecPrivateNetwork,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  private_network_id: request.privateNetworkId,
+  service_ip: request.serviceIp,
+})
+
 const marshalACLRuleRequest = (
   request: ACLRuleRequest,
   defaults: DefaultValues,
@@ -804,6 +842,32 @@ const marshalLogsPolicy = (
   total_disk_retention: request.totalDiskRetention,
 })
 
+const marshalReadReplicaEndpointSpec = (
+  request: ReadReplicaEndpointSpec,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  ...resolveOneOf<unknown>([
+    {
+      param: 'direct_access',
+      value: request.directAccess
+        ? marshalReadReplicaEndpointSpecDirectAccess(
+            request.directAccess,
+            defaults,
+          )
+        : undefined,
+    },
+    {
+      param: 'private_network',
+      value: request.privateNetwork
+        ? marshalReadReplicaEndpointSpecPrivateNetwork(
+            request.privateNetwork,
+            defaults,
+          )
+        : undefined,
+    },
+  ]),
+})
+
 export const marshalAddInstanceACLRulesRequest = (
   request: AddInstanceACLRulesRequest,
   defaults: DefaultValues,
@@ -896,6 +960,27 @@ export const marshalCreateInstanceRequest = (
   ]),
 })
 
+export const marshalCreateReadReplicaEndpointRequest = (
+  request: CreateReadReplicaEndpointRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  endpoint_spec: request.endpointSpec.map(elt =>
+    marshalReadReplicaEndpointSpec(elt, defaults),
+  ),
+})
+
+export const marshalCreateReadReplicaRequest = (
+  request: CreateReadReplicaRequest,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  endpoint_spec: request.endpointSpec
+    ? request.endpointSpec.map(elt =>
+        marshalReadReplicaEndpointSpec(elt, defaults),
+      )
+    : undefined,
+  instance_id: request.instanceId,
+})
+
 export const marshalCreateSnapshotRequest = (
   request: CreateSnapshotRequest,
   defaults: DefaultValues,