gcore 0.1.0a1__py3-none-any.whl

gcore/types/cloud/volume.py

@@ -0,0 +1,141 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .tag import Tag
+from ..._models import BaseModel
+
+__all__ = ["Volume", "Attachment", "LimiterStats"]
+
+
+class Attachment(BaseModel):
+    attachment_id: str
+    """The unique identifier of the attachment object."""
+
+    volume_id: str
+    """The unique identifier of the attached volume."""
+
+    attached_at: Optional[datetime] = None
+    """The date and time when the attachment was created."""
+
+    device: Optional[str] = None
+    """The block device name inside the guest instance."""
+
+    flavor_id: Optional[str] = None
+    """The flavor ID of the instance."""
+
+    instance_name: Optional[str] = None
+    """The name of the instance if attached and the server name is known."""
+
+    server_id: Optional[str] = None
+    """The unique identifier of the instance."""
+
+
+class LimiterStats(BaseModel):
+    iops_base_limit: int
+    """The sustained IOPS (Input/Output Operations Per Second) limit."""
+
+    iops_burst_limit: int
+    """The burst IOPS limit."""
+
+    m_bps_base_limit: int = FieldInfo(alias="MBps_base_limit")
+    """The sustained bandwidth limit in megabytes per second (MBps)."""
+
+    m_bps_burst_limit: int = FieldInfo(alias="MBps_burst_limit")
+    """The burst bandwidth limit in megabytes per second (MBps)."""
+
+
+class Volume(BaseModel):
+    id: str
+    """The unique identifier of the volume."""
+
+    bootable: bool
+    """Indicates whether the volume is bootable."""
+
+    created_at: datetime
+    """The date and time when the volume was created."""
+
+    is_root_volume: bool
+    """Indicates whether this is a root volume."""
+
+    name: str
+    """The name of the volume."""
+
+    project_id: int
+    """Project ID."""
+
+    region: str
+    """The region where the volume is located."""
+
+    region_id: int
+    """The identifier of the region."""
+
+    size: int
+    """The size of the volume in gibibytes (GiB)."""
+
+    status: Literal[
+        "attaching",
+        "available",
+        "awaiting-transfer",
+        "backing-up",
+        "creating",
+        "deleting",
+        "detaching",
+        "downloading",
+        "error",
+        "error_backing-up",
+        "error_deleting",
+        "error_extending",
+        "error_restoring",
+        "extending",
+        "in-use",
+        "maintenance",
+        "reserved",
+        "restoring-backup",
+        "retyping",
+        "reverting",
+        "uploading",
+    ]
+    """The current status of the volume."""
+
+    tags: List[Tag]
+    """List of key-value tags associated with the resource.
+
+    A tag is a key-value pair that can be associated with a resource, enabling
+    efficient filtering and grouping for better organization and management. Some
+    tags are read-only and cannot be modified by the user. Tags are also integrated
+    with cost reports, allowing cost data to be filtered based on tag keys or
+    values.
+    """
+
+    volume_type: str
+    """The type of volume storage."""
+
+    attachments: Optional[List[Attachment]] = None
+    """List of attachments associated with the volume."""
+
+    creator_task_id: Optional[str] = None
+    """The ID of the task that created this volume."""
+
+    limiter_stats: Optional[LimiterStats] = None
+    """Schema representing the Quality of Service (QoS) parameters for a volume."""
+
+    snapshot_ids: Optional[List[str]] = None
+    """List of snapshot IDs associated with this volume."""
+
+    task_id: Optional[str] = None
+    """The UUID of the active task that currently holds a lock on the resource.
+
+    This lock prevents concurrent modifications to ensure consistency. If `null`,
+    the resource is not locked.
+    """
+
+    updated_at: Optional[datetime] = None
+    """The date and time when the volume was last updated."""
+
+    volume_image_metadata: Optional[Dict[str, str]] = None
+    """Image metadata for volumes created from an image."""

gcore/types/cloud/volume_attach_to_instance_params.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VolumeAttachToInstanceParams"]
+
+
+class VolumeAttachToInstanceParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    instance_id: Required[str]
+    """Instance ID."""
+
+    attachment_tag: str
+    """Block device attachment tag (not exposed in the normal tags)."""

gcore/types/cloud/volume_change_type_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["VolumeChangeTypeParams"]
+
+
+class VolumeChangeTypeParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    volume_type: Required[Literal["ssd_hiiops", "standard"]]
+    """New volume type name"""

gcore/types/cloud/volume_create_params.py

