anyscale 0.26.19__py3-none-any.whl → 0.26.20__py3-none-any.whl

anyscale/client/openapi_client/models/job_queue_sort_field.py

@@ -0,0 +1,107 @@
+# coding: utf-8
+
+"""
+    Managed Ray API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from openapi_client.configuration import Configuration
+
+
+class JobQueueSortField(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    allowed enum values
+    """
+    ID = "ID"
+    NAME = "NAME"
+    CREATED_AT = "CREATED_AT"
+    CREATOR_ID = "CREATOR_ID"
+    CREATOR_EMAIL = "CREATOR_EMAIL"
+    PROJECT_ID = "PROJECT_ID"
+    CLOUD_ID = "CLOUD_ID"
+    QUEUE_STATE = "QUEUE_STATE"
+    CLUSTER_STATE = "CLUSTER_STATE"
+
+    allowable_values = [ID, NAME, CREATED_AT, CREATOR_ID, CREATOR_EMAIL, PROJECT_ID, CLOUD_ID, QUEUE_STATE, CLUSTER_STATE]  # noqa: E501
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """JobQueueSortField - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+        self.discriminator = None
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, JobQueueSortField):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, JobQueueSortField):
+            return True
+
+        return self.to_dict() != other.to_dict()

anyscale/client/openapi_client/models/job_queues_query.py

@@ -38,7 +38,8 @@ class JobQueuesQuery(object):
         'cluster_status': 'SessionState',
         'project_id': 'str',
         'cloud_id': 'str',
-        'paging': 'PageQuery'
+        'paging': 'PageQuery',
+        'sorting_directives': 'list[JobQueueSortDirective]'
     }
 
     attribute_map = {
@@ -47,10 +48,11 @@ class JobQueuesQuery(object):
         'cluster_status': 'cluster_status',
         'project_id': 'project_id',
         'cloud_id': 'cloud_id',
-        'paging': 'paging'
+        'paging': 'paging',
+        'sorting_directives': 'sorting_directives'
     }
 
-    def __init__(self, name=None, creator_id=None, cluster_status=None, project_id=None, cloud_id=None, paging=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, name=None, creator_id=None, cluster_status=None, project_id=None, cloud_id=None, paging=None, sorting_directives=None, local_vars_configuration=None):  # noqa: E501
         """JobQueuesQuery - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -62,6 +64,7 @@ class JobQueuesQuery(object):
         self._project_id = None
         self._cloud_id = None
         self._paging = None
+        self._sorting_directives = None
         self.discriminator = None
 
         if name is not None:
@@ -76,6 +79,8 @@ class JobQueuesQuery(object):
             self.cloud_id = cloud_id
         if paging is not None:
             self.paging = paging
+        if sorting_directives is not None:
+            self.sorting_directives = sorting_directives
 
     @property
     def name(self):
@@ -215,6 +220,29 @@ class JobQueuesQuery(object):
 
         self._paging = paging
 
+    @property
+    def sorting_directives(self):
+        """Gets the sorting_directives of this JobQueuesQuery.  # noqa: E501
+
+        List of sorting criteria (multi-field sort supported).  # noqa: E501
+
+        :return: The sorting_directives of this JobQueuesQuery.  # noqa: E501
+        :rtype: list[JobQueueSortDirective]
+        """
+        return self._sorting_directives
+
+    @sorting_directives.setter
+    def sorting_directives(self, sorting_directives):
+        """Sets the sorting_directives of this JobQueuesQuery.
+
+        List of sorting criteria (multi-field sort supported).  # noqa: E501
+
+        :param sorting_directives: The sorting_directives of this JobQueuesQuery.  # noqa: E501
+        :type: list[JobQueueSortDirective]
+        """
+
+        self._sorting_directives = sorting_directives
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}

anyscale/client/openapi_client/models/production_job_state_transition.py

@@ -108,7 +108,7 @@ class ProductionJobStateTransition(object):
     def state_transitioned_at(self):
         """Gets the state_transitioned_at of this ProductionJobStateTransition.  # noqa: E501
 
-        The last time the state of this job was updated. This includes updates to the state and to the goal state  # noqa: E501
+        The last time the state of this job was updated  # noqa: E501
 
         :return: The state_transitioned_at of this ProductionJobStateTransition.  # noqa: E501
         :rtype: datetime
@@ -119,7 +119,7 @@ class ProductionJobStateTransition(object):
     def state_transitioned_at(self, state_transitioned_at):
         """Sets the state_transitioned_at of this ProductionJobStateTransition.
 
