lightning-sdk 0.1.41__py3-none-any.whl → 0.1.42__py3-none-any.whl

lightning_sdk/job/v2.py

@@ -22,6 +22,15 @@ class _JobV2(_BaseJob):
         *,
         _fetch_job: bool = True,
     ) -> None:
+        """Fetch already existing jobs.
+
+        Args:
+            name: the name of the job
+            teamspace: the teamspace the job is part of
+            org: the name of the organization owning the :param`teamspace` in case it is owned by an org
+            user: the name of the user owning the :param`teamspace`
+                in case it is owned directly by a user instead of an org.
+        """
         self._job_api = JobApiV2()
         super().__init__(name=name, teamspace=teamspace, org=org, user=user, _fetch_job=_fetch_job)
 
@@ -33,12 +42,40 @@ class _JobV2(_BaseJob):
         image: Optional[str] = None,
         env: Optional[Dict[str, str]] = None,
         interruptible: bool = False,
-        cluster: Optional[str] = None,
+        cloud_account: Optional[str] = None,
         image_credentials: Optional[str] = None,
-        cluster_auth: bool = False,
+        cloud_account_auth: bool = False,
         artifacts_local: Optional[str] = None,
         artifacts_remote: Optional[str] = None,
     ) -> "_JobV2":
+        """Submit a new job to the Lightning AI platform.
+
+        Args:
+            machine: The machine type to run the job on. One of {", ".join(_MACHINE_VALUES)}.
+            command: The command to run inside your job. Required if using a studio. Optional if using an image.
+                If not provided for images, will run the container entrypoint and default command.
+            studio: The studio env to run the job with. Mutually exclusive with image.
+            image: The docker image to run the job with. Mutually exclusive with studio.
+            env: Environment variables to set inside the job.
+            interruptible: Whether the job should run on interruptible instances. They are cheaper but can be preempted.
+            cloud_account: The cloud account to run the job on.
+                Defaults to the studio cloud account if running with studio compute env.
+                If not provided will fall back to the teamspaces default cloud account.
+            image_credentials: The credentials used to pull the image. Required if the image is private.
+                This should be the name of the respective credentials secret created on the Lightning AI platform.
+            cloud_account_auth: Whether to authenticate with the cloud account to pull the image.
+                Required if the registry is part of a cloud provider (e.g. ECR).
+            artifacts_local: The path of inside the docker container, you want to persist images from.
+                CAUTION: When setting this to "/", it will effectively erase your container.
+                Only supported for jobs with a docker image compute environment.
+            artifacts_remote: The remote storage to persist your artifacts to.
+                Should be of format <CONNECTION_TYPE>:<CONNECTION_NAME>:<PATH_WITHIN_CONNECTION>.
+                PATH_WITHIN_CONNECTION hereby is a path relative to the connection's root.
+                E.g. efs:data:some-path would result in an EFS connection named `data` and to the path `some-path`
+                within it.
+                Note that the connection needs to be added to the teamspace already in order for it to be found.
+                Only supported for jobs with a docker image compute environment.
+        """
         # Command is required if Studio is provided to know what to run
         # Image is mutually exclusive with Studio
         # Command is optional for Image
@@ -59,7 +96,7 @@ class _JobV2(_BaseJob):
         submitted = self._job_api.submit_job(
             name=self.name,
             command=command,
-            cluster_id=cluster,
+            cloud_account=cloud_account,
             teamspace_id=self._teamspace.id,
             studio_id=studio_id,
             image=image,
@@ -67,7 +104,7 @@ class _JobV2(_BaseJob):
             interruptible=interruptible,
             env=env,
             image_credentials=image_credentials,
-            cluster_auth=cluster_auth,
+            cloud_account_auth=cloud_account_auth,
             artifacts_local=artifacts_local,
             artifacts_remote=artifacts_remote,
         )
@@ -76,9 +113,14 @@ class _JobV2(_BaseJob):
         return self
 
     def stop(self) -> None:
+        """Stop the job. If the job is already stopped, this is a no-op. This is blocking until the job is stopped."""
         self._job_api.stop_job(job_id=self._guaranteed_job.id, teamspace_id=self._teamspace.id)
 
     def delete(self) -> None:
