:py:mod:`abacusai.refresh_policy`
=================================

.. py:module:: abacusai.refresh_policy


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   abacusai.refresh_policy.RefreshPolicy




.. py:class:: RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, modelIds=None, deploymentIds=None, predictionMetricIds=None, modelMonitorIds=None, paused=None)

   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`

   A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated.

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param refreshPolicyId: The unique identifier for the refresh policy
   :type refreshPolicyId: str
   :param name: The user-friendly name for the refresh policy
   :type name: str
   :param cron: A cron-style string that describes when this refresh policy is to be executed in UTC
   :type cron: str
   :param nextRunTime: The next UTC time that this refresh policy will be executed
   :type nextRunTime: str
   :param createdAt: The time when the refresh policy was created
   :type createdAt: str
   :param refreshType: The type of refresh policy to be run
   :type refreshType: str
   :param projectId: The unique identifier of a project that this refresh policy applies to
   :type projectId: str
   :param datasetIds: Comma-separated list of Dataset IDs that this refresh policy applies to
   :type datasetIds: list[str]
   :param modelIds: Comma-separated list of Model IDs that this refresh policy applies to
   :type modelIds: list[str]
   :param deploymentIds: Comma-separated list of Deployment IDs that this refresh policy applies to
   :type deploymentIds: list[str]
   :param predictionMetricIds: Comma-separated list of Prediction Metric IDs that this refresh policy applies to
   :type predictionMetricIds: list[str]
   :param modelMonitorIds: Comma-separated list of Model Monitor IDs that this refresh policy applies to
   :type modelMonitorIds: list[str]
   :param paused: True if the refresh policy is paused
   :type paused: bool

   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict


   .. py:method:: delete()

      Delete a refresh policy.

      :param refresh_policy_id: Unique string identifier associated with the refresh policy to delete.
      :type refresh_policy_id: str


   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: RefreshPolicy


   .. py:method:: describe()

      Retrieve a single refresh policy

      :param refresh_policy_id: The unique ID associated with this refresh policy.
      :type refresh_policy_id: str

      :returns: An object representing the refresh policy.
      :rtype: RefreshPolicy


   .. py:method:: list_refresh_pipeline_runs()

      List the the times that the refresh policy has been run

      :param refresh_policy_id: Unique identifier associated with the refresh policy.
      :type refresh_policy_id: str

      :returns: List of refresh pipeline runs for the given refresh policy ID.
      :rtype: RefreshPipelineRun


   .. py:method:: pause()

      Pauses a refresh policy

      :param refresh_policy_id: Unique identifier associated with the refresh policy to be paused.
      :type refresh_policy_id: str


   .. py:method:: resume()

      Resumes a refresh policy

      :param refresh_policy_id: The unique ID associated with this refresh policy.
      :type refresh_policy_id: str


   .. py:method:: run()

      Force a run of the refresh policy.

      :param refresh_policy_id: Unique string identifier associated with the refresh policy to be run.
      :type refresh_policy_id: str


   .. py:method:: update(name = None, cron = None)

      Update the name or cron string of a refresh policy

      :param name: Name of the refresh policy to be updated.
      :type name: str
      :param cron: Cron string describing the schedule from the refresh policy to be updated.
      :type cron: str

      :returns: Updated refresh policy.
      :rtype: RefreshPolicy



