GitLab v6.11.0, Apr 19 24

GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi

gitlab.getProjectBranches

Explore with Pulumi AI

GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";

const example = gitlab.getProjectBranches({
    project: "foo/bar/baz",
});

import pulumi
import pulumi_gitlab as gitlab

example = gitlab.get_project_branches(project="foo/bar/baz")

package main

import (
	"github.com/pulumi/pulumi-gitlab/sdk/v6/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.GetProjectBranches(ctx, &gitlab.GetProjectBranchesArgs{
			Project: "foo/bar/baz",
		}, 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.GetProjectBranches.Invoke(new()
    {
        Project = "foo/bar/baz",
    });

});

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.GetProjectBranchesArgs;
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.getProjectBranches(GetProjectBranchesArgs.builder()
            .project("foo/bar/baz")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: gitlab:getProjectBranches
      Arguments:
        project: foo/bar/baz

Using getProjectBranches

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 getProjectBranches(args: GetProjectBranchesArgs, opts?: InvokeOptions): Promise<GetProjectBranchesResult>
function getProjectBranchesOutput(args: GetProjectBranchesOutputArgs, opts?: InvokeOptions): Output<GetProjectBranchesResult>

def get_project_branches(project: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProjectBranchesResult
def get_project_branches_output(project: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProjectBranchesResult]

func GetProjectBranches(ctx *Context, args *GetProjectBranchesArgs, opts ...InvokeOption) (*GetProjectBranchesResult, error)
func GetProjectBranchesOutput(ctx *Context, args *GetProjectBranchesOutputArgs, opts ...InvokeOption) GetProjectBranchesResultOutput

> Note: This function is named GetProjectBranches in the Go SDK.

public static class GetProjectBranches 
{
    public static Task<GetProjectBranchesResult> InvokeAsync(GetProjectBranchesArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectBranchesResult> Invoke(GetProjectBranchesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectBranchesResult> getProjectBranches(GetProjectBranchesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: gitlab:index/getProjectBranches:getProjectBranches
  arguments:
    # arguments dictionary

The following arguments are supported:

Project string: ID or URL-encoded path of the project owned by the authenticated user.

Project string: ID or URL-encoded path of the project owned by the authenticated user.

project String: ID or URL-encoded path of the project owned by the authenticated user.

project string: ID or URL-encoded path of the project owned by the authenticated user.

project str: ID or URL-encoded path of the project owned by the authenticated user.

project String: ID or URL-encoded path of the project owned by the authenticated user.

getProjectBranches Result

The following output properties are available:

Branches List<Pulumi.GitLab.Outputs.GetProjectBranchesBranch>: The list of branches of the project, as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Project string: ID or URL-encoded path of the project owned by the authenticated user.

Branches []GetProjectBranchesBranch: The list of branches of the project, as defined below.
Id string: The provider-assigned unique ID for this managed resource.
Project string: ID or URL-encoded path of the project owned by the authenticated user.

branches List<GetProjectBranchesBranch>: The list of branches of the project, as defined below.
id String: The provider-assigned unique ID for this managed resource.
project String: ID or URL-encoded path of the project owned by the authenticated user.

branches GetProjectBranchesBranch[]: The list of branches of the project, as defined below.
id string: The provider-assigned unique ID for this managed resource.
project string: ID or URL-encoded path of the project owned by the authenticated user.

branches Sequence[GetProjectBranchesBranch]: The list of branches of the project, as defined below.
id str: The provider-assigned unique ID for this managed resource.
project str: ID or URL-encoded path of the project owned by the authenticated user.

branches List<Property Map>: The list of branches of the project, as defined below.
id String: The provider-assigned unique ID for this managed resource.
project String: ID or URL-encoded path of the project owned by the authenticated user.

Supporting Types

GetProjectBranchesBranch

CanPush bool: Bool, true if you can push to the branch.
Commits List<Pulumi.GitLab.Inputs.GetProjectBranchesBranchCommit>: The commit associated with this branch.
Default bool: Bool, true if branch is the default branch for the project.
DevelopersCanMerge bool: Bool, true if developer level access allows to merge branch.
DevelopersCanPush bool: Bool, true if developer level access allows git push.
Merged bool: Bool, true if the branch has been merged into it's parent.
Name string: The name of the branch.
Protected bool: Bool, true if branch has branch protection.
WebUrl string: URL that can be used to find the branch in a browser.

CanPush bool: Bool, true if you can push to the branch.
Commits []GetProjectBranchesBranchCommit: The commit associated with this branch.
Default bool: Bool, true if branch is the default branch for the project.
DevelopersCanMerge bool: Bool, true if developer level access allows to merge branch.
DevelopersCanPush bool: Bool, true if developer level access allows git push.
Merged bool: Bool, true if the branch has been merged into it's parent.
Name string: The name of the branch.
Protected bool: Bool, true if branch has branch protection.
WebUrl string: URL that can be used to find the branch in a browser.

canPush Boolean: Bool, true if you can push to the branch.
commits List<GetProjectBranchesBranchCommit>: The commit associated with this branch.
default_ Boolean: Bool, true if branch is the default branch for the project.
developersCanMerge Boolean: Bool, true if developer level access allows to merge branch.
developersCanPush Boolean: Bool, true if developer level access allows git push.
merged Boolean: Bool, true if the branch has been merged into it's parent.
name String: The name of the branch.
protected_ Boolean: Bool, true if branch has branch protection.
webUrl String: URL that can be used to find the branch in a browser.

canPush boolean: Bool, true if you can push to the branch.
commits GetProjectBranchesBranchCommit[]: The commit associated with this branch.
default boolean: Bool, true if branch is the default branch for the project.
developersCanMerge boolean: Bool, true if developer level access allows to merge branch.
developersCanPush boolean: Bool, true if developer level access allows git push.
merged boolean: Bool, true if the branch has been merged into it's parent.
name string: The name of the branch.
protected boolean: Bool, true if branch has branch protection.
webUrl string: URL that can be used to find the branch in a browser.

can_push bool: Bool, true if you can push to the branch.
commits Sequence[GetProjectBranchesBranchCommit]: The commit associated with this branch.
default bool: Bool, true if branch is the default branch for the project.
developers_can_merge bool: Bool, true if developer level access allows to merge branch.
developers_can_push bool: Bool, true if developer level access allows git push.
merged bool: Bool, true if the branch has been merged into it's parent.
name str: The name of the branch.
protected bool: Bool, true if branch has branch protection.
web_url str: URL that can be used to find the branch in a browser.

canPush Boolean: Bool, true if you can push to the branch.
commits List<Property Map>: The commit associated with this branch.
default Boolean: Bool, true if branch is the default branch for the project.
developersCanMerge Boolean: Bool, true if developer level access allows to merge branch.
developersCanPush Boolean: Bool, true if developer level access allows git push.
merged Boolean: Bool, true if the branch has been merged into it's parent.
name String: The name of the branch.
protected Boolean: Bool, true if branch has branch protection.
webUrl String: URL that can be used to find the branch in a browser.

GetProjectBranchesBranchCommit

AuthorEmail string: The email of the author.
AuthorName string: The name of the author.
AuthoredDate string: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
CommittedDate string: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
CommitterEmail string: The email of the user that committed.
CommitterName string: The name of the user that committed.
Id string: The unique id assigned to the commit by Gitlab.
Message string: The commit message
ParentIds List<string>: The id of the parents of the commit
ShortId string: The short id assigned to the commit by Gitlab.
Title string: The title of the commit

AuthorEmail string: The email of the author.
AuthorName string: The name of the author.
AuthoredDate string: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
CommittedDate string: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
CommitterEmail string: The email of the user that committed.
CommitterName string: The name of the user that committed.
Id string: The unique id assigned to the commit by Gitlab.
Message string: The commit message
ParentIds []string: The id of the parents of the commit
ShortId string: The short id assigned to the commit by Gitlab.
Title string: The title of the commit

authorEmail String: The email of the author.
authorName String: The name of the author.
authoredDate String: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
committedDate String: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
committerEmail String: The email of the user that committed.
committerName String: The name of the user that committed.
id String: The unique id assigned to the commit by Gitlab.
message String: The commit message
parentIds List<String>: The id of the parents of the commit
shortId String: The short id assigned to the commit by Gitlab.
title String: The title of the commit

authorEmail string: The email of the author.
authorName string: The name of the author.
authoredDate string: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
committedDate string: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
committerEmail string: The email of the user that committed.
committerName string: The name of the user that committed.
id string: The unique id assigned to the commit by Gitlab.
message string: The commit message
parentIds string[]: The id of the parents of the commit
shortId string: The short id assigned to the commit by Gitlab.
title string: The title of the commit

author_email str: The email of the author.
author_name str: The name of the author.
authored_date str: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
committed_date str: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
committer_email str: The email of the user that committed.
committer_name str: The name of the user that committed.
id str: The unique id assigned to the commit by Gitlab.
message str: The commit message
parent_ids Sequence[str]: The id of the parents of the commit
short_id str: The short id assigned to the commit by Gitlab.
title str: The title of the commit

authorEmail String: The email of the author.
authorName String: The name of the author.
authoredDate String: The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
committedDate String: The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
committerEmail String: The email of the user that committed.
committerName String: The name of the user that committed.
id String: The unique id assigned to the commit by Gitlab.
message String: The commit message
parentIds List<String>: The id of the parents of the commit
shortId String: The short id assigned to the commit by Gitlab.
title String: The title of the commit

Package Details

Repository: GitLab pulumi/pulumi-gitlab
License: Apache-2.0
Notes: This Pulumi package is based on the gitlab Terraform Provider.

GitLab v6.11.0 published on Friday, Apr 19, 2024 by Pulumi

pulumi/pulumi-gitlab

gitlab.getProjectBranches

On this page

On this page

Example Usage

Using getProjectBranches

getProjectBranches Result

Supporting Types

GetProjectBranchesBranch

GetProjectBranchesBranchCommit

Package Details

On this page

On this page