gcore 0.1.0__py3-none-any.whl

gcore/types/cloud/instance.py

@@ -0,0 +1,296 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from .tag import Tag
+from ..._models import BaseModel
+from .ddos_profile import DDOSProfile
+from .fixed_address import FixedAddress
+from .blackhole_port import BlackholePort
+from .floating_address import FloatingAddress
+from .instance_isolation import InstanceIsolation
+from .fixed_address_short import FixedAddressShort
+
+__all__ = [
+    "Instance",
+    "Address",
+    "FixedIPAssignment",
+    "Flavor",
+    "FlavorInstanceFlavorSerializer",
+    "FlavorInstanceFlavorSerializerHardwareDescription",
+    "FlavorBareMetalFlavorSerializer",
+    "FlavorBareMetalFlavorSerializerHardwareDescription",
+    "FlavorDeprecatedGPUClusterFlavorSerializer",
+    "FlavorDeprecatedGPUClusterFlavorSerializerHardwareDescription",
+    "SecurityGroup",
+    "Volume",
+]
+
+Address: TypeAlias = Union[FloatingAddress, FixedAddressShort, FixedAddress]
+
+
+class FixedIPAssignment(BaseModel):
+    external: bool
+    """Is network external"""
+
+    ip_address: str
+    """Ip address"""
+
+    subnet_id: str
+    """Interface subnet id"""
+
+
+class FlavorInstanceFlavorSerializerHardwareDescription(BaseModel):
+    ram: str
+    """RAM description"""
+
+    vcpus: str
+    """CPU description"""
+
+
+class FlavorInstanceFlavorSerializer(BaseModel):
+    architecture: str
+    """CPU architecture"""
+
+    flavor_id: str
+    """Flavor ID is the same as name"""
+
+    flavor_name: str
+    """Flavor name"""
+
+    hardware_description: FlavorInstanceFlavorSerializerHardwareDescription
+    """Additional hardware description"""
+
+    os_type: str
+    """Flavor operating system"""
+
+    ram: int
+    """RAM size in MiB"""
+
+    vcpus: int
+    """Virtual CPU count. For bare metal flavors, it's a physical CPU count"""
+
+
+class FlavorBareMetalFlavorSerializerHardwareDescription(BaseModel):
+    cpu: str
+    """Human-readable CPU description"""
+
+    disk: str
+    """Human-readable disk description"""
+
+    license: str
+    """If the flavor is licensed, this field contains the license type"""
+
+    network: str
+    """Human-readable NIC description"""
+
+    ram: str
+    """Human-readable RAM description"""
+
+
+class FlavorBareMetalFlavorSerializer(BaseModel):
+    architecture: str
+    """CPU architecture"""
+
+    flavor_id: str
+    """Flavor ID is the same as name"""
+
+    flavor_name: str
+    """Flavor name"""
+
+    hardware_description: FlavorBareMetalFlavorSerializerHardwareDescription
+    """Additional hardware description"""
+
+    os_type: str
+    """Operating system"""
+
+    ram: int
+    """RAM size in MiB"""
+
+    resource_class: str
+    """Flavor resource class for mapping to hardware capacity"""
+
+    vcpus: int
+    """Virtual CPU count. For bare metal flavors, it's a physical CPU count"""
+
+
+class FlavorDeprecatedGPUClusterFlavorSerializerHardwareDescription(BaseModel):
+    cpu: str
+    """Human-readable CPU description"""
+
+    disk: str
+    """Human-readable disk description"""
+
+    gpu: str
+    """Human-readable GPU description"""
+
+    license: str
+    """If the flavor is licensed, this field contains the license type"""
+
+    network: str
+    """Human-readable NIC description"""
+
+    ram: str
+    """Human-readable RAM description"""
+
+
+class FlavorDeprecatedGPUClusterFlavorSerializer(BaseModel):
+    architecture: str
+    """CPU architecture"""
+
+    flavor_id: str
+    """Flavor ID is the same as name"""
+
+    flavor_name: str
+    """Flavor name"""
+
+    hardware_description: FlavorDeprecatedGPUClusterFlavorSerializerHardwareDescription
+    """Additional hardware description"""
+
+    os_type: str
+    """Operating system"""
+
+    ram: int
+    """RAM size in MiB"""
+
+    resource_class: str
+    """Flavor resource class for mapping to hardware capacity"""
+
+    vcpus: int
+    """Virtual CPU count. For bare metal flavors, it's a physical CPU count"""
+
+
+Flavor: TypeAlias = Union[
+    FlavorInstanceFlavorSerializer, FlavorBareMetalFlavorSerializer, FlavorDeprecatedGPUClusterFlavorSerializer
+]
+
+
+class SecurityGroup(BaseModel):
+    name: str
+    """Name."""
+
+
+class Volume(BaseModel):
+    id: str
+    """Volume ID"""
+
+    delete_on_termination: bool
+    """Whether the volume is deleted together with the VM"""
+
+
+class Instance(BaseModel):
+    id: str
+    """Instance ID"""
+
+    addresses: Dict[str, List[Address]]
+    """Map of network_name to list of addresses in that network"""
+
+    blackhole_ports: List[BlackholePort]
+    """IP addresses of the instances that are blackholed by DDoS mitigation system"""
+
+    created_at: datetime
+    """Datetime when instance was created"""
+
+    creator_task_id: Optional[str] = None
+    """Task that created this entity"""
+
+    ddos_profile: Optional[DDOSProfile] = None
+    """Advanced DDoS protection profile.
+
+    It is always `null` if query parameter `with_ddos=true` is not set.
+    """
+
+    fixed_ip_assignments: Optional[List[FixedIPAssignment]] = None
+    """Fixed IP assigned to instance"""
+
+    flavor: Flavor
+    """Flavor"""
+
+    instance_description: Optional[str] = None
+    """Instance description"""
+
+    instance_isolation: Optional[InstanceIsolation] = None
+    """Instance isolation information"""
+
+    name: str
+    """Instance name"""
+
+    project_id: int
+    """Project ID"""
+
+    region: str
+    """Region name"""
+
+    region_id: int
+    """Region ID"""
+
+    security_groups: List[SecurityGroup]
+    """Security groups"""
+
+    ssh_key_name: Optional[str] = None
+    """SSH key assigned to instance"""
+
+    status: Literal[
+        "ACTIVE",
+        "BUILD",
+        "DELETED",
+        "ERROR",
+        "HARD_REBOOT",
+        "MIGRATING",
+        "PASSWORD",
+        "PAUSED",
+        "REBOOT",
+        "REBUILD",
+        "RESCUE",
+        "RESIZE",
+        "REVERT_RESIZE",
+        "SHELVED",
+        "SHELVED_OFFLOADED",
+        "SHUTOFF",
+        "SOFT_DELETED",
+        "SUSPENDED",
+        "UNKNOWN",
+        "VERIFY_RESIZE",
+    ]
+    """Instance status"""
+
+    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.
+    """
+
+    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.
+    """
+
+    task_state: Optional[str] = None
+    """Task state"""
+
+    vm_state: Literal[
+        "active",
+        "building",
+        "deleted",
+        "error",
+        "paused",
+        "rescued",
+        "resized",
+        "shelved",
+        "shelved_offloaded",
+        "soft-deleted",
+        "stopped",
+        "suspended",
+    ]
+    """Virtual machine state (active)"""
+
+    volumes: List[Volume]
+    """List of volumes"""

