1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getPipelineSchedules
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi

gitlab.getPipelineSchedules

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gitlab:index/getPipelineSchedules:getPipelineSchedules
      arguments:
        # arguments dictionary

    The 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
    PipelineSchedules List<Pulumi.GitLab.Outputs.GetPipelineSchedulesPipelineSchedule>
    The list of pipeline schedules.
    Project string
    The name or id of the project to add the schedule to.
    Id string
    PipelineSchedules []GetPipelineSchedulesPipelineSchedule
    The list of pipeline schedules.
    Project string
    The name or id of the project to add the schedule to.
    id String
    pipelineSchedules List<GetPipelineSchedulesPipelineSchedule>
    The list of pipeline schedules.
    project String
    The name or id of the project to add the schedule to.
    id string
    pipelineSchedules GetPipelineSchedulesPipelineSchedule[]
    The list of pipeline schedules.
    project string
    The name or id of the project to add the schedule to.
    id str
    pipeline_schedules Sequence[GetPipelineSchedulesPipelineSchedule]
    The list of pipeline schedules.
    project str
    The name or id of the project to add the schedule to.
    id String
    pipelineSchedules 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.
    CreatedAt string
    The datetime of when the schedule was created.
    Cron string
    The cron (e.g. 0 1 * * *).
    CronTimezone string
    The timezone.
    Description string
    The description of the pipeline schedule.
    Id int
    The pipeline schedule id.
    NextRunAt string
    The datetime of when the schedule will next run.
    Owner Pulumi.GitLab.Inputs.GetPipelineSchedulesPipelineScheduleOwner
    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, not main.
    UpdatedAt string
    The datetime of when the schedule was last updated.
    Active bool
    The activation status of pipeline schedule.
    CreatedAt string
    The datetime of when the schedule was created.
    Cron string
    The cron (e.g. 0 1 * * *).
    CronTimezone string
    The timezone.
    Description string
    The description of the pipeline schedule.
    Id int
    The pipeline schedule id.
    NextRunAt string
    The datetime of when the schedule will next run.
    Owner GetPipelineSchedulesPipelineScheduleOwner
    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, not main.
    UpdatedAt string
    The datetime of when the schedule was last updated.
    active Boolean
    The activation status of pipeline schedule.
    createdAt String
    The datetime of when the schedule was created.
    cron String
    The cron (e.g. 0 1 * * *).
    cronTimezone String
    The timezone.
    description String
    The description of the pipeline schedule.
    id Integer
    The pipeline schedule id.
    nextRunAt String
    The datetime of when the schedule will next run.
    owner GetPipelineSchedulesPipelineScheduleOwner
    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, not main.
    updatedAt String
    The datetime of when the schedule was last updated.
    active boolean
    The activation status of pipeline schedule.
    createdAt string
    The datetime of when the schedule was created.
    cron string
    The cron (e.g. 0 1 * * *).
    cronTimezone string
    The timezone.
    description string
    The description of the pipeline schedule.
    id number
    The pipeline schedule id.
    nextRunAt string
    The datetime of when the schedule will next run.
    owner GetPipelineSchedulesPipelineScheduleOwner
    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, not main.
    updatedAt 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_at str
    The datetime of when the schedule will next run.
    owner GetPipelineSchedulesPipelineScheduleOwner
    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, not main.
    updated_at str
    The datetime of when the schedule was last updated.
    active Boolean
    The activation status of pipeline schedule.
    createdAt String
    The datetime of when the schedule was created.
    cron String
    The cron (e.g. 0 1 * * *).
    cronTimezone String
    The timezone.
    description String
    The description of the pipeline schedule.
    id Number
    The pipeline schedule id.
    nextRunAt String
    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, not main.
    updatedAt String
    The datetime of when the schedule was last updated.

    GetPipelineSchedulesPipelineScheduleOwner

    AvatarUrl string
    Image URL for the user's avatar.
    Id int
    The user ID.
    Name string
    Name.
    State string
    User's state, one of: active, blocked.
    Username string
    Username.
    WebUrl string
    URL to the user's profile.
    AvatarUrl string
    Image URL for the user's avatar.
    Id int
    The user ID.
    Name string
    Name.
    State string
    User's state, one of: active, blocked.
    Username string
    Username.
    WebUrl string
    URL to the user's profile.
    avatarUrl String
    Image URL for the user's avatar.
    id Integer
    The user ID.
    name String
    Name.
    state String
    User's state, one of: active, blocked.
    username String
    Username.
    webUrl String
    URL to the user's profile.
    avatarUrl string
    Image URL for the user's avatar.
    id number
    The user ID.
    name string
    Name.
    state string
    User's state, one of: active, blocked.
    username string
    Username.
    webUrl string
    URL to the user's profile.
    avatar_url str
    Image URL for the user's avatar.
    id int
    The user ID.
    name str
    Name.
    state str
    User's state, one of: active, blocked.
    username str
    Username.
    web_url str
    URL to the user's profile.
    avatarUrl String
    Image URL for the user's avatar.
    id Number
    The user ID.
    name String
    Name.
    state String
    User's state, one of: active, blocked.
    username String
    Username.
    webUrl String
    URL to the user's profile.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi