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

GitlabFunctions

object GitlabFunctions

Functions

Link copied to clipboard
suspend fun getBranch(argument: GetBranchPlainArgs): GetBranchResult

The gitlab.Branch data source allows details of a repository branch to be retrieved by its name and project. Upstream API: GitLab REST API docs

suspend fun getBranch(argument: suspend GetBranchPlainArgsBuilder.() -> Unit): GetBranchResult
suspend fun getBranch(name: String, project: String): GetBranchResult
Link copied to clipboard
suspend fun getClusterAgent(argument: GetClusterAgentPlainArgs): GetClusterAgentResult

The gitlab.ClusterAgent data source allows to retrieve details about a GitLab Agent for Kubernetes.

suspend fun getClusterAgent(argument: suspend GetClusterAgentPlainArgsBuilder.() -> Unit): GetClusterAgentResult
suspend fun getClusterAgent(agentId: Int, project: String): GetClusterAgentResult
Link copied to clipboard
suspend fun getClusterAgents(argument: GetClusterAgentsPlainArgs): GetClusterAgentsResult

The gitlab.getClusterAgents data source allows details of GitLab Agents for Kubernetes in a project.

suspend fun getClusterAgents(project: String): GetClusterAgentsResult
suspend fun getClusterAgents(argument: suspend GetClusterAgentsPlainArgsBuilder.() -> Unit): GetClusterAgentsResult
Link copied to clipboard
suspend fun getCurrentUser(): GetCurrentUserResult

The gitlab.getCurrentUser data source allows details of the current user (determined by token provider attribute) to be retrieved. Upstream API: GitLab GraphQL API docs

Link copied to clipboard
suspend fun getGroup(argument: GetGroupPlainArgs): GetGroupResult

The gitlab.Group data source allows details of a group to be retrieved by its id or full path. Upstream API: GitLab REST API docs

suspend fun getGroup(argument: suspend GetGroupPlainArgsBuilder.() -> Unit): GetGroupResult
suspend fun getGroup(fullPath: String? = null, groupId: Int? = null): GetGroupResult
Link copied to clipboard
suspend fun getGroupHook(argument: GetGroupHookPlainArgs): GetGroupHookResult

The gitlab.GroupHook data source allows to retrieve details about a hook in a group. Upstream API: GitLab REST API docs

suspend fun getGroupHook(argument: suspend GetGroupHookPlainArgsBuilder.() -> Unit): GetGroupHookResult
suspend fun getGroupHook(group: String, hookId: Int): GetGroupHookResult
Link copied to clipboard
suspend fun getGroupHooks(argument: GetGroupHooksPlainArgs): GetGroupHooksResult

The gitlab.getGroupHooks data source allows to retrieve details about hooks in a group. Upstream API: GitLab REST API docs

suspend fun getGroupHooks(group: String): GetGroupHooksResult
suspend fun getGroupHooks(argument: suspend GetGroupHooksPlainArgsBuilder.() -> Unit): GetGroupHooksResult
Link copied to clipboard
suspend fun getGroupMembership(argument: GetGroupMembershipPlainArgs): GetGroupMembershipResult

The gitlab.GroupMembership data source allows to list and filter all members of a group specified by either its id or full path. Upstream API: GitLab REST API docs

suspend fun getGroupMembership(argument: suspend GetGroupMembershipPlainArgsBuilder.() -> Unit): GetGroupMembershipResult
suspend fun getGroupMembership(accessLevel: String? = null, fullPath: String? = null, groupId: Int? = null): GetGroupMembershipResult
Link copied to clipboard
suspend fun getGroups(argument: GetGroupsPlainArgs): GetGroupsResult

The gitlab.getGroups data source allows details of multiple groups to be retrieved given some optional filter criteria.