+        """Delete the job.
+
+        Caution: This also deletes all artifacts created by the job.
+        """
         self._job_api.delete_job(
             job_id=self._guaranteed_job.id,
             teamspace_id=self._teamspace.id,
@@ -91,28 +133,20 @@ class _JobV2(_BaseJob):
         self._update_internal_job()
         return self._job
 
-    @property
-    def _guaranteed_job(self) -> Any:
-        """Guarantees that the job was fetched at some point before returning it.
-
-        Doesn't guarantee to have the lastest version of the job. Use _latest_job for that.
-        """
-        if getattr(self, "_job", None) is None:
-            self._update_internal_job()
-
-        return self._job
-
     @property
     def status(self) -> "Status":
+        """The current status of the job."""
         return self._job_api._job_state_to_external(self._latest_job.state)
 
     @property
     def machine(self) -> "Machine":
+        """The machine type the job is running on."""
         # only fetch the job it it hasn't been fetched yet as machine cannot change over time
         return self._job_api._get_job_machine_from_spec(self._guaranteed_job.spec)
 
     @property
     def artifact_path(self) -> Optional[str]:
+        """The path to the artifacts of the job within the distributed teamspace filesystem."""
         if self._guaranteed_job.spec.image != "":
             if self._guaranteed_job.spec.artifacts_destination != "":
                 splits = self._guaranteed_job.spec.artifacts_destination.split(":")
@@ -123,12 +157,14 @@ class _JobV2(_BaseJob):
 
     @property
     def snapshot_path(self) -> Optional[str]:
+        """The path to the snapshot of the Studio used to create the job within the distributed teamspace filesystem."""
         if self._guaranteed_job.spec.image != "":
             return None
         return f"/teamspace/jobs/{self._guaranteed_job.name}/snapshot"
 
     @property
     def share_path(self) -> Optional[str]:
+        """The path to the share of the job within the distributed teamspace filesystem."""
         raise NotImplementedError("Not implemented yet")
 
     def _update_internal_job(self) -> None:

lightning_sdk/job/work.py

@@ -1,33 +1,62 @@
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, Any, Optional, Protocol
 
 from lightning_sdk.api.job_api import JobApiV1
 
 if TYPE_CHECKING:
-    from lightning_sdk.job.job import Job
+    from lightning_sdk.status import Status
     from lightning_sdk.teamspace import Teamspace
 from lightning_sdk.machine import Machine
 
 
+class _WorkHolder(Protocol):
+    @property
+    def _id(self) -> str:
+        ...
+
+    @property
+    def name(self) -> str:
+        ...
+
+    def _name_filter(self, name: str) -> str:
+        ...
+
+
 class Work:
-    def __init__(self, work_id: str, job: "Job", teamspace: "Teamspace") -> None:
+    def __init__(self, work_id: str, job: _WorkHolder, teamspace: "Teamspace") -> None:
         self._id = work_id
         self._job = job
         self._teamspace = teamspace
         self._job_api = JobApiV1()
-        self._work = self._job_api.get_work(work_id=work_id, job_id=job.id, teamspace_id=teamspace.id)
+        self._work = None
+
+    @property
+    def _latest_work(self) -> Any:
+        self._work = self._job_api.get_work(work_id=self._id, job_id=self._job._id, teamspace_id=self._teamspace.id)
+        return self._work
+
+    @property
+    def _guaranteed_work(self) -> Any:
+        if self._work is None:
+            return self._latest_work
+
+        return self._work
 
     @property
     def id(self) -> str:
-        return self._work.id
+        return self._guaranteed_work.id
 
     @property
     def name(self) -> str:
-        return self._job._name_filter(self._work.name)
+        return self._job._name_filter(self._guaranteed_work.name)
 
     @property
     def machine(self) -> "Machine":
-        return self._job_api.get_machine_from_work(self._work)
+        return self._job_api.get_machine_from_work(self._guaranteed_work)
 
     @property
     def artifact_path(self) -> Optional[str]:
         return f"/teamspace/jobs/{self._job.name}/{self.name}"
+
+    @property
+    def status(self) -> "Status":
+        return self._job_api.get_status_from_work(self._latest_work)

lightning_sdk/lightning_cloud/openapi/__init__.py

@@ -125,6 +125,7 @@ from lightning_sdk.lightning_cloud.openapi.models.id_start_body import IdStartBo
 from lightning_sdk.lightning_cloud.openapi.models.id_storage_body import IdStorageBody
 from lightning_sdk.lightning_cloud.openapi.models.id_uploads_body import IdUploadsBody
 from lightning_sdk.lightning_cloud.openapi.models.id_uploads_body1 import IdUploadsBody1
+from lightning_sdk.lightning_cloud.openapi.models.id_visibility_body import IdVisibilityBody
 from lightning_sdk.lightning_cloud.openapi.models.jobs_id_body import JobsIdBody
 from lightning_sdk.lightning_cloud.openapi.models.jobs_id_body1 import JobsIdBody1
 from lightning_sdk.lightning_cloud.openapi.models.jobs_id_body2 import JobsIdBody2
@@ -445,6 +446,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_get_long_running_command_in
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_model_file_upload_urls_response import V1GetModelFileUploadUrlsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_model_file_url_response import V1GetModelFileUrlResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_model_files_response import V1GetModelFilesResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_get_model_files_url_response import V1GetModelFilesUrlResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_project_artifact_response import V1GetProjectArtifactResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_project_balance_response import V1GetProjectBalanceResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_get_project_compute_usage_response import V1GetProjectComputeUsageResponse
@@ -558,6 +560,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_list_memberships_response i
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_metrics_streams_response import V1ListMetricsStreamsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_model_versions_response import V1ListModelVersionsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_models_response import V1ListModelsResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_list_multi_machine_job_events_response import V1ListMultiMachineJobEventsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_multi_machine_jobs_response import V1ListMultiMachineJobsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_new_features_for_user_response import V1ListNewFeaturesForUserResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_list_org_members_response import V1ListOrgMembersResponse
@@ -612,9 +615,14 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_metrics_stream import V1Met
 from lightning_sdk.lightning_cloud.openapi.models.v1_metrics_tags import V1MetricsTags
 from lightning_sdk.lightning_cloud.openapi.models.v1_metrics_tracker import V1MetricsTracker
 from lightning_sdk.lightning_cloud.openapi.models.v1_model import V1Model
+from lightning_sdk.lightning_cloud.openapi.models.v1_model_file import V1ModelFile
 from lightning_sdk.lightning_cloud.openapi.models.v1_model_version_archive import V1ModelVersionArchive
 from lightning_sdk.lightning_cloud.openapi.models.v1_mount_target import V1MountTarget
 from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job import V1MultiMachineJob
+from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_event import V1MultiMachineJobEvent
+from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_event_type import V1MultiMachineJobEventType
+from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_fault_tolerance import V1MultiMachineJobFaultTolerance
+from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_fault_tolerance_strategy import V1MultiMachineJobFaultToleranceStrategy
 from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_state import V1MultiMachineJobState
 from lightning_sdk.lightning_cloud.openapi.models.v1_multi_machine_job_status import V1MultiMachineJobStatus
 from lightning_sdk.lightning_cloud.openapi.models.v1_named_get_logger_metrics import V1NamedGetLoggerMetrics
@@ -724,6 +732,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_system_metrics import V1Sys
 from lightning_sdk.lightning_cloud.openapi.models.v1_system_metrics_list import V1SystemMetricsList
 from lightning_sdk.lightning_cloud.openapi.models.v1_telemetry import V1Telemetry
 from lightning_sdk.lightning_cloud.openapi.models.v1_timestamp_code_telemetry import V1TimestampCodeTelemetry
+from lightning_sdk.lightning_cloud.openapi.models.v1_trainium_system_metrics import V1TrainiumSystemMetrics
 from lightning_sdk.lightning_cloud.openapi.models.v1_transaction import V1Transaction
 from lightning_sdk.lightning_cloud.openapi.models.v1_transfer_org_balance_response import V1TransferOrgBalanceResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_transfer_project_balance_response import V1TransferProjectBalanceResponse
@@ -740,6 +749,7 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_update_cluster_accelerators
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_cluster_availability_request import V1UpdateClusterAvailabilityRequest
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_index_response import V1UpdateIndexResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_lit_page_response import V1UpdateLitPageResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_update_metrics_stream_visibility_response import V1UpdateMetricsStreamVisibilityResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_model_visibility_response import V1UpdateModelVisibilityResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_project_cluster_accelerators_response import V1UpdateProjectClusterAcceleratorsResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_update_shared_metrics_stream_response import V1UpdateSharedMetricsStreamResponse
@@ -769,6 +779,8 @@ from lightning_sdk.lightning_cloud.openapi.models.v1_user_slurm_job_action_respo
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_assistant_status_response import V1ValidateAssistantStatusResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_auto_join_domain_response import V1ValidateAutoJoinDomainResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_data_connection_response import V1ValidateDataConnectionResponse
+from lightning_sdk.lightning_cloud.openapi.models.v1_validate_deployment_image_request import V1ValidateDeploymentImageRequest
+from lightning_sdk.lightning_cloud.openapi.models.v1_validate_deployment_image_response import V1ValidateDeploymentImageResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_managed_endpoint_request import V1ValidateManagedEndpointRequest
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_managed_endpoint_response import V1ValidateManagedEndpointResponse
 from lightning_sdk.lightning_cloud.openapi.models.v1_validate_managed_model_response import V1ValidateManagedModelResponse

lightning_sdk/lightning_cloud/openapi/api/jobs_service_api.py

@@ -145,7 +145,7 @@ class JobsServiceApi(object):
             collection_formats=collection_formats)
 
     def jobs_service_create_deployment(self, body: 'CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs', project_id: 'str', **kwargs) -> 'V1Deployment':  # noqa: E501
