Deprecate RuntimeJob (#2170)

* Deprecate RuntimeJob

* Add release note

* update docs

---------

Co-authored-by: ptristan3 <[email protected]>

Author: kt474

qiskit_ibm_runtime/__init__.py

@@ -152,9 +152,9 @@
 
 When you use the ``run()`` method of the :class:`Sampler` or :class:`Estimator`
 to invoke the primitive, a
-:class:`RuntimeJob` instance is returned. This class has all the basic job
-methods, such as :meth:`RuntimeJob.status`, :meth:`RuntimeJob.result`, and
-:meth:`RuntimeJob.cancel`.
+:class:`RuntimeJobV2` instance is returned. This class has all the basic job
+methods, such as :meth:`RuntimeJobV2.status`, :meth:`RuntimeJobV2.result`, and
+:meth:`RuntimeJobV2.cancel`.
 
 Logging
 -------

qiskit_ibm_runtime/qiskit_runtime_service.py

@@ -794,7 +794,7 @@ def _run(
             start_session: Set to True to explicitly start a runtime session. Defaults to False.
 
         Returns:
-            A ``RuntimeJob`` instance representing the execution.
+            A ``RuntimeJobV2`` instance representing the execution.
 
         Raises:
             IBMInputValueError: If input is invalid.

qiskit_ibm_runtime/runtime_job.py

@@ -35,6 +35,7 @@
 )
 from .utils.result_decoder import ResultDecoder
 from .utils.queueinfo import QueueInfo
+from .utils.deprecation import issue_deprecation_msg
 from .api.clients import RuntimeClient
 from .api.exceptions import RequestsApiError
 from .api.client_parameters import ClientParameters
@@ -95,7 +96,7 @@ def __init__(
         tags: Optional[List] = None,
         version: Optional[int] = None,
     ) -> None:
-        """RuntimeJob constructor.
+        """(DEPRECATED) RuntimeJob constructor.
 
         Args:
             backend: The backend instance used to run this job.
@@ -112,6 +113,15 @@ def __init__(
             tags: Tags assigned to the job.
             version: Primitive version.
         """
+
+        issue_deprecation_msg(
+            msg="The RuntimeJob class is deprecated",
+            version="0.38.0",
+            stacklevel=4,
+            remedy="All primitives now return the RuntimeJobV2 class. The major difference between "
+            "the two classes is that `Job.status()` is returned as a string in RuntimeJobV2.",
+        )
+
         Job.__init__(self, backend=backend, job_id=job_id)
         BaseRuntimeJob.__init__(
             self,

release-notes/unreleased/2170.deprecation.rst

@@ -0,0 +1,3 @@
+:class:`RuntimeJob` is now deprecated. All of the primitives return :class:`RuntimeJobV2` so there is no need for 
+``RuntimeJob`` anymore. The major difference between the two classes is that 
+:meth:`~.RuntimeJobV2.status` returns a string instead of Qiskit's ``JobStatus`` enum.