> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IAutomationSchedule

- Package: [@gooddata/sdk-model](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-model/src/automations/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
export interface IAutomationSchedule 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cron](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md#iautomationschedulecron) |  | string | **_(ALPHA)_** Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). Example: 0 \*/30 9-17 ? \* MON-FRI (every 30 minutes from 9:00 to 17:00 on workdays) |
| [cronDescription?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md#iautomationschedulecrondescription) |  | string | **_(ALPHA)_** _(Optional)_ Human-readable description of the cron expression. |
| [firstRun?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md#iautomationschedulefirstrun) |  | string | **_(ALPHA)_** _(Optional)_ Timestamp of the first scheduled action If not provided default to the next scheduled time. It should not include timezone information (use timezone property instead). Example: 2024-02-29T10:00:00.000Z |
| [timezone?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationschedule/index.md#iautomationscheduletimezone) |  | string | **_(ALPHA)_** _(Optional)_ Timezone in which the schedule is defined. Example: Europe/Prague |

## Property details

### IAutomationSchedule.cron

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR).

Example: 0 \*/30 9-17 ? \* MON-FRI (every 30 minutes from 9:00 to 17:00 on workdays)

**Signature:**

```typescript
cron: string;
```

### IAutomationSchedule.cronDescription

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Human-readable description of the cron expression.

**Signature:**

```typescript
cronDescription?: string;
```

### IAutomationSchedule.firstRun

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Timestamp of the first scheduled action If not provided default to the next scheduled time. It should not include timezone information (use timezone property instead).

Example: 2024-02-29T10:00:00.000Z

**Signature:**

```typescript
firstRun?: string;
```

### IAutomationSchedule.timezone

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Timezone in which the schedule is defined.

Example: Europe/Prague

**Signature:**

```typescript
timezone?: string;
```
