Method: Gitlab::Client::PipelineSchedules#edit_pipeline_schedule

Defined in:
lib/gitlab/client/pipeline_schedules.rb

#edit_pipeline_schedule(project, pipeline_schedule_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Updates the pipeline schedule of a project.

Examples:

Gitlab.edit_pipeline_schedule(3, 2, { description: 'example2' })

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • The (Integer) —

    pipeline schedule ID.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :description (String) —

    The description of pipeline scehdule.

  • :ref (String) —

    The branch/tag name will be triggered.

  • :cron (String) —

    The cron (e.g. 0 1 * * *).

  • :cron_timezone (String) —

    The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: ‘UTC’).

  • :active (Boolean) —

    The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).

Returns:

[View source]

76
77
78
 
# File 'lib/gitlab/client/pipeline_schedules.rb', line 76

def edit_pipeline_schedule(project, pipeline_schedule_id, options = {})
  put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", body: options)
end