Method
createRefreshPolicy POST
Copy POST

Creates a refresh policy with a particular cron pattern and refresh type. The cron is specified in UTC time.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes name str The name of the refresh policy.
Yes cron str A cron-like string specifying the frequency of the refresh policy in UTC time.
Yes refreshType str The refresh type used to determine what is being refreshed, such as a single dataset, dataset and model, or more.
No projectId str Optionally, a project ID can be specified so that all datasets, models, deployments, batch predictions, prediction metrics, model monitrs, and notebooks are captured at the instant the policy was created.
No datasetIds list Comma-separated list of dataset IDs.
No featureGroupId str Feature Group ID associated with refresh policy.
No modelIds list Comma-separated list of model IDs.
No deploymentIds list Comma-separated list of deployment IDs.
No batchPredictionIds list Comma-separated list of batch prediction IDs.
No modelMonitorIds list Comma-separated list of model monitor IDs.
No notebookId str Notebook ID associated with refresh policy.
No predictionOperatorId str Prediction Operator ID associated with refresh policy.
No featureGroupExportConfig FeatureGroupExportConfig Feature group export configuration.
KEY TYPE Description
outputLocation str The File Connector location to which the feature group is being written.
fileFormat str The file format being written to output_location.
databaseConnectorId str The unique string identifier of the database connector used.
objectName str The object in the database connector to which the feature group is being written.
writeMode str UPSERT or INSERT for writing to the database connector.
databaseFeatureMapping dict The column/feature pairs mapping the features to the database columns.
idColumn str The id column to use as the upsert key.
additionalIdColumns str For database connectors which support it, additional ID columns to use as a complex key for upserting.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result RefreshPolicy
KEY TYPE Description
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 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[str] Comma-separated list of Dataset IDs that this refresh policy applies to
featureGroupId str Feature Group ID that this refresh policy applies to
modelIds List[str] Comma-separated list of Model IDs that this refresh policy applies to
deploymentIds List[str] Comma-separated list of Deployment IDs that this refresh policy applies to
batchPredictionIds List[str] Comma-separated list of Batch Prediction IDs that this refresh policy applies to
modelMonitorIds List[str] Comma-separated list of Model Monitor IDs that this refresh policy applies to
notebookId str Notebook ID that this refresh policy applies to
paused bool True if the refresh policy is paused
predictionOperatorId str Prediction Operator ID that this refresh policy applies to
pipelineId str The Pipeline ID With The Cron Schedule
featureGroupExportConfig FeatureGroupRefreshExportConfig The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP.
KEY TYPE Description
connectorType str The type of connector the feature group is
location str The file connector location of the feature group export
exportFileFormat str The file format of the feature group export
additionalIdColumns list Additional id columns to use for upsert operations
databaseFeatureMapping dict The mapping of feature names to database columns
externalConnectionId str The unique identifier of the external connection to write to
idColumn str The column to use as the id column for upsert operations
objectName str The name of the object to write to
writeMode str The write mode to use for the export

Exceptions:

TYPE WHEN
DataNotFoundError

projectId is not found.
DataNotFoundError

datasetIds is not found.
DataNotFoundError

featureGroupId is not found.
DataNotFoundError

modelIds is not found.
DataNotFoundError

deploymentIds is not found.
DataNotFoundError

batchPredictionIds is not found.
DataNotFoundError

modelMonitorIds is not found.
DataNotFoundError

notebookId is not found.
DataNotFoundError

predictionOperatorId is not found.
InvalidEnumParameterError

An invalid value is passed for refreshType.
DataNotFoundError

A specified dataset, model, or deployment could not be found.
InvalidRequest

Error with IDs provided or the particular project does not support setting a refresh policy on this particular resource.
Language:

© Copyright