Foundry Platform SDK

The Schedule API allows you to create, retrieve, delete, and control the execution of schedules in Foundry.

Available Methods

• create: Creates a new Schedule. (Public Beta)
• delete: Deletes a Schedule by its RID. (Stable)
• get: Retrieves a specific Schedule by its RID. (Public Beta)
• get_affected_resources: Retrieves resources affected by a specific Schedule. (Public Beta)
• get_batch: Fetches multiple schedules in a single request (max 1000). (Public Beta)
• pause: Pauses a Schedule. (Stable)
• replace: Replaces an existing Schedule. (Public Beta)
• run: Manually triggers a Schedule run. (Stable)
• runs: Retrieves the run history for a Schedule. (Stable)
• unpause: Resumes a paused Schedule. (Stable)

The GtQuery model is used to filter objects where a specific field's value is strictly greater than a provided value. It requires a target field, a comparison value, and a fixed type literal of "gt".

{
  "field": "FIELD_NAME",
  "value": "VALUE",
  "type": "gt"
}

The SearchCheckpointRecordsAndFilter model is used to perform a logical AND conjunction of multiple checkpoint record filters. When searching for checkpoint records, you can use this model to ensure that all specified criteria in the filters list are met simultaneously.

Properties

The FileImportCustomFilter model represents a custom filter used during file imports.

Important Limitation: While you can fetch existing custom file import filters using the SDK, they cannot currently be used as part of the payload when creating or updating file imports.

The ApiNameLocatorWrapper is a specialized model locator used to find language models based on their specific API name. When constructing a locator object, you must provide the api_name and set the type to the literal value "apiName".

# Example structure of an ApiNameLocatorWrapper
locator = ApiNameLocatorWrapper(
    api_name="your_model_api_name",
    type="apiName"
)