Skip to content

FleetSummary

Source code in docs_src/capo_deadline/types/fleet_summary.py
class FleetSummary(TypedDict, closed=True):
    fleet_id: "capo_deadline.types.fleet_id.FleetId"
    """<p>The fleet ID.</p>"""
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The display name of the fleet summary to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>"""
    status: "capo_deadline.types.fleet_status.FleetStatus"
    """<p>The status of the fleet.</p>"""
    status_message: NotRequired["capo_deadline.types.string.String"]
    """<p>A message that communicates a suspended status of the fleet.</p>"""
    auto_scaling_status: NotRequired[
        "capo_deadline.types.auto_scaling_status.AutoScalingStatus"
    ]
    """<p>The Auto Scaling status of a fleet.</p>"""
    target_worker_count: NotRequired["capo_deadline.types.integer.Integer"]
    """<p>The target number of workers in a fleet.</p>"""
    worker_count: "capo_deadline.types.integer.Integer"
    """<p>The number of workers in the fleet summary.</p>"""
    min_worker_count: "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    """<p>The minimum number of workers in the fleet.</p>"""
    max_worker_count: "capo_deadline.types.min_zero_max_integer.MinZeroMaxInteger"
    """<p>The maximum number of workers specified in the fleet.</p>"""
    configuration: "capo_deadline.types.fleet_configuration.FleetConfiguration"
    """<p>The configuration details for the fleet.</p>"""
    created_at: "capo_deadline.types.created_at.CreatedAt"
    """<p>The date and time the resource was created.</p>"""
    created_by: "capo_deadline.types.created_by.CreatedBy"
    """<p>The user or system that created this resource.</p>"""
    updated_at: NotRequired["capo_deadline.types.updated_at.UpdatedAt"]
    """<p>The date and time the resource was updated.</p>"""
    updated_by: NotRequired["capo_deadline.types.updated_by.UpdatedBy"]
    """<p>The user or system that updated this resource.</p>"""

auto_scaling_status instance-attribute

auto_scaling_status: NotRequired[AutoScalingStatus]

The Auto Scaling status of a fleet.

configuration instance-attribute

configuration: FleetConfiguration

The configuration details for the fleet.

created_at instance-attribute

created_at: CreatedAt

The date and time the resource was created.

created_by instance-attribute

created_by: CreatedBy

The user or system that created this resource.

display_name instance-attribute

display_name: ResourceName

The display name of the fleet summary to update.

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

farm_id instance-attribute

farm_id: FarmId

The farm ID.

fleet_id instance-attribute

fleet_id: FleetId

The fleet ID.

max_worker_count instance-attribute

max_worker_count: MinZeroMaxInteger

The maximum number of workers specified in the fleet.

min_worker_count instance-attribute

min_worker_count: MinZeroMaxInteger

The minimum number of workers in the fleet.

status instance-attribute

status: FleetStatus

The status of the fleet.

status_message instance-attribute

status_message: NotRequired[String]

A message that communicates a suspended status of the fleet.

target_worker_count instance-attribute

target_worker_count: NotRequired[Integer]

The target number of workers in a fleet.

updated_at instance-attribute

updated_at: NotRequired[UpdatedAt]

The date and time the resource was updated.

updated_by instance-attribute

updated_by: NotRequired[UpdatedBy]

The user or system that updated this resource.

worker_count instance-attribute

worker_count: Integer

The number of workers in the fleet summary.