suspend fun getGroups(argument: suspend GetGroupsPlainArgsBuilder.() -> Unit): GetGroupsResult
suspend fun getGroups(orderBy: String? = null, search: String? = null, sort: String? = null): GetGroupsResult
Link copied to clipboard
suspend fun getGroupSubgroups(argument: GetGroupSubgroupsPlainArgs): GetGroupSubgroupsResult

The gitlab.getGroupSubgroups data source allows to get subgroups of a group. Upstream API: GitLab REST API docs

suspend fun getGroupSubgroups(argument: suspend GetGroupSubgroupsPlainArgsBuilder.() -> Unit): GetGroupSubgroupsResult
suspend fun getGroupSubgroups(allAvailable: Boolean? = null, groupId: Int, minAccessLevel: String? = null, orderBy: String? = null, owned: Boolean? = null, search: String? = null, skipGroups: List<Int>? = null, sort: String? = null, statistics: Boolean? = null, withCustomAttributes: Boolean? = null): GetGroupSubgroupsResult
Link copied to clipboard
suspend fun getGroupVariable(argument: GetGroupVariablePlainArgs): GetGroupVariableResult

The gitlab.GroupVariable data source allows to retrieve details about a group-level CI/CD variable. Upstream API: GitLab REST API docs

suspend fun getGroupVariable(argument: suspend GetGroupVariablePlainArgsBuilder.() -> Unit): GetGroupVariableResult
suspend fun getGroupVariable(environmentScope: String? = null, group: String, key: String): GetGroupVariableResult
Link copied to clipboard
suspend fun getGroupVariables(argument: GetGroupVariablesPlainArgs): GetGroupVariablesResult

The gitlab.getGroupVariables data source allows to retrieve all group-level CI/CD variables. Upstream API: GitLab REST API docs

suspend fun getGroupVariables(argument: suspend GetGroupVariablesPlainArgsBuilder.() -> Unit): GetGroupVariablesResult
suspend fun getGroupVariables(environmentScope: String? = null, group: String): GetGroupVariablesResult
Link copied to clipboard
suspend fun getInstanceDeployKeys(argument: GetInstanceDeployKeysPlainArgs): GetInstanceDeployKeysResult

The gitlab.getInstanceDeployKeys data source allows to retrieve a list of deploy keys for a GitLab instance.

suspend fun getInstanceDeployKeys(public: Boolean? = null): GetInstanceDeployKeysResult
suspend fun getInstanceDeployKeys(argument: suspend GetInstanceDeployKeysPlainArgsBuilder.() -> Unit): GetInstanceDeployKeysResult
Link copied to clipboard
suspend fun getInstanceVariable(argument: GetInstanceVariablePlainArgs): GetInstanceVariableResult

The gitlab.InstanceVariable data source allows to retrieve details about an instance-level CI/CD variable. Upstream API: GitLab REST API docs

suspend fun getInstanceVariable(key: String): GetInstanceVariableResult
suspend fun getInstanceVariable(argument: suspend GetInstanceVariablePlainArgsBuilder.() -> Unit): GetInstanceVariableResult
Link copied to clipboard
suspend fun getInstanceVariables(): GetInstanceVariablesResult

The gitlab.getInstanceVariables data source allows to retrieve all instance-level CI/CD variables. Upstream API: GitLab REST API docs

Link copied to clipboard
suspend fun getProject(argument: GetProjectPlainArgs): GetProjectResult

The gitlab.Project data source allows details of a project to be retrieved by either its ID or its path with namespace. Upstream API: GitLab REST API docs

suspend fun getProject(argument: suspend GetProjectPlainArgsBuilder.() -> Unit): GetProjectResult
suspend fun getProject(ciDefaultGitDepth: Int? = null, id: String? = null, pathWithNamespace: String? = null, publicBuilds: Boolean? = null): GetProjectResult
Link copied to clipboard
suspend fun getProjectBranches(argument: GetProjectBranchesPlainArgs): GetProjectBranchesResult

The gitlab.getProjectBranches data source allows details of the branches of a given project to be retrieved. Upstream API: GitLab REST API docs

