Skip to content

VolumeSummary

Source code in docs_src/capo_deadline/types/volume_summary.py
class VolumeSummary(TypedDict, closed=True):
    volume_id: "capo_deadline.types.volume_id.VolumeId"
    """<p>The volume ID.</p>"""
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the farm that contains the fleet.</p>"""
    fleet_id: "capo_deadline.types.fleet_id.FleetId"
    """<p>The fleet ID of the fleet that contains the volume.</p>"""
    state: "capo_deadline.types.volume_state.VolumeState"
    """<p>The state of the volume.</p>"""
    size_gi_b: "capo_deadline.types.persistent_volume_size_gi_b.PersistentVolumeSizeGiB"
    """<p>The volume size in GiB.</p>"""
    availability_zone_id: "capo_deadline.types.string.String"
    """<p>The Availability Zone ID of the volume.</p>"""
    attached_worker_id: NotRequired["capo_deadline.types.worker_id.WorkerId"]
    """<p>The worker ID of the worker the volume is attached to.</p>"""

attached_worker_id instance-attribute

attached_worker_id: NotRequired[WorkerId]

The worker ID of the worker the volume is attached to.

availability_zone_id instance-attribute

availability_zone_id: String

The Availability Zone ID of the volume.

farm_id instance-attribute

farm_id: FarmId

The farm ID of the farm that contains the fleet.

fleet_id instance-attribute

fleet_id: FleetId

The fleet ID of the fleet that contains the volume.

size_gi_b instance-attribute

The volume size in GiB.

state instance-attribute

state: VolumeState

The state of the volume.

volume_id instance-attribute

volume_id: VolumeId

The volume ID.