-        The last time the state of this job was updated. This includes updates to the state and to the goal state  # noqa: E501
+        The last time the state of this job was updated  # noqa: E501
 
         :param state_transitioned_at: The state_transitioned_at of this ProductionJobStateTransition.  # noqa: E501
         :type: datetime

anyscale/client/openapi_client/models/update_job_queue_request.py

@@ -0,0 +1,150 @@
+# coding: utf-8
+
+"""
+    Managed Ray API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from openapi_client.configuration import Configuration
+
+
+class UpdateJobQueueRequest(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'idle_timeout_sec': 'int',
+        'max_concurrency': 'int'
+    }
+
+    attribute_map = {
+        'idle_timeout_sec': 'idle_timeout_sec',
+        'max_concurrency': 'max_concurrency'
+    }
+
+    def __init__(self, idle_timeout_sec=None, max_concurrency=None, local_vars_configuration=None):  # noqa: E501
+        """UpdateJobQueueRequest - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._idle_timeout_sec = None
+        self._max_concurrency = None
+        self.discriminator = None
+
+        if idle_timeout_sec is not None:
+            self.idle_timeout_sec = idle_timeout_sec
+        if max_concurrency is not None:
+            self.max_concurrency = max_concurrency
+
+    @property
+    def idle_timeout_sec(self):
+        """Gets the idle_timeout_sec of this UpdateJobQueueRequest.  # noqa: E501
+
+        Max number of jobs to be run concurrently.  # noqa: E501
+
+        :return: The idle_timeout_sec of this UpdateJobQueueRequest.  # noqa: E501
+        :rtype: int
+        """
+        return self._idle_timeout_sec
+
+    @idle_timeout_sec.setter
+    def idle_timeout_sec(self, idle_timeout_sec):
+        """Sets the idle_timeout_sec of this UpdateJobQueueRequest.
+
+        Max number of jobs to be run concurrently.  # noqa: E501
+
+        :param idle_timeout_sec: The idle_timeout_sec of this UpdateJobQueueRequest.  # noqa: E501
+        :type: int
+        """
+
+        self._idle_timeout_sec = idle_timeout_sec
+
+    @property
+    def max_concurrency(self):
+        """Gets the max_concurrency of this UpdateJobQueueRequest.  # noqa: E501
+
+        Max period of time queue will be accepting new jobs, before being sealed off and its associated cluster being shutdown  # noqa: E501
+
+        :return: The max_concurrency of this UpdateJobQueueRequest.  # noqa: E501
+        :rtype: int
+        """
+        return self._max_concurrency
+
+    @max_concurrency.setter
+    def max_concurrency(self, max_concurrency):
+        """Sets the max_concurrency of this UpdateJobQueueRequest.
+
+        Max period of time queue will be accepting new jobs, before being sealed off and its associated cluster being shutdown  # noqa: E501
+
+        :param max_concurrency: The max_concurrency of this UpdateJobQueueRequest.  # noqa: E501
+        :type: int
+        """
+
+        self._max_concurrency = max_concurrency
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, UpdateJobQueueRequest):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, UpdateJobQueueRequest):
+            return True
+
+        return self.to_dict() != other.to_dict()

anyscale/commands/command_examples.py

@@ -77,6 +77,64 @@ NAME    ID                                    COST  PROJECT NAME    CLUSTER NAME
 my-job  prodjob_s9x4uzc5jnkt5z53g4tujb3y2e       0  default         cluster_for_prodjob_s9x4uzc5jnkt5z53g4tujb3y2e  SUCCESS                 doc@anyscale.com  python main.py
 """
 
+JOB_QUEUE_LIST = """\
+$ anyscale job-queue list
+Output
+JOB QUEUES:
+             ID                 NAME              CLUSTER ID                      CREATOR ID             MAX CONCURRENCY    IDLE TIMEOUT SEC    CURRENT CLUSTER STATE
+jq_h8fcze2qkr8wttuuvapi1hvyuc  queue_3  ses_cjr7uaf1yh2ue5uzvd11p24p4u  usr_we8x7d7u8hq8mj2488ed9x47n6          3                 5000               Terminated
+jq_v5bx9z1sd4pbxasxhdms37j4gi  queue_2  ses_k86raeu6k1t6z1bvyejn3vblad  usr_we8x7d7u8hq8mj2488ed9x47n6         10                 5000               Terminated
+jq_ni6hk66nt3194msr7hzzj9daun  queue_1  ses_uhb8a9gamtarz68kcurpjh86sa  usr_we8x7d7u8hq8mj2488ed9x47n6         10                 5000               Terminated
+"""
+
+JOB_QUEUE_INFO = """\
+$ anyscale job-queue info --id jq_h8fcze2qkr8wttuuvapi1hvyuc
+Output
+ID                            : jq_h8fcze2qkr8wttuuvapi1hvyuc
+USER PROVIDED ID              : queue_3
+NAME                          : queue_3
+CURRENT JOB QUEUE STATE       : ACTIVE
+EXECUTION MODE                : PRIORITY
+MAX CONCURRENCY               : 3
+IDLE TIMEOUT SEC              : 5000
+CREATED AT                    : 2025-04-15 20:40:44
+CREATOR ID                    : usr_we8x7d7u8hq8mj2488ed9x47n6
+CREATOR EMAIL                 : test@anyscale.com
+COMPUTE CONFIG ID             : cpt_8hzsv1t4jvb6kwjhfqbfjw5i6b
+CURRENT CLUSTER STATE         : Terminated
+CLUSTER ID                    : ses_cjr7uaf1yh2ue5uzvd11p24p4u
+PROJECT ID                    : prj_7FWKGPGPaD3Q5mvk9zK2viBD
+CLOUD ID                      : cld_kvedZWag2qA8i5BjxUevf5i7
+TOTAL JOBS                    : 6
+SUCCESSFUL JOBS               : 6
+FAILED JOBS                   : 0
+ACTIVE JOBS                   : 0
+"""
+
+JOB_QUEUE_UPDATE = """\
+$ anyscale job-queue update --id jq_h8fcze2qkr8wttuuvapi1hvyuc --max-concurrency 5
+Output
+ID                            : jq_h8fcze2qkr8wttuuvapi1hvyuc
+USER PROVIDED ID              : queue_3
+NAME                          : queue_3
+CURRENT JOB QUEUE STATE       : ACTIVE
+EXECUTION MODE                : PRIORITY
+MAX CONCURRENCY               : 5
+IDLE TIMEOUT SEC              : 5000
+CREATED AT                    : 2025-04-15 20:40:44
+CREATOR ID                    : usr_we8x7d7u8hq8mj2488ed9x47n6
+CREATOR EMAIL                 : test@anyscale.com
+COMPUTE CONFIG ID             : cpt_8hzsv1t4jvb6kwjhfqbfjw5i6b
+CURRENT CLUSTER STATE         : Terminated
+CLUSTER ID                    : ses_cjr7uaf1yh2ue5uzvd11p24p4u
+PROJECT ID                    : prj_7FWKGPGPaD3Q5mvk9zK2viBD
+CLOUD ID                      : cld_kvedZWag2qA8i5BjxUevf5i7
+TOTAL JOBS                    : 6
+SUCCESSFUL JOBS               : 6
+FAILED JOBS                   : 0
+ACTIVE JOBS                   : 0
+"""
+
 SCHEDULE_APPLY_EXAMPLE = """\
 $ anyscale schedule apply -n my-schedule -f my-schedule.yaml
 (anyscale +0.5s) Applying schedule with config ScheduleConfig(job_config=JobConfig(name='my-schedule', image_uri=None, compute_config=None, env_vars=None, py_modules=None, cloud=None, project=None, ray_version=None, job_queue_config=None), cron_expression='0 0 * * * *', timezone='UTC').

anyscale/commands/job_commands.py

@@ -396,14 +396,14 @@ and override the entrypoint with `python main.py`.
     help=f"Filter jobs by state. Accepts one or more states. Allowed states: {', '.join(HaJobStates.allowable_values)}",
     callback=validate_list_jobs_state_filter,
 )