suspend fun getProjectBranches(project: String): GetProjectBranchesResult
suspend fun getProjectBranches(argument: suspend GetProjectBranchesPlainArgsBuilder.() -> Unit): GetProjectBranchesResult
Link copied to clipboard
suspend fun getProjectHook(argument: GetProjectHookPlainArgs): GetProjectHookResult

The gitlab.ProjectHook data source allows to retrieve details about a hook in a project. Upstream API: GitLab REST API docs

suspend fun getProjectHook(argument: suspend GetProjectHookPlainArgsBuilder.() -> Unit): GetProjectHookResult
suspend fun getProjectHook(hookId: Int, project: String): GetProjectHookResult
Link copied to clipboard
suspend fun getProjectHooks(argument: GetProjectHooksPlainArgs): GetProjectHooksResult

The gitlab.getProjectHooks data source allows to retrieve details about hooks in a project. Upstream API: GitLab REST API docs

suspend fun getProjectHooks(project: String): GetProjectHooksResult
suspend fun getProjectHooks(argument: suspend GetProjectHooksPlainArgsBuilder.() -> Unit): GetProjectHooksResult
Link copied to clipboard
suspend fun getProjectIssue(argument: GetProjectIssuePlainArgs): GetProjectIssueResult

The gitlab.ProjectIssue data source allows to retrieve details about an issue in a project. Upstream API: GitLab API docs

suspend fun getProjectIssue(argument: suspend GetProjectIssuePlainArgsBuilder.() -> Unit): GetProjectIssueResult
suspend fun getProjectIssue(iid: Int, project: String): GetProjectIssueResult
Link copied to clipboard
suspend fun getProjectIssues(argument: GetProjectIssuesPlainArgs): GetProjectIssuesResult

The gitlab.getProjectIssues data source allows to retrieve details about issues in a project. Upstream API: GitLab API docs

suspend fun getProjectIssues(argument: suspend GetProjectIssuesPlainArgsBuilder.() -> Unit): GetProjectIssuesResult
suspend fun getProjectIssues(assigneeId: Int? = null, assigneeUsername: String? = null, authorId: Int? = null, confidential: Boolean? = null, createdAfter: String? = null, createdBefore: String? = null, dueDate: String? = null, iids: List<Int>? = null, issueType: String? = null, labels: List<String>? = null, milestone: String? = null, myReactionEmoji: String? = null, notAssigneeIds: List<Int>? = null, notAuthorIds: List<Int>? = null, notLabels: List<String>? = null, notMilestone: String? = null, notMyReactionEmojis: List<String>? = null, orderBy: String? = null, project: String, scope: String? = null, search: String? = null, sort: String? = null, updatedAfter: String? = null, updatedBefore: String? = null, weight: Int? = null, withLabelsDetails: Boolean? = null): GetProjectIssuesResult
Link copied to clipboard
suspend fun getProjectMembership(argument: GetProjectMembershipPlainArgs): GetProjectMembershipResult

The gitlab.ProjectMembership data source allows to list and filter all members of a project specified by either its id or full path.

suspend fun getProjectMembership(argument: suspend GetProjectMembershipPlainArgsBuilder.() -> Unit): GetProjectMembershipResult
suspend fun getProjectMembership(fullPath: String? = null, inherited: Boolean? = null, projectId: Int? = null, query: String? = null): GetProjectMembershipResult
Link copied to clipboard
suspend fun getProjectMilestone(argument: GetProjectMilestonePlainArgs): GetProjectMilestoneResult

The gitlab.ProjectMilestone data source allows get details of a project milestone. Upstream API: GitLab REST API docs

suspend fun getProjectMilestone(argument: suspend GetProjectMilestonePlainArgsBuilder.() -> Unit): GetProjectMilestoneResult
suspend fun getProjectMilestone(milestoneId: Int, project: String): GetProjectMilestoneResult
Link copied to clipboard
suspend fun getProjectMilestones(argument: GetProjectMilestonesPlainArgs): GetProjectMilestonesResult