-        """Job deployments  # noqa: E501
+        """jobs_service_create_deployment  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -167,7 +167,7 @@ class JobsServiceApi(object):
             return data
 
     def jobs_service_create_deployment_with_http_info(self, body: 'CreateDeploymentRequestDefinesASpecForTheJobThatAllowsForAutoscalingJobs', project_id: 'str', **kwargs) -> 'V1Deployment':  # noqa: E501
-        """Job deployments  # noqa: E501
+        """jobs_service_create_deployment  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
@@ -2600,7 +2600,8 @@ class JobsServiceApi(object):
         :param str cloudspace_id:
         :param str user_id:
         :param str deployment_id:
-        :param bool standalone: Whether to list standalone jobs, not part of a deployment.
+        :param str multi_machine_job_id:
+        :param bool standalone: Whether to list standalone jobs, not part of a deployment or mmt.
         :param str page_token:
         :param int limit:
         :param str state:
@@ -2628,7 +2629,8 @@ class JobsServiceApi(object):
         :param str cloudspace_id:
         :param str user_id:
         :param str deployment_id:
-        :param bool standalone: Whether to list standalone jobs, not part of a deployment.
+        :param str multi_machine_job_id:
+        :param bool standalone: Whether to list standalone jobs, not part of a deployment or mmt.
         :param str page_token:
         :param int limit:
         :param str state:
