feat(document_db): align proto with rdb proto (#399)

Author: scaleway-bot

scaleway-async/scaleway_async/document_db/v1beta1/__init__.py

@@ -18,6 +18,7 @@
 from .types import Permission
 from .types import ReadReplicaStatus
 from .types import SnapshotStatus
+from .types import StorageClass
 from .types import VolumeType
 from .types import ACLRule
 from .types import ACLRuleRequest
@@ -67,7 +68,9 @@
 from .types import SetInstanceACLRulesResponse
 from .types import SetInstanceSettingsResponse
 from .types import Snapshot
+from .types import SnapshotVolumeType
 from .types import UpgradableVersion
+from .types import UpgradeInstanceRequestMajorUpgradeWorkflow
 from .types import User
 from .types import Volume
 from .content import INSTANCE_LOG_TRANSIENT_STATUSES
@@ -96,6 +99,7 @@
     "Permission",
     "ReadReplicaStatus",
     "SnapshotStatus",
+    "StorageClass",
     "VolumeType",
     "ACLRule",
     "ACLRuleRequest",
@@ -145,7 +149,9 @@
     "SetInstanceACLRulesResponse",
     "SetInstanceSettingsResponse",
     "Snapshot",
+    "SnapshotVolumeType",
     "UpgradableVersion",
+    "UpgradeInstanceRequestMajorUpgradeWorkflow",
     "User",
     "Volume",
     "INSTANCE_LOG_TRANSIENT_STATUSES",

scaleway-async/scaleway_async/document_db/v1beta1/api.py

@@ -58,6 +58,7 @@
     SetInstanceACLRulesResponse,
     SetInstanceSettingsResponse,
     Snapshot,
+    UpgradeInstanceRequestMajorUpgradeWorkflow,
     User,
     UpgradeInstanceRequest,
     CreateInstanceRequest,
@@ -312,6 +313,9 @@ async def upgrade_instance(
         volume_size: Optional[int] = None,
         volume_type: Optional[VolumeType] = None,
         upgradable_version_id: Optional[str] = None,
+        major_upgrade_workflow: Optional[
+            UpgradeInstanceRequestMajorUpgradeWorkflow
+        ] = None,
     ) -> Instance:
         """
         Upgrade a Database Instance.
@@ -320,20 +324,23 @@ async def upgrade_instance(
         :param instance_id: UUID of the Database Instance you want to upgrade.
         :param node_type: Node type of the Database Instance you want to upgrade to.
 
-        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
         :param enable_ha: Defines whether or not High Availability should be enabled on the Database Instance.
 
-        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
         :param volume_size: Increase your Block volume size.
 
-        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
         :param volume_type: Change your Database Instance storage type.
 
-        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
         :param upgradable_version_id: Update your database engine to a newer version.
         This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.
 
-        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
+        :param major_upgrade_workflow: Upgrade your database engine to a new major version including instance endpoints.
+
+        One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
         :return: :class:`Instance <Instance>`
 
         Usage:
@@ -359,6 +366,7 @@ async def upgrade_instance(
                     volume_size=volume_size,
                     volume_type=volume_type,
                     upgradable_version_id=upgradable_version_id,
+                    major_upgrade_workflow=major_upgrade_workflow,
                 ),
                 self.client,
             ),

scaleway-async/scaleway_async/document_db/v1beta1/marshalling.py

@@ -63,7 +63,9 @@
     SetInstanceACLRulesResponse,
     SetInstanceSettingsResponse,
     Snapshot,
+    SnapshotVolumeType,
     UpgradableVersion,
+    UpgradeInstanceRequestMajorUpgradeWorkflow,
     User,
     Volume,
     UpgradeInstanceRequest,
@@ -365,6 +367,9 @@ def unmarshal_NodeTypeVolumeType(data: Any) -> NodeTypeVolumeType:
     field = data.get("chunk_size", None)
     args["chunk_size"] = field
 
+    field = data.get("class", None)
+    args["class_"] = field
+
     field = data.get("description", None)
     args["description"] = field
 
@@ -408,6 +413,23 @@ def unmarshal_ReadReplica(data: Any) -> ReadReplica:
     return ReadReplica(**args)
 
 
+def unmarshal_SnapshotVolumeType(data: Any) -> SnapshotVolumeType:
+    if type(data) is not dict:
+        raise TypeError(
+            f"Unmarshalling the type 'SnapshotVolumeType' failed as data isn't a dictionary."
+        )
+
+    args: Dict[str, Any] = {}
+
+    field = data.get("class", None)
+    args["class_"] = field
+
+    field = data.get("type", None)
+    args["type_"] = field
+
+    return SnapshotVolumeType(**args)
+
+
 def unmarshal_UpgradableVersion(data: Any) -> UpgradableVersion:
     if type(data) is not dict:
         raise TypeError(
@@ -439,6 +461,9 @@ def unmarshal_Volume(data: Any) -> Volume:
 
     args: Dict[str, Any] = {}
 
+    field = data.get("class", None)
+    args["class_"] = field
+
     field = data.get("size", None)
     args["size"] = field
 
@@ -785,6 +810,11 @@ def unmarshal_Snapshot(data: Any) -> Snapshot:
     field = data.get("updated_at", None)
     args["updated_at"] = parser.isoparse(field) if type(field) is str else field
 
+    field = data.get("volume_type", None)
+    args["volume_type"] = (
+        unmarshal_SnapshotVolumeType(field) if field is not None else None
+    )
+
     return Snapshot(**args)
 
 
@@ -1300,6 +1330,21 @@ def marshal_ReadReplicaEndpointSpec(
     return output
 
 
+def marshal_UpgradeInstanceRequestMajorUpgradeWorkflow(
+    request: UpgradeInstanceRequestMajorUpgradeWorkflow,
+    defaults: ProfileDefaults,
+) -> Dict[str, Any]:
+    output: Dict[str, Any] = {}
+
+    if request.upgradable_version_id is not None:
+        output["upgradable_version_id"] = request.upgradable_version_id
+
+    if request.with_endpoints is not None:
+        output["with_endpoints"] = request.with_endpoints
+
+    return output
+
+
 def marshal_AddInstanceACLRulesRequest(
     request: AddInstanceACLRulesRequest,
     defaults: ProfileDefaults,
@@ -1709,6 +1754,14 @@ def marshal_UpgradeInstanceRequest(
                     if request.upgradable_version_id is not None
                     else None,
                 ),
+                OneOfPossibility(
+                    "major_upgrade_workflow",
+                    marshal_UpgradeInstanceRequestMajorUpgradeWorkflow(
+                        request.major_upgrade_workflow, defaults
+                    )
+                    if request.major_upgrade_workflow is not None
+                    else None,
+                ),
             ]
         ),
     )

scaleway-async/scaleway_async/document_db/v1beta1/types.py

@@ -216,9 +216,21 @@ def __str__(self) -> str:
         return str(self.value)
 
 
+class StorageClass(str, Enum, metaclass=StrEnumMeta):
+    UNKNOWN_STORAGE_CLASS = "unknown_storage_class"
+    LSSD = "lssd"
+    BSSD = "bssd"
+    SBS = "sbs"
+
+    def __str__(self) -> str:
+        return str(self.value)
+
+
 class VolumeType(str, Enum, metaclass=StrEnumMeta):
     LSSD = "lssd"
     BSSD = "bssd"
+    SBS_5K = "sbs_5k"
+    SBS_15K = "sbs_15k"
 
     def __str__(self) -> str:
         return str(self.value)
@@ -1150,6 +1162,11 @@ class NodeTypeVolumeType:
     Minimum increment level for a Block Storage volume size.
     """
 
+    class_: StorageClass
+    """
+    The storage class of the volume.
+    """
+
 
 @dataclass
 class Privilege:
@@ -1342,12 +1359,24 @@ class Snapshot:
     Source node type.
     """
 
+    volume_type: Optional[SnapshotVolumeType]
+    """
+    Type of volume where data is stored (lssd, bssd or sbs).
+    """
+
     region: Region
     """
     Region of this snapshot.
     """
 
 
+@dataclass
+class SnapshotVolumeType:
+    type_: VolumeType
+
+    class_: StorageClass
+
+
 @dataclass
 class UpgradableVersion:
     id: str
@@ -1359,6 +1388,25 @@ class UpgradableVersion:
     minor_version: str
 
 
+@dataclass
+class UpgradeInstanceRequestMajorUpgradeWorkflow:
+    """
+    Upgrade instance request. major upgrade workflow.
+    """
+
+    upgradable_version_id: str
+    """
+    Update your database engine to a newer version.
+    This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.
+    """
+
+    with_endpoints: bool
+    """
+    Include endpoint during the migration.
+    At the end of the migration procedure this option let you migrate all your database endpoint to the upgraded instance.
+    """
+
+
 @dataclass
 class User:
     """
@@ -1382,6 +1430,8 @@ class Volume:
 
     size: int
 
+    class_: StorageClass
+
 
 @dataclass
 class ListDatabaseEnginesRequest:
@@ -1438,36 +1488,43 @@ class UpgradeInstanceRequest:
     """
     Node type of the Database Instance you want to upgrade to.
     
-    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
     """
 
     enable_ha: Optional[bool]
     """
     Defines whether or not High Availability should be enabled on the Database Instance.
     
-    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
     """
 
     volume_size: Optional[int]
     """
     Increase your Block volume size.
     
-    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
     """
 
     volume_type: Optional[VolumeType]
     """
     Change your Database Instance storage type.
     
-    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
     """
 
     upgradable_version_id: Optional[str]
     """
     Update your database engine to a newer version.
     This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade.
     
-    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id' could be set.
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
+    """
+
+    major_upgrade_workflow: Optional[UpgradeInstanceRequestMajorUpgradeWorkflow]
+    """
+    Upgrade your database engine to a new major version including instance endpoints.
+    
+    One-of ('upgrade_target'): at most one of 'node_type', 'enable_ha', 'volume_size', 'volume_type', 'upgradable_version_id', 'major_upgrade_workflow' could be set.
     """
 
 

scaleway/scaleway/document_db/v1beta1/__init__.py

@@ -18,6 +18,7 @@
 from .types import Permission
 from .types import ReadReplicaStatus
 from .types import SnapshotStatus
+from .types import StorageClass
 from .types import VolumeType
 from .types import ACLRule
 from .types import ACLRuleRequest
@@ -67,7 +68,9 @@
 from .types import SetInstanceACLRulesResponse
 from .types import SetInstanceSettingsResponse
 from .types import Snapshot
+from .types import SnapshotVolumeType
 from .types import UpgradableVersion
+from .types import UpgradeInstanceRequestMajorUpgradeWorkflow
 from .types import User
 from .types import Volume
 from .content import INSTANCE_LOG_TRANSIENT_STATUSES
@@ -96,6 +99,7 @@
     "Permission",
     "ReadReplicaStatus",
     "SnapshotStatus",
+    "StorageClass",
     "VolumeType",
     "ACLRule",
     "ACLRuleRequest",
@@ -145,7 +149,9 @@
     "SetInstanceACLRulesResponse",
     "SetInstanceSettingsResponse",
     "Snapshot",
+    "SnapshotVolumeType",
     "UpgradableVersion",
+    "UpgradeInstanceRequestMajorUpgradeWorkflow",
     "User",
     "Volume",
     "INSTANCE_LOG_TRANSIENT_STATUSES",