abacusai.refresh_policy
Module Contents
Classes
A Refresh Policy describes the frequency in which one or more datasets/models/deployments/batch_predictions can be updated. |
- class abacusai.refresh_policy.RefreshPolicy(client, refreshPolicyId=None, name=None, cron=None, nextRunTime=None, createdAt=None, refreshType=None, projectId=None, datasetIds=None, modelIds=None, deploymentIds=None, paused=None)
Bases:
abacusai.return_class.AbstractApiClass
A Refresh Policy describes the frequency in which one or more datasets/models/deployments/batch_predictions can be updated.
- Parameters
client (ApiClient) – An authenticated API Client instance
refreshPolicyId (str) – The unique identifier for the refresh policy
name (str) – The user-friendly name for the refresh policy
cron (str) – A cron-style string that describes the when this refresh policy is to be executed in UTC
nextRunTime (str) – The next UTC time that this refresh policy will be executed
createdAt (str) – The time when the refresh policy was created
refreshType (str) – The type of refresh policy to be run
projectId (str) – The unique identifier of a project that this refresh policy applies to
datasetIds (list of unique identifiers of type 'string') – Comma separated list of Dataset IDs that this refresh policy applies to
modelIds (list of unique identifiers of type 'string') – Comma separated list of Model IDs that this refresh policy applies to
deploymentIds (list of unique identifiers of type 'string') – Comma separated list of Deployment IDs that this refresh policy applies to
paused (bool) – (Boolean): True if the refresh policy is paused
- __repr__(self)
Return repr(self).
- to_dict(self)
Get a dict representation of the parameters in this class
- Returns
The dict value representation of the class parameters
- Return type
- delete(self)
Delete a refresh policy
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- refresh(self)
Calls describe and refreshes the current object’s fields
- Returns
The current object
- Return type
- describe(self)
Retrieve a single refresh policy
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- Returns
A refresh policy object
- Return type
- list_refresh_pipeline_runs(self)
List the the times that the refresh policy has been run
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- Returns
A list of refresh pipeline runs for the given refresh policy id
- Return type
- pause(self)
Pauses a refresh policy
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- resume(self)
Resumes a refresh policy
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- run(self)
Force a run of the refresh policy.
- Parameters
refresh_policy_id (str) – The unique ID associated with this refresh policy
- update(self, name=None, cron=None)
Update the name or cron string of a refresh policy
- Parameters
- Returns
The updated refresh policy
- Return type