GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi
gitlab.getPipelineSchedules
Explore with Pulumi AI
The gitlab.PipelineSchedule data source retrieves information about a gitlab pipeline schedule for a project.
Upstream API: GitLab REST API docs
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
const example = gitlab.getPipelineSchedules({
    project: "12345",
});
import pulumi
import pulumi_gitlab as gitlab
example = gitlab.get_pipeline_schedules(project="12345")
package main
import (
	"github.com/pulumi/pulumi-gitlab/sdk/v8/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetPipelineSchedules(ctx, &gitlab.GetPipelineSchedulesArgs{
			Project: "12345",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() => 
{
    var example = GitLab.GetPipelineSchedules.Invoke(new()
    {
        Project = "12345",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetPipelineSchedulesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var example = GitlabFunctions.getPipelineSchedules(GetPipelineSchedulesArgs.builder()
            .project("12345")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: gitlab:getPipelineSchedules
      arguments:
        project: '12345'
Using getPipelineSchedules
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPipelineSchedules(args: GetPipelineSchedulesArgs, opts?: InvokeOptions): Promise<GetPipelineSchedulesResult>
function getPipelineSchedulesOutput(args: GetPipelineSchedulesOutputArgs, opts?: InvokeOptions): Output<GetPipelineSchedulesResult>def get_pipeline_schedules(project: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPipelineSchedulesResult
def get_pipeline_schedules_output(project: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPipelineSchedulesResult]func GetPipelineSchedules(ctx *Context, args *GetPipelineSchedulesArgs, opts ...InvokeOption) (*GetPipelineSchedulesResult, error)
func GetPipelineSchedulesOutput(ctx *Context, args *GetPipelineSchedulesOutputArgs, opts ...InvokeOption) GetPipelineSchedulesResultOutput> Note: This function is named GetPipelineSchedules in the Go SDK.
public static class GetPipelineSchedules 
{
    public static Task<GetPipelineSchedulesResult> InvokeAsync(GetPipelineSchedulesArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineSchedulesResult> Invoke(GetPipelineSchedulesInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPipelineSchedulesResult> getPipelineSchedules(GetPipelineSchedulesArgs args, InvokeOptions options)
public static Output<GetPipelineSchedulesResult> getPipelineSchedules(GetPipelineSchedulesArgs args, InvokeOptions options)
fn::invoke:
  function: gitlab:index/getPipelineSchedules:getPipelineSchedules
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Project string
 - The name or id of the project to add the schedule to.
 
- Project string
 - The name or id of the project to add the schedule to.
 
- project String
 - The name or id of the project to add the schedule to.
 
- project string
 - The name or id of the project to add the schedule to.
 
- project str
 - The name or id of the project to add the schedule to.
 
- project String
 - The name or id of the project to add the schedule to.
 
getPipelineSchedules Result
The following output properties are available:
- Id string
 - Pipeline
Schedules List<Pulumi.Git Lab. Outputs. Get Pipeline Schedules Pipeline Schedule>  - The list of pipeline schedules.
 - Project string
 - The name or id of the project to add the schedule to.
 
- Id string
 - Pipeline
Schedules []GetPipeline Schedules Pipeline Schedule  - The list of pipeline schedules.
 - Project string
 - The name or id of the project to add the schedule to.
 
- id String
 - pipeline
Schedules List<GetPipeline Schedules Pipeline Schedule>  - The list of pipeline schedules.
 - project String
 - The name or id of the project to add the schedule to.
 
- id string
 - pipeline
Schedules GetPipeline Schedules Pipeline Schedule[]  - The list of pipeline schedules.
 - project string
 - The name or id of the project to add the schedule to.
 
- id str
 - pipeline_
schedules Sequence[GetPipeline Schedules Pipeline Schedule]  - The list of pipeline schedules.
 - project str
 - The name or id of the project to add the schedule to.
 
- id String
 - pipeline
Schedules List<Property Map> - The list of pipeline schedules.
 - project String
 - The name or id of the project to add the schedule to.
 
Supporting Types
GetPipelineSchedulesPipelineSchedule    
- Active bool
 - The activation status of pipeline schedule.
 - Created
At string - The datetime of when the schedule was created.
 - Cron string
 - The cron (e.g. 
0 1 * * *). - Cron
Timezone string - The timezone.
 - Description string
 - The description of the pipeline schedule.
 - Id int
 - The pipeline schedule id.
 - Next
Run stringAt  - The datetime of when the schedule will next run.
 - Owner
Pulumi.
Git Lab. Inputs. Get Pipeline Schedules Pipeline Schedule Owner  - The details of the pipeline schedule owner.
 - Ref string
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - Updated
At string - The datetime of when the schedule was last updated.
 
- Active bool
 - The activation status of pipeline schedule.
 - Created
At string - The datetime of when the schedule was created.
 - Cron string
 - The cron (e.g. 
0 1 * * *). - Cron
Timezone string - The timezone.
 - Description string
 - The description of the pipeline schedule.
 - Id int
 - The pipeline schedule id.
 - Next
Run stringAt  - The datetime of when the schedule will next run.
 - Owner
Get
Pipeline Schedules Pipeline Schedule Owner  - The details of the pipeline schedule owner.
 - Ref string
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - Updated
At string - The datetime of when the schedule was last updated.
 
- active Boolean
 - The activation status of pipeline schedule.
 - created
At String - The datetime of when the schedule was created.
 - cron String
 - The cron (e.g. 
0 1 * * *). - cron
Timezone String - The timezone.
 - description String
 - The description of the pipeline schedule.
 - id Integer
 - The pipeline schedule id.
 - next
Run StringAt  - The datetime of when the schedule will next run.
 - owner
Get
Pipeline Schedules Pipeline Schedule Owner  - The details of the pipeline schedule owner.
 - ref String
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - updated
At String - The datetime of when the schedule was last updated.
 
- active boolean
 - The activation status of pipeline schedule.
 - created
At string - The datetime of when the schedule was created.
 - cron string
 - The cron (e.g. 
0 1 * * *). - cron
Timezone string - The timezone.
 - description string
 - The description of the pipeline schedule.
 - id number
 - The pipeline schedule id.
 - next
Run stringAt  - The datetime of when the schedule will next run.
 - owner
Get
Pipeline Schedules Pipeline Schedule Owner  - The details of the pipeline schedule owner.
 - ref string
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - updated
At string - The datetime of when the schedule was last updated.
 
- active bool
 - The activation status of pipeline schedule.
 - created_
at str - The datetime of when the schedule was created.
 - cron str
 - The cron (e.g. 
0 1 * * *). - cron_
timezone str - The timezone.
 - description str
 - The description of the pipeline schedule.
 - id int
 - The pipeline schedule id.
 - next_
run_ strat  - The datetime of when the schedule will next run.
 - owner
Get
Pipeline Schedules Pipeline Schedule Owner  - The details of the pipeline schedule owner.
 - ref str
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - updated_
at str - The datetime of when the schedule was last updated.
 
- active Boolean
 - The activation status of pipeline schedule.
 - created
At String - The datetime of when the schedule was created.
 - cron String
 - The cron (e.g. 
0 1 * * *). - cron
Timezone String - The timezone.
 - description String
 - The description of the pipeline schedule.
 - id Number
 - The pipeline schedule id.
 - next
Run StringAt  - The datetime of when the schedule will next run.
 - owner Property Map
 - The details of the pipeline schedule owner.
 - ref String
 - The branch/tag name to be triggered. This will be the full branch reference, for example: 
refs/heads/main, notmain. - updated
At String - The datetime of when the schedule was last updated.
 
GetPipelineSchedulesPipelineScheduleOwner     
Package Details
- Repository
 - GitLab pulumi/pulumi-gitlab
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
gitlabTerraform Provider.