pulumi-gitlab-kotlin/com.pulumi.gitlab.kotlin/GitlabFunctions/getProjects

getProjects

suspend fun getProjects(argument: GetProjectsPlainArgs): GetProjectsResult

The gitlab.getProjects data source allows details of multiple projects to be retrieved. Optionally filtered by the set attributes.

This data source supports all available filters exposed by the xanzy/go-gitlab package, which might not expose all available filters exposed by the Gitlab APIs. The owner sub-attributes are only populated if the Gitlab token used has an administrator scope. Upstream API: GitLab REST API docs

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gitlab from "@pulumi/gitlab";
// List projects within a group tree
const mygroup = gitlab.getGroup({
    fullPath: "mygroup",
});
const groupProjects = mygroup.then(mygroup => gitlab.getProjects({
    groupId: mygroup.id,
    orderBy: "name",
    includeSubgroups: true,
    withShared: false,
}));
// List projects using the search syntax
const projects = gitlab.getProjects({
    search: "postgresql",
    visibility: "private",
});

import pulumi
import pulumi_gitlab as gitlab
# List projects within a group tree
mygroup = gitlab.get_group(full_path="mygroup")
group_projects = gitlab.get_projects(group_id=mygroup.id,
    order_by="name",
    include_subgroups=True,
    with_shared=False)
# List projects using the search syntax
projects = gitlab.get_projects(search="postgresql",
    visibility="private")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using GitLab = Pulumi.GitLab;
return await Deployment.RunAsync(() =>
{
    // List projects within a group tree
    var mygroup = GitLab.GetGroup.Invoke(new()
    {
        FullPath = "mygroup",
    });
    var groupProjects = GitLab.GetProjects.Invoke(new()
    {
        GroupId = mygroup.Apply(getGroupResult => getGroupResult.Id),
        OrderBy = "name",
        IncludeSubgroups = true,
        WithShared = false,
    });
    // List projects using the search syntax
    var projects = GitLab.GetProjects.Invoke(new()
    {
        Search = "postgresql",
        Visibility = "private",
    });
});

package main
import (
	"github.com/pulumi/pulumi-gitlab/sdk/v7/go/gitlab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// List projects within a group tree
		mygroup, err := gitlab.LookupGroup(ctx, &gitlab.LookupGroupArgs{
			FullPath: pulumi.StringRef("mygroup"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = gitlab.GetProjects(ctx, &gitlab.GetProjectsArgs{
			GroupId:          pulumi.IntRef(mygroup.Id),
			OrderBy:          pulumi.StringRef("name"),
			IncludeSubgroups: pulumi.BoolRef(true),
			WithShared:       pulumi.BoolRef(false),
		}, nil)
		if err != nil {
			return err
		}
		// List projects using the search syntax
		_, err = gitlab.GetProjects(ctx, &gitlab.GetProjectsArgs{
			Search:     pulumi.StringRef("postgresql"),
			Visibility: pulumi.StringRef("private"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetGroupArgs;
import com.pulumi.gitlab.inputs.GetProjectsArgs;
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) {
        // List projects within a group tree
        final var mygroup = GitlabFunctions.getGroup(GetGroupArgs.builder()
            .fullPath("mygroup")
            .build());
        final var groupProjects = GitlabFunctions.getProjects(GetProjectsArgs.builder()
            .groupId(mygroup.applyValue(getGroupResult -> getGroupResult.id()))
            .orderBy("name")
            .includeSubgroups(true)
            .withShared(false)
            .build());
        // List projects using the search syntax
        final var projects = GitlabFunctions.getProjects(GetProjectsArgs.builder()
            .search("postgresql")
            .visibility("private")
            .build());
    }
}

variables:
  # List projects within a group tree
  mygroup:
    fn::invoke:
      Function: gitlab:getGroup
      Arguments:
        fullPath: mygroup
  groupProjects:
    fn::invoke:
      Function: gitlab:getProjects
      Arguments:
        groupId: ${mygroup.id}
        orderBy: name
        includeSubgroups: true
        withShared: false
  # List projects using the search syntax
  projects:
    fn::invoke:
      Function: gitlab:getProjects
      Arguments:
        search: postgresql
        visibility: private

Return

A collection of values returned by getProjects.

Parameters

argument

A collection of arguments for invoking getProjects.

suspend fun getProjects(archived: Boolean? = null, groupId: Int? = null, includeSubgroups: Boolean? = null, maxQueryablePages: Int? = null, membership: Boolean? = null, minAccessLevel: Int? = null, orderBy: String? = null, owned: Boolean? = null, page: Int? = null, perPage: Int? = null, search: String? = null, simple: Boolean? = null, sort: String? = null, starred: Boolean? = null, statistics: Boolean? = null, topics: List<String>? = null, visibility: String? = null, withCustomAttributes: Boolean? = null, withIssuesEnabled: Boolean? = null, withMergeRequestsEnabled: Boolean? = null, withProgrammingLanguage: String? = null, withShared: Boolean? = null): GetProjectsResult

Return

A collection of values returned by getProjects.

Parameters

archived

Limit by archived status.

groupId

The ID of the group owned by the authenticated user to look projects for within. Cannot be used with min_access_level, with_programming_language or statistics.

includeSubgroups

Include projects in subgroups of this group. Default is false. Needs group_id.

maxQueryablePages

The maximum number of project results pages that may be queried. Prevents overloading your Gitlab instance in case of a misconfiguration.

membership

Limit by projects that the current user is a member of.

minAccessLevel

Limit to projects where current user has at least this access level, refer to the official documentation for values. Cannot be used with group_id.

orderBy

Return projects ordered ordered by: id, name, path, created_at, updated_at, last_activity_at, similarity, repository_size, storage_size, packages_size, wiki_size. Some values or only available in certain circumstances. See upstream docs for details.

owned

Limit by projects owned by the current user.

page

The first page to begin the query on.

perPage

The number of results to return per page.

Return list of authorized projects matching the search criteria.

simple

Return only the ID, URL, name, and path of each project.

sort

Return projects sorted in asc or desc order. Default is desc.

starred

Limit by projects starred by the current user.

statistics

Include project statistics. Cannot be used with group_id.

topics

Limit by projects that have all of the given topics.

visibility

Limit by visibility public, internal, or private.

withCustomAttributes

Include custom attributes in response (admins only).

withIssuesEnabled

Limit by projects with issues feature enabled. Default is false.

withMergeRequestsEnabled

Limit by projects with merge requests feature enabled. Default is false.

withProgrammingLanguage

Limit by projects which use the given programming language. Cannot be used with group_id.

withShared

Include projects shared to this group. Default is true. Needs group_id.

Return

A collection of values returned by getProjects.

Parameters

argument

Builder for com.pulumi.gitlab.kotlin.inputs.GetProjectsPlainArgs.

getProjects

Example Usage

Return

Parameters

Return

Parameters

See also

Return

Parameters

See also