@@ -2637,7 +2639,7 @@ class JobsServiceApi(object):
                  returns the request thread.
         """
 
-        all_params = ['project_id', 'cloudspace_id', 'user_id', 'deployment_id', 'standalone', 'page_token', 'limit', 'state']  # noqa: E501
+        all_params = ['project_id', 'cloudspace_id', 'user_id', 'deployment_id', 'multi_machine_job_id', 'standalone', 'page_token', 'limit', 'state']  # noqa: E501
         all_params.append('async_req')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -2670,6 +2672,8 @@ class JobsServiceApi(object):
             query_params.append(('userId', params['user_id']))  # noqa: E501
         if 'deployment_id' in params:
             query_params.append(('deploymentId', params['deployment_id']))  # noqa: E501
+        if 'multi_machine_job_id' in params:
+            query_params.append(('multiMachineJobId', params['multi_machine_job_id']))  # noqa: E501
         if 'standalone' in params:
             query_params.append(('standalone', params['standalone']))  # noqa: E501
         if 'page_token' in params:
@@ -2708,6 +2712,115 @@ class JobsServiceApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def jobs_service_list_multi_machine_job_events(self, project_id: 'str', id: 'str', **kwargs) -> 'V1ListMultiMachineJobEventsResponse':  # noqa: E501
+        """jobs_service_list_multi_machine_job_events  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.jobs_service_list_multi_machine_job_events(project_id, id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str project_id: (required)
+        :param str id: (required)
+        :param str release_id:
+        :param str limit:
+        :return: V1ListMultiMachineJobEventsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.jobs_service_list_multi_machine_job_events_with_http_info(project_id, id, **kwargs)  # noqa: E501
+        else:
+            (data) = self.jobs_service_list_multi_machine_job_events_with_http_info(project_id, id, **kwargs)  # noqa: E501
+            return data
+
+    def jobs_service_list_multi_machine_job_events_with_http_info(self, project_id: 'str', id: 'str', **kwargs) -> 'V1ListMultiMachineJobEventsResponse':  # noqa: E501
+        """jobs_service_list_multi_machine_job_events  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.jobs_service_list_multi_machine_job_events_with_http_info(project_id, id, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str project_id: (required)
+        :param str id: (required)
+        :param str release_id:
+        :param str limit:
+        :return: V1ListMultiMachineJobEventsResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['project_id', 'id', 'release_id', 'limit']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method jobs_service_list_multi_machine_job_events" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'project_id' is set
+        if ('project_id' not in params or
+                params['project_id'] is None):
+            raise ValueError("Missing the required parameter `project_id` when calling `jobs_service_list_multi_machine_job_events`")  # noqa: E501
+        # verify the required parameter 'id' is set
+        if ('id' not in params or
+                params['id'] is None):
+            raise ValueError("Missing the required parameter `id` when calling `jobs_service_list_multi_machine_job_events`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'project_id' in params:
+            path_params['projectId'] = params['project_id']  # noqa: E501
+        if 'id' in params:
+            path_params['id'] = params['id']  # noqa: E501
+
+        query_params = []
+        if 'release_id' in params:
+            query_params.append(('releaseId', params['release_id']))  # noqa: E501
+        if 'limit' in params:
+            query_params.append(('limit', params['limit']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v1/projects/{projectId}/multi-machine-jobs/{id}/events', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='V1ListMultiMachineJobEventsResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def jobs_service_list_multi_machine_jobs(self, project_id: 'str', **kwargs) -> 'V1ListMultiMachineJobsResponse':  # noqa: E501
         """jobs_service_list_multi_machine_jobs  # noqa: E501
 
@@ -3611,3 +3724,100 @@ class JobsServiceApi(object):
             _preload_content=params.get('_preload_content', True),
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
+
+    def jobs_service_validate_deployment_image(self, body: 'V1ValidateDeploymentImageRequest', **kwargs) -> 'V1ValidateDeploymentImageResponse':  # noqa: E501
+        """Job deployments  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.jobs_service_validate_deployment_image(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param V1ValidateDeploymentImageRequest body: (required)
+        :return: V1ValidateDeploymentImageResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.jobs_service_validate_deployment_image_with_http_info(body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.jobs_service_validate_deployment_image_with_http_info(body, **kwargs)  # noqa: E501
+            return data
+
+    def jobs_service_validate_deployment_image_with_http_info(self, body: 'V1ValidateDeploymentImageRequest', **kwargs) -> 'V1ValidateDeploymentImageResponse':  # noqa: E501
+        """Job deployments  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.jobs_service_validate_deployment_image_with_http_info(body, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param V1ValidateDeploymentImageRequest body: (required)
+        :return: V1ValidateDeploymentImageResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['body']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method jobs_service_validate_deployment_image" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `jobs_service_validate_deployment_image`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            body_params = params['body']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = []  # noqa: E501
+
+        return self.api_client.call_api(
+            '/v1/deployments/validate', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='V1ValidateDeploymentImageResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)