GitLab v8.1.0 published on Friday, Jun 21, 2024 by Pulumi
gitlab.getProjectBranches
Explore with Pulumi AI
The gitlab.getProjectBranches data source allows details of the branches of a given project to be retrieved.
Upstream API: GitLab REST API docs
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 dictionaryThe 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.
Git Lab. Outputs. Get Project Branches Branch>  - 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
[]Get
Project Branches Branch  - 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<Get
Project Branches Branch>  - 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
Get
Project Branches Branch[]  - 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[Get
Project Branches Branch]  - 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   
- Can
Push bool - Bool, true if you can push to the branch.
 - Commits
List<Pulumi.
Git Lab. Inputs. Get Project Branches Branch Commit>  - The commit associated with this branch.
 - Default bool
 - Bool, true if branch is the default branch for the project.
 - Developers
Can boolMerge  - Bool, true if developer level access allows to merge branch.
 - Developers
Can boolPush  - 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.
 - Web
Url 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
[]Get
Project Branches Branch Commit  - The commit associated with this branch.
 - Default bool
 - Bool, true if branch is the default branch for the project.
 - Developers
Can boolMerge  - Bool, true if developer level access allows to merge branch.
 - Developers
Can boolPush  - 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.
 - Web
Url string - URL that can be used to find the branch in a browser.
 
- can
Push Boolean - Bool, true if you can push to the branch.
 - commits
List<Get
Project Branches Branch Commit>  - The commit associated with this branch.
 - default_ Boolean
 - Bool, true if branch is the default branch for the project.
 - developers
Can BooleanMerge  - Bool, true if developer level access allows to merge branch.
 - developers
Can BooleanPush  - 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.
 - web
Url String - URL that can be used to find the branch in a browser.
 
- can
Push boolean - Bool, true if you can push to the branch.
 - commits
Get
Project Branches Branch Commit[]  - The commit associated with this branch.
 - default boolean
 - Bool, true if branch is the default branch for the project.
 - developers
Can booleanMerge  - Bool, true if developer level access allows to merge branch.
 - developers
Can booleanPush  - 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.
 - web
Url 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[Get
Project Branches Branch Commit]  - The commit associated with this branch.
 - default bool
 - Bool, true if branch is the default branch for the project.
 - developers_
can_ boolmerge  - Bool, true if developer level access allows to merge branch.
 - developers_
can_ boolpush  - 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.
 
- can
Push 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.
 - developers
Can BooleanMerge  - Bool, true if developer level access allows to merge branch.
 - developers
Can BooleanPush  - 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.
 - web
Url String - URL that can be used to find the branch in a browser.
 
GetProjectBranchesBranchCommit    
- string
 - The email of the author.
 - string
 - The name of the author.
 - string
 - The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
 - Committed
Date string - The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
 - Committer
Email string - The email of the user that committed.
 - Committer
Name string - The name of the user that committed.
 - Id string
 - The unique id assigned to the commit by Gitlab.
 - Message string
 - The commit message
 - Parent
Ids List<string> - The id of the parents of the commit
 - Short
Id string - The short id assigned to the commit by Gitlab.
 - Title string
 - The title of the commit
 
- string
 - The email of the author.
 - string
 - The name of the author.
 - string
 - The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
 - Committed
Date string - The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
 - Committer
Email string - The email of the user that committed.
 - Committer
Name string - The name of the user that committed.
 - Id string
 - The unique id assigned to the commit by Gitlab.
 - Message string
 - The commit message
 - Parent
Ids []string - The id of the parents of the commit
 - Short
Id string - The short id assigned to the commit by Gitlab.
 - Title string
 - The title of the commit
 
- String
 - The email of the author.
 - String
 - The name of the author.
 - String
 - The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
 - committed
Date String - The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
 - committer
Email String - The email of the user that committed.
 - committer
Name String - The name of the user that committed.
 - id String
 - The unique id assigned to the commit by Gitlab.
 - message String
 - The commit message
 - parent
Ids List<String> - The id of the parents of the commit
 - short
Id String - The short id assigned to the commit by Gitlab.
 - title String
 - The title of the commit
 
- string
 - The email of the author.
 - string
 - The name of the author.
 - string
 - The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
 - committed
Date string - The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
 - committer
Email string - The email of the user that committed.
 - committer
Name string - The name of the user that committed.
 - id string
 - The unique id assigned to the commit by Gitlab.
 - message string
 - The commit message
 - parent
Ids string[] - The id of the parents of the commit
 - short
Id string - The short id assigned to the commit by Gitlab.
 - title string
 - The title of the commit
 
- str
 - The email of the author.
 - str
 - The name of the author.
 - 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
 
- String
 - The email of the author.
 - String
 - The name of the author.
 - String
 - The date which the commit was authored (format: yyyy-MM-ddTHH:mm:ssZ).
 - committed
Date String - The date at which the commit was pushed (format: yyyy-MM-ddTHH:mm:ssZ).
 - committer
Email String - The email of the user that committed.
 - committer
Name String - The name of the user that committed.
 - id String
 - The unique id assigned to the commit by Gitlab.
 - message String
 - The commit message
 - parent
Ids List<String> - The id of the parents of the commit
 - short
Id 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 
gitlabTerraform Provider.