module Gitlab::Client::PipelineSchedules

def create_pipeline_schedule(project, options = {})

Returns:
  • (Array) -

Options Hash: (**options)
  • :active (Boolean) -- The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
  • :cron_timezone (String) -- The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
  • :cron (String) -- The cron (e.g. 0 1 * * *).
  • :ref (String) -- The branch/tag name will be triggered.
  • :description (String) -- The description of pipeline scehdule.

Parameters:
  • options (Hash) -- A customizable set of options.
  • project (Integer, String) -- The ID or name of a project. 
def create_pipeline_schedule(project, options = {})
  post("/projects/#{url_encode project}/pipeline_schedules", query: options)
end

def create_pipeline_schedule_variable(project, pipeline_schedule_id, options = {})

Returns:
  • (Array) - The created pipeline schedule variable.

Options Hash: (**options)
  • :value (String) -- The value of a variable
  • :key (String) -- The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed.

Parameters:
  • options (Hash) -- A customizable set of options.
  • trigger_id (Integer) -- The pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def create_pipeline_schedule_variable(project, pipeline_schedule_id, options = {})
  post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables", query: options)
end

def delete_pipeline_schedule(project, pipeline_schedule_id)

Returns:
  • (Gitlab::ObjectifiedHash) - The deleted pipeline schedule.

Parameters:
  • trigger_id (Integer) -- The pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def delete_pipeline_schedule(project, pipeline_schedule_id)
  delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}")
end

def delete_pipeline_schedule_variable(project, pipeline_schedule_id, key, _options = {})

Returns:
  • (Array) - The deleted pipeline schedule variable.

Parameters:
  • The (String) -- key of a variable.
  • The (Integer) -- pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def delete_pipeline_schedule_variable(project, pipeline_schedule_id, key, _options = {})
  delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}")
end

def edit_pipeline_schedule(project, pipeline_schedule_id, options = {})

Returns:
  • (Array) - The updated pipeline schedule.

Options Hash: (**options)
  • :active (Boolean) -- The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
  • :cron_timezone (String) -- The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
  • :cron (String) -- The cron (e.g. 0 1 * * *).
  • :ref (String) -- The branch/tag name will be triggered.
  • :description (String) -- The description of pipeline scehdule.

Parameters:
  • options (Hash) -- A customizable set of options.
  • The (Integer) -- pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def edit_pipeline_schedule(project, pipeline_schedule_id, options = {})
  put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", query: options)
end

def edit_pipeline_schedule_variable(project, pipeline_schedule_id, key, options = {})

Returns:
  • (Array) - The updated pipeline schedule variable.

Options Hash: (**options)
  • :value (String) -- The value of a variable.

Parameters:
  • options (Hash) -- A customizable set of options.
  • The (String) -- key of a variable.
  • The (Integer) -- pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def edit_pipeline_schedule_variable(project, pipeline_schedule_id, key, options = {})
  put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}", query: options)
end

def pipeline_schedule(project, id)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • id (Integer) -- The ID of the pipeline schedule.
  • project (Integer, String) -- The ID or name of a project. 
def pipeline_schedule(project, id)
  get("/projects/#{url_encode project}/pipeline_schedules/#{id}")
end

def pipeline_schedule_take_ownership(project, pipeline_schedule_id)

Returns:
  • (Gitlab::ObjectifiedHash) - The updated pipeline schedule.

Parameters:
  • trigger_id (Integer) -- The pipeline schedule ID.
  • project (Integer, String) -- The ID or name of a project. 
def pipeline_schedule_take_ownership(project, pipeline_schedule_id)
  post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/take_ownership")
end

def pipeline_schedules(project, options = {})

Returns:
  • (Array) -

Parameters:
  • options (Hash) -- A customizable set of options.
  • project (Integer, String) -- the ID or name of a project. 
def pipeline_schedules(project, options = {})
  get("/projects/#{url_encode project}/pipeline_schedules", query: options)
end