gcore/types/cloud/instance_action_params.py

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+__all__ = ["InstanceActionParams", "StartActionInstanceSerializer", "BasicActionInstanceSerializer"]
+
+
+class StartActionInstanceSerializer(TypedDict, total=False):
+    project_id: int
+
+    region_id: int
+
+    action: Required[Literal["start"]]
+    """Instance action name"""
+
+    activate_profile: Optional[bool]
+    """Used on start instance to activate Advanced DDoS profile"""
+
+
+class BasicActionInstanceSerializer(TypedDict, total=False):
+    project_id: int
+
+    region_id: int
+
+    action: Required[Literal["reboot", "reboot_hard", "resume", "stop", "suspend"]]
+    """Instance action name"""
+
+
+InstanceActionParams: TypeAlias = Union[StartActionInstanceSerializer, BasicActionInstanceSerializer]

gcore/types/cloud/instance_add_to_placement_group_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["InstanceAddToPlacementGroupParams"]
+
+
+class InstanceAddToPlacementGroupParams(TypedDict, total=False):
+    project_id: int
+
+    region_id: int
+
+    servergroup_id: Required[str]
+    """Anti-affinity or affinity or soft-anti-affinity server group ID."""

gcore/types/cloud/instance_assign_security_group_params.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["InstanceAssignSecurityGroupParams", "PortsSecurityGroupName"]
+
+
+class InstanceAssignSecurityGroupParams(TypedDict, total=False):
+    project_id: int
+
+    region_id: int
+
+    name: str
+    """Security group name, applies to all ports"""
+
+    ports_security_group_names: Iterable[PortsSecurityGroupName]
+    """Port security groups mapping"""
+
+
+class PortsSecurityGroupName(TypedDict, total=False):
+    port_id: Required[Optional[str]]
+    """Port ID. If None, security groups will be applied to all ports"""
+
+    security_group_names: Required[List[str]]
+    """List of security group names"""