The gitlab.getProjectMilestones data source allows get details of a project milestones. Upstream API: GitLab REST API docs

suspend fun getProjectMilestones(argument: suspend GetProjectMilestonesPlainArgsBuilder.() -> Unit): GetProjectMilestonesResult
suspend fun getProjectMilestones(iids: List<Int>? = null, includeParentMilestones: Boolean? = null, project: String, search: String? = null, state: String? = null, title: String? = null): GetProjectMilestonesResult
Link copied to clipboard
suspend fun getProjectProtectedBranch(argument: GetProjectProtectedBranchPlainArgs): GetProjectProtectedBranchResult

The gitlab_protected_branch data source allows details of a protected branch to be retrieved by its name and the project it belongs to. Upstream API: GitLab REST API docs

suspend fun getProjectProtectedBranch(argument: suspend GetProjectProtectedBranchPlainArgsBuilder.() -> Unit): GetProjectProtectedBranchResult
suspend fun getProjectProtectedBranch(name: String, projectId: String): GetProjectProtectedBranchResult
Link copied to clipboard
suspend fun getProjectProtectedBranches(argument: GetProjectProtectedBranchesPlainArgs): GetProjectProtectedBranchesResult

The gitlab.getProjectProtectedBranches data source allows details of the protected branches of a given project. Upstream API: GitLab REST API docs

suspend fun getProjectProtectedBranches(projectId: String): GetProjectProtectedBranchesResult
suspend fun getProjectProtectedBranches(argument: suspend GetProjectProtectedBranchesPlainArgsBuilder.() -> Unit): GetProjectProtectedBranchesResult
Link copied to clipboard
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.

suspend fun getProjects(argument: suspend GetProjectsPlainArgsBuilder.() -> Unit): GetProjectsResult
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, visibility: String? = null, withCustomAttributes: Boolean? = null, withIssuesEnabled: Boolean? = null, withMergeRequestsEnabled: Boolean? = null, withProgrammingLanguage: String? = null, withShared: Boolean? = null): GetProjectsResult
Link copied to clipboard
suspend fun getProjectTag(argument: GetProjectTagPlainArgs): GetProjectTagResult

The gitlab.ProjectTag data source allows details of a project tag to be retrieved by its name. Upstream API: GitLab API docs

suspend fun getProjectTag(argument: suspend GetProjectTagPlainArgsBuilder.() -> Unit): GetProjectTagResult
suspend fun getProjectTag(name: String, project: String): GetProjectTagResult
Link copied to clipboard
suspend fun getProjectTags(argument: GetProjectTagsPlainArgs): GetProjectTagsResult

The gitlab.getProjectTags data source allows details of project tags to be retrieved by some search criteria. Upstream API: GitLab REST API docs

suspend fun getProjectTags(argument: suspend GetProjectTagsPlainArgsBuilder.() -> Unit): GetProjectTagsResult
suspend fun getProjectTags(orderBy: String? = null, project: String, search: String? = null, sort: String? = null): GetProjectTagsResult
Link copied to clipboard
suspend fun getProjectVariable(argument: GetProjectVariablePlainArgs): GetProjectVariableResult

The gitlab.ProjectVariable data source allows to retrieve details about a project-level CI/CD variable. Upstream API: GitLab REST API docs

suspend fun getProjectVariable(argument: suspend GetProjectVariablePlainArgsBuilder.() -> Unit): GetProjectVariableResult
suspend fun getProjectVariable(environmentScope: String? = null, key: String, project: String): GetProjectVariableResult
Link copied to clipboard
suspend fun getProjectVariables(argument: GetProjectVariablesPlainArgs): GetProjectVariablesResult

The gitlab.getProjectVariables data source allows to retrieve all project-level CI/CD variables. Upstream API: GitLab REST API docs

suspend fun getProjectVariables(argument: suspend GetProjectVariablesPlainArgsBuilder.() -> Unit): GetProjectVariablesResult
suspend fun getProjectVariables(environmentScope: String? = null, project: String): GetProjectVariablesResult
Link copied to clipboard
suspend fun getReleaseLink(argument: GetReleaseLinkPlainArgs): GetReleaseLinkResult

The gitlab.ReleaseLink data source allows get details of a release link. Upstream API: GitLab REST API docs

suspend fun getReleaseLink(argument: suspend GetReleaseLinkPlainArgsBuilder.() -> Unit): GetReleaseLinkResult
suspend fun getReleaseLink(linkId: Int, project: String, tagName: String): GetReleaseLinkResult
Link copied to clipboard
suspend fun getReleaseLinks(argument: GetReleaseLinksPlainArgs): GetReleaseLinksResult

The gitlab.getReleaseLinks data source allows get details of release links. Upstream API: GitLab REST API docs

suspend fun getReleaseLinks(argument: suspend GetReleaseLinksPlainArgsBuilder.() -> Unit): GetReleaseLinksResult
suspend fun getReleaseLinks(project: String, tagName: String): GetReleaseLinksResult
Link copied to clipboard
suspend fun getRepositoryFile(argument: GetRepositoryFilePlainArgs): GetRepositoryFileResult

The gitlab.RepositoryFile data source allows details of a file in a repository to be retrieved. Upstream API: GitLab REST API docs

suspend fun getRepositoryFile(argument: suspend GetRepositoryFilePlainArgsBuilder.() -> Unit): GetRepositoryFileResult
suspend fun getRepositoryFile(filePath: String, project: String, ref: String): GetRepositoryFileResult
Link copied to clipboard
suspend fun getRepositoryTree(argument: GetRepositoryTreePlainArgs): GetRepositoryTreeResult

The gitlab.getRepositoryTree data source allows details of directories and files in a repository to be retrieved. Upstream API: GitLab REST API docs

suspend fun getRepositoryTree(argument: suspend GetRepositoryTreePlainArgsBuilder.() -> Unit): GetRepositoryTreeResult
suspend fun getRepositoryTree(path: String? = null, project: String, recursive: Boolean? = null, ref: String): GetRepositoryTreeResult
Link copied to clipboard
suspend fun getUser(argument: GetUserPlainArgs): GetUserResult

The gitlab.User data source allows details of a user to be retrieved by either the user ID, username or email address.

suspend fun getUser(argument: suspend GetUserPlainArgsBuilder.() -> Unit): GetUserResult
suspend fun getUser(email: String? = null, namespaceId: Int? = null, userId: Int? = null, username: String? = null): GetUserResult
Link copied to clipboard
suspend fun getUsers(argument: GetUsersPlainArgs): GetUsersResult

The gitlab.getUsers data source allows details of multiple users to be retrieved given some optional filter criteria.

suspend fun getUsers(argument: suspend GetUsersPlainArgsBuilder.() -> Unit): GetUsersResult
suspend fun getUsers(active: Boolean? = null, blocked: Boolean? = null, createdAfter: String? = null, createdBefore: String? = null, externProvider: String? = null, externUid: String? = null, orderBy: String? = null, search: String? = null, sort: String? = null): GetUsersResult
Link copied to clipboard
suspend fun getUserSshkeys(argument: GetUserSshkeysPlainArgs): GetUserSshkeysResult

The gitlab.getUserSshkeys data source allows a list of SSH keys to be retrieved by either the user ID or username. Upstream API: GitLab REST API docs

suspend fun getUserSshkeys(argument: suspend GetUserSshkeysPlainArgsBuilder.() -> Unit): GetUserSshkeysResult
suspend fun getUserSshkeys(userId: Int? = null, username: String? = null): GetUserSshkeysResult