Interface ScheduleReleaseAction`Beta`

Schedules a release to be published at the given UTC time. Locks the version documents server-side until the release is unscheduled or published.

interface ScheduleReleaseAction {
    dataset?: string;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: string;
    publishAt: string;
    releaseId: string;
    resource?: DocumentResource;
    source?: DocumentResource;
    type: "release.schedule";
}

Hierarchy (View Summary)

ReleaseHandle
- ScheduleReleaseAction

Index

Properties

dataset? perspective? projectId? publishAt releaseId resource? source? type

Properties

`Optional` `Beta`dataset

dataset?: string

`Optional` `Beta`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional` `Beta`projectId

projectId?: string

`Beta`publishAt

publishAt: string

`Beta`releaseId

releaseId: string

`Optional` `Beta`resource

resource?: DocumentResource

Explicit resource object to use for this operation.

`Optional` `Beta`source

source?: DocumentResource

Deprecated

Use resource instead.

`Beta`type

type: "release.schedule"