@@ -0,0 +1,176 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .tag_update_map_param import TagUpdateMapParam
+
+__all__ = [
+    "VolumeCreateParams",
+    "CreateVolumeFromImageSerializer",
+    "CreateVolumeFromSnapshotSerializer",
+    "CreateNewVolumeSerializer",
+]
+
+
+class CreateVolumeFromImageSerializer(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    image_id: Required[str]
+    """Image ID"""
+
+    name: Required[str]
+    """Volume name"""
+
+    size: Required[int]
+    """Volume size in GiB"""
+
+    source: Required[Literal["image"]]
+    """Volume source type"""
+
+    attachment_tag: str
+    """Block device attachment tag (not exposed in the user tags).
+
+    Only used in conjunction with instance_id_to_attach_to
+    """
+
+    instance_id_to_attach_to: str
+    """instance_id to attach newly-created volume to"""
+
+    lifecycle_policy_ids: Iterable[int]
+    """
+    List of lifecycle policy IDs (snapshot creation schedules) to associate with the
+    volume
+    """
+
+    tags: TagUpdateMapParam
+    """Key-value tags to associate with the resource.
+
+    A tag is a key-value pair that can be associated with a resource, enabling
+    efficient filtering and grouping for better organization and management. Some
+    tags are read-only and cannot be modified by the user. Tags are also integrated
+    with cost reports, allowing cost data to be filtered based on tag keys or
+    values.
+    """
+
+    type_name: Literal["cold", "ssd_hiiops", "ssd_local", "ssd_lowlatency", "standard", "ultra"]
+    """Volume type.
+
+    Defaults to `standard`. If not specified for source `snapshot`, volume type will
+    be derived from the snapshot volume.
+    """
+
+
+class CreateVolumeFromSnapshotSerializer(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    name: Required[str]
+    """Volume name"""
+
+    snapshot_id: Required[str]
+    """Snapshot ID"""
+
+    source: Required[Literal["snapshot"]]
+    """Volume source type"""
+
+    attachment_tag: str
+    """Block device attachment tag (not exposed in the user tags).
+
+    Only used in conjunction with instance_id_to_attach_to
+    """
+
+    instance_id_to_attach_to: str
+    """instance_id to attach newly-created volume to"""
+
+    lifecycle_policy_ids: Iterable[int]
+    """
+    List of lifecycle policy IDs (snapshot creation schedules) to associate with the
+    volume
+    """
+
+    size: int
+    """Volume size in GiB.
+
+    If specified, value must be equal to respective snapshot size
+    """
+
+    tags: TagUpdateMapParam
+    """Key-value tags to associate with the resource.
+
+    A tag is a key-value pair that can be associated with a resource, enabling
+    efficient filtering and grouping for better organization and management. Some
+    tags are read-only and cannot be modified by the user. Tags are also integrated
+    with cost reports, allowing cost data to be filtered based on tag keys or
+    values.
+    """
+
+    type_name: Literal["cold", "ssd_hiiops", "ssd_local", "ssd_lowlatency", "standard", "ultra"]
+    """Volume type.
+
+    Defaults to `standard`. If not specified for source `snapshot`, volume type will
+    be derived from the snapshot volume.
+    """
+
+
+class CreateNewVolumeSerializer(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    name: Required[str]
+    """Volume name"""
+
+    size: Required[int]
+    """Volume size in GiB"""
+
+    source: Required[Literal["new-volume"]]
+    """Volume source type"""
+
+    attachment_tag: str
+    """Block device attachment tag (not exposed in the user tags).
+
+    Only used in conjunction with instance_id_to_attach_to
+    """
+
+    instance_id_to_attach_to: str
+    """instance_id to attach newly-created volume to"""
+
+    lifecycle_policy_ids: Iterable[int]
+    """
+    List of lifecycle policy IDs (snapshot creation schedules) to associate with the
+    volume
+    """
+
+    tags: TagUpdateMapParam
+    """Key-value tags to associate with the resource.
+
+    A tag is a key-value pair that can be associated with a resource, enabling
+    efficient filtering and grouping for better organization and management. Some
+    tags are read-only and cannot be modified by the user. Tags are also integrated
+    with cost reports, allowing cost data to be filtered based on tag keys or
+    values.
+    """
+
+    type_name: Literal["cold", "ssd_hiiops", "ssd_local", "ssd_lowlatency", "standard", "ultra"]
+    """Volume type.
+
+    Defaults to `standard`. If not specified for source `snapshot`, volume type will
+    be derived from the snapshot volume.
+    """
+
+
+VolumeCreateParams: TypeAlias = Union[
+    CreateVolumeFromImageSerializer, CreateVolumeFromSnapshotSerializer, CreateNewVolumeSerializer
+]

gcore/types/cloud/volume_delete_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["VolumeDeleteParams"]
+
+
+class VolumeDeleteParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    snapshots: str
+    """Comma separated list of snapshot IDs to be deleted with the volume."""

gcore/types/cloud/volume_detach_from_instance_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VolumeDetachFromInstanceParams"]
+
+
+class VolumeDetachFromInstanceParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    instance_id: Required[str]
+    """Instance ID"""

gcore/types/cloud/volume_list_params.py

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import TypedDict
+
+__all__ = ["VolumeListParams"]
+
+
+class VolumeListParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    bootable: bool
+    """Filter by bootable field"""
+
+    cluster_id: str
+    """Filter volumes by k8s cluster ID"""
+
+    has_attachments: bool
+    """Filter by the presence of attachments"""
+
+    id_part: str
+    """Filter the volume list result by the ID part of the volume"""
+
+    instance_id: str
+    """Filter volumes by instance ID"""
+
+    limit: int
+    """Optional. Limit the number of returned items"""
+
+    name_part: str
+    """
+    Filter volumes by name_part inclusion in volume name.Any substring can be used
+    and volumes will be returned with names containing the substring.
+    """
+
+    offset: int
+    """Optional.
+
+    Offset value is used to exclude the first set of records from the result
+    """
+
+    tag_key: List[str]
+    """Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2"""
+
+    tag_key_value: str
+    """Optional.
+
+    Filter by tag key-value pairs. curl -G --data-urlencode "tag_key_value={"key":
+    "value"}" --url "https://example.com/cloud/v1/resource/1/1"
+    """

gcore/types/cloud/volume_resize_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VolumeResizeParams"]
+
+
+class VolumeResizeParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    size: Required[int]
+    """New volume size in GiB"""

gcore/types/cloud/volume_update_params.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["VolumeUpdateParams"]
+
+
+class VolumeUpdateParams(TypedDict, total=False):
+    project_id: int
+    """Project ID"""
+
+    region_id: int
+    """Region ID"""
+
+    name: Required[str]
+    """Name."""