
<h1 class="has-pills">
  PipelineSchedule
  <span data-algolia-exclude><span class="pill pill--object pill--normal-case pill--large"><code>OBJECT</code></span></span>
</h1>

A schedule of when a build should automatically triggered for a Pipeline



| `branch` `String` The branch to use for builds that this schedule triggers. Defaults to to the default branch in the Pipeline |
| --- |
| `builds` `BuildConnection` Returns the builds created by this schedule Arguments `after` `String` Returns the elements in the list that come after the specified cursor. |
| `before` `String` Returns the elements in the list that come before the specified cursor. |
| `first` `Int` Returns the first _n_ elements from the list. |
| `last` `Int` Returns the last _n_ elements from the list. |

</details></div></td></tr><tr><td><h3 class="is-small has-pills"><code>commit</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The commit to use for builds that this schedule triggers. Defaults to <code>HEAD</code></p></td></tr><tr><td><h3 class="is-small has-pills"><code>createdAt</code><a href="/docs/apis/graphql/schemas/scalar/datetime" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR DateTime"><code>DateTime</code></a></h3><p>The time when this schedule was created</p></td></tr><tr><td><h3 class="is-small has-pills"><code>createdBy</code><a href="/docs/apis/graphql/schemas/object/user" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT User"><code>User</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>cronline</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>A definition of the trigger build schedule in cron syntax</p></td></tr><tr><td><h3 class="is-small has-pills"><code>enabled</code><a href="/docs/apis/graphql/schemas/scalar/boolean" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR Boolean"><code>Boolean</code></a></h3><p>If this Pipeline schedule is currently enabled</p></td></tr><tr><td><h3 class="is-small has-pills"><code>env</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>[String!]</code></a></h3><p>Environment variables passed to any triggered builds</p></td></tr><tr><td><h3 class="is-small has-pills"><code>failedAt</code><a href="/docs/apis/graphql/schemas/scalar/datetime" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR DateTime"><code>DateTime</code></a></h3><p>The time when this schedule failed</p></td></tr><tr><td><h3 class="is-small has-pills"><code>failedMessage</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>If the last attempt at triggering this scheduled build fails, this will be the reason</p></td></tr><tr><td><h3 class="is-small has-pills"><code>id</code><a href="/docs/apis/graphql/schemas/scalar/id" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR ID"><code>ID!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>label</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>A short description of the Pipeline schedule</p></td></tr><tr><td><h3 class="is-small has-pills"><code>message</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String</code></a></h3><p>The message to use for builds that this schedule triggers</p></td></tr><tr><td><h3 class="is-small has-pills"><code>nextBuildAt</code><a href="/docs/apis/graphql/schemas/scalar/datetime" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR DateTime"><code>DateTime</code></a></h3><p>The time when this schedule will create a build next</p></td></tr><tr><td><h3 class="is-small has-pills"><code>permissions</code><a href="/docs/apis/graphql/schemas/object/pipelineschedulepermissions" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT PipelineSchedulePermissions"><code>PipelineSchedulePermissions!</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>pipeline</code><a href="/docs/apis/graphql/schemas/object/pipeline" class="pill pill--object pill--normal-case pill--medium" title="Go to OBJECT Pipeline"><code>Pipeline</code></a></h3></td></tr><tr><td><h3 class="is-small has-pills"><code>uuid</code><a href="/docs/apis/graphql/schemas/scalar/string" class="pill pill--scalar pill--normal-case pill--medium" title="Go to SCALAR String"><code>String!</code></a></h3><p>The UUID of the Pipeline schedule</p></td></tr>
  </tbody>
</table>

<h2 data-algolia-exclude>Interfaces</h2>
<div>
  <a href="/docs/apis/graphql/schemas/interface/node" class="pill pill--interface pill--normal-case pill--large" title="Go to INTERFACE Node">
  <code>Node</code>
</a>

</div>