-def list(  # noqa: A001
+def list(  # noqa: A001 PLR0913
     name: Optional[str],
     id: Optional[str],  # noqa: A002
     project_id: Optional[str],
     include_all_users: bool,
     include_archived: bool,
     max_items: int,
-    states: List[str],
+    states: List[HaJobStates],
 ) -> None:
     job_controller = JobController()
     job_controller.list(

anyscale/commands/job_queue_commands.py

@@ -0,0 +1,172 @@
+from typing import List
+
+import click
+
+from anyscale.client.openapi_client.models.job_queue_sort_directive import (
+    JobQueueSortDirective,
+)
+from anyscale.client.openapi_client.models.job_queue_sort_field import JobQueueSortField
+from anyscale.client.openapi_client.models.sort_order import SortOrder
+from anyscale.commands import command_examples
+from anyscale.commands.util import AnyscaleCommand
+from anyscale.controllers.job_controller import JobController, JobQueueView
+from anyscale.util import validate_non_negative_arg
+
+
+@click.group(
+    "job-queues", help="Interact with production job queues running on Anyscale."
+)
+def job_queue_cli() -> None:
+    pass
+
+
+def parse_sort_fields(
+    param: str, sort_fields: List[str],
+) -> List[JobQueueSortDirective]:
+    sort_directives = []
+
+    for field_str in sort_fields:
+        descending = field_str.startswith("-")
+        raw_field = field_str.lstrip("-").upper()
+
+        if raw_field not in JobQueueSortField.allowable_values:
+            raise click.UsageError(
+                f"{param} must be one of {', '.join([v.lower() for v in JobQueueSortField.allowable_values])}"
+            )
+
+        sort_directives.append(
+            JobQueueSortDirective(
+                sort_field=raw_field,
+                sort_order=SortOrder.DESC if descending else SortOrder.ASC,
+            )
+        )
+
+    return sort_directives
+
+
+@job_queue_cli.command(
+    name="list",
+    short_help="List job queues.",
+    cls=AnyscaleCommand,
+    example=command_examples.JOB_QUEUE_LIST,
+)
+@click.option(
+    "--include-all-users",
+    is_flag=True,
+    default=False,
+    help="Include job queues not created by current user.",
+)
+@click.option(
+    "--view",
+    type=click.Choice([v.name.lower() for v in JobQueueView], case_sensitive=False),
+    default=JobQueueView.DEFAULT.name,
+    help="Select which view to display.",
+    callback=lambda _, __, value: JobQueueView[value.upper()],
+)
+@click.option(
+    "--page",
+    default=100,
+    type=int,
+    help="Page size (default 100).",
+    callback=validate_non_negative_arg,
+)
+@click.option(
+    "--max-items",
+    required=False,
+    type=int,
+    help="Max items to show in list (only valid in interactive mode).",
+    callback=lambda ctx, param, value: validate_non_negative_arg(ctx, param, value)
+    if value
+    else None,
+)
+@click.option(
+    "--sort",
+    "sorting_directives",
+    multiple=True,
+    default=[JobQueueSortField.CREATED_AT],
+    help=f"""
+        Sort by column(s). Prefix column with - to sort in descending order.
+        Supported columns: {', '.join([v.lower() for v in JobQueueSortField.allowable_values])}.
+    """,
+    callback=lambda _, __, value: parse_sort_fields("sort", list(value)),
+)
+@click.option(
+    "--interactive/--no-interactive",
+    default=True,
+    help="--no-interactive disables the default interactive mode.",
+)
+def list_job_queues(
+    include_all_users: bool,
+    view: JobQueueView,
+    page: int,
+    max_items: int,
+    sorting_directives: List[JobQueueSortDirective],
+    interactive: bool,
+):
+    if max_items is not None and interactive:
+        raise click.UsageError("--max-items can only be used in non interactive mode.")
+    job_controller = JobController()
+    job_controller.list_job_queues(
+        max_items=max_items,
+        page_size=page,
+        include_all_users=include_all_users,
+        view=view,
+        sorting_directives=sorting_directives,
+        interactive=interactive,
+    )
+
+
+@job_queue_cli.command(
+    name="update",
+    short_help="Update job queue.",
+    cls=AnyscaleCommand,
+    example=command_examples.JOB_QUEUE_UPDATE,
+)
+@click.option(
+    "--id", "job_queue_id", required=False, default=None, help="ID of the job queue."
+)
+@click.option(
+    "--name",
+    "job_queue_name",
+    required=False,
+    default=None,
+    help="Name of the job queue.",
+)
+@click.option(
+    "--max-concurrency",
+    required=False,
+    default=None,
+    help="Maximum concurrency of the job queue",
+)
+@click.option(
+    "--idle-timeout-s",
+    required=False,
+    default=None,
+    help="Idle timeout of the job queue",
+)
+def update_job_queue(
+    job_queue_id: str, job_queue_name: str, max_concurrency: int, idle_timeout_s: int
+):
+    if job_queue_id is None and job_queue_name is None:
+        raise click.ClickException("ID or name of job queue is required")
+    job_controller = JobController()
+    job_controller.update_job_queue(
+        job_queue_id=job_queue_id,
+        job_queue_name=job_queue_name,
+        max_concurrency=max_concurrency,
+        idle_timeout_s=idle_timeout_s,
+    )
+
+
+@job_queue_cli.command(
+    name="info",
+    short_help="Info of a job queue.",
+    cls=AnyscaleCommand,
+    example=command_examples.JOB_QUEUE_INFO,
+)
+@click.option(
+    "--id", "job_queue_id", required=True, default=None, help="ID of the job."
+)
+def get_job_queue(job_queue_id: str):
+    job_controller = JobController()
+    job_controller.get_job_queue(job_queue_id=job_queue_id)