GitlabFunctions

Functions

Link copied to clipboard

The gitlab.Application data source retrieves information about a gitlab application. Upstream API: GitLab REST API docs

Link copied to clipboard

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

The gitlab.ClusterAgent data source allows to retrieve details about a GitLab Agent for Kubernetes. Upstream API: GitLab REST API docs

suspend fun getClusterAgent(agentId: Int, project: String): GetClusterAgentResult
Link copied to clipboard

The gitlab.getClusterAgents data source allows details of GitLab Agents for Kubernetes in a project. Upstream API: GitLab REST API docs

Link copied to clipboard

The gitlab.ComplianceFramework data source allows details of a compliance framework to be retrieved by its name and the namespace it belongs to. Upstream API: GitLab GraphQL API docs

Link copied to clipboard

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

The gitlab_access_tokens data source allows to retrieve all group-level access tokens. Upstream API: GitLab REST API docs

Link copied to clipboard

The gitlab.getGroupBillableMemberMemberships data source allows (sub)group- and project-memberships of a billable member of a group to be retrieved by either the user ID, username or email address.

Link copied to clipboard

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

suspend fun getGroupHook(group: String, hookId: Int): GetGroupHookResult
Link copied to clipboard

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

Link copied to clipboard

The gitlab.getGroupIds data source identification information for a given group, allowing a user to translate a full path or ID into the GraphQL ID of the group. Upstream API: GitLab GraphQL API docs

suspend fun getGroupIds(group: String): GetGroupIdsResult
suspend fun getGroupIds(argument: suspend GetGroupIdsPlainArgsBuilder.() -> Unit): GetGroupIdsResult
Link copied to clipboard

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(accessLevel: String? = null, fullPath: String? = null, groupId: Int? = null, inherited: Boolean? = null): GetGroupMembershipResult
Link copied to clipboard

The gitlab.getGroupProvisionedUsers data source allows details of the provisioned users of a given group. Upstream API: GitLab REST API docs

suspend fun getGroupProvisionedUsers(active: Boolean? = null, blocked: Boolean? = null, createdAfter: String? = null, createdBefore: String? = null, id: String, provisionedUsers: List<GetGroupProvisionedUsersProvisionedUser>? = null, search: String? = null, username: String? = null): GetGroupProvisionedUsersResult
Link copied to clipboard

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, topLevelOnly: Boolean? = null): GetGroupsResult
Link copied to clipboard

The gitlab.GroupServiceAccount data source retrieves information about a gitlab service account for a group. Upstream API: GitLab REST API docs

suspend fun getGroupServiceAccount(group: String, serviceAccountId: String): GetGroupServiceAccountResult
Link copied to clipboard

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

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

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(environmentScope: String? = null, group: String, key: String): GetGroupVariableResult
Link copied to clipboard

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

suspend fun getGroupVariables(environmentScope: String? = null, group: String): GetGroupVariablesResult
Link copied to clipboard

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

Link copied to clipboard

The gitlab.InstanceServiceAccount data source retrieves information about a gitlab service account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The gitlab.getMetadata data source retrieves the metadata of the GitLab instance. Upstream API: GitLab REST API docs

Link copied to clipboard

The gitlab.PipelineSchedule data source retrieves information about a gitlab pipeline schedule for a project. Upstream API: GitLab REST API docs

suspend fun getPipelineSchedule(cronTimezone: String? = null, pipelineScheduleId: Int, project: String): GetPipelineScheduleResult
Link copied to clipboard

The gitlab.PipelineSchedule data source retrieves information about a gitlab pipeline schedule for a project. Upstream API: GitLab REST API docs

Link copied to clipboard

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

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

Link copied to clipboard

The gitlab.getProjectEnvironments data source retrieves information about all environments of the given project. Upstream API: GitLab REST API docs

suspend fun getProjectEnvironments(name: String? = null, project: String, search: String? = null, states: String? = null): GetProjectEnvironmentsResult
Link copied to clipboard

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

suspend fun getProjectHook(hookId: Int, project: String): GetProjectHookResult
Link copied to clipboard

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

Link copied to clipboard

The gitlab.getProjectIds data source identification information for a given project, allowing a user to translate a full path or ID into the GraphQL ID of the project. Upstream API: GitLab GraphQL API docs

Link copied to clipboard

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

suspend fun getProjectIssue(iid: Int, project: String): GetProjectIssueResult
Link copied to clipboard

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

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

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(fullPath: String? = null, inherited: Boolean? = null, projectId: Int? = null, query: String? = null, userIds: List<Int>? = null): GetProjectMembershipResult
Link copied to clipboard

The gitlab.getProjectMergeRequest data source retrieves information about a single merge request related to a specific project. Upstream API: GitLab REST API docs

Link copied to clipboard

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

suspend fun getProjectMilestone(milestoneId: Int, project: String): GetProjectMilestoneResult
Link copied to clipboard

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

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

The gitlab.getProjectMirrorPublicKey data source allows the public key of a project mirror to be retrieved by its mirror id and the project it belongs to. Note: Supported on GitLab 17.9 or higher. Upstream API: GitLab REST API docs

Link copied to clipboard

The gitlab.getProjectProtectedBranch 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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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, topics: List<String>? = null, visibility: String? = null, withCustomAttributes: Boolean? = null, withIssuesEnabled: Boolean? = null, withMergeRequestsEnabled: Boolean? = null, withProgrammingLanguage: String? = null, withShared: Boolean? = null): GetProjectsResult
Link copied to clipboard

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(name: String, project: String): GetProjectTagResult
Link copied to clipboard

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(orderBy: String? = null, project: String, search: String? = null, sort: String? = null): GetProjectTagsResult
Link copied to clipboard

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(environmentScope: String? = null, key: String, project: String): GetProjectVariableResult
Link copied to clipboard

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

suspend fun getProjectVariables(environmentScope: String? = null, project: String): GetProjectVariablesResult
Link copied to clipboard

The gitlab.Release data source retrieves information about a gitlab release for a project. Upstream API: GitLab REST API docs

suspend fun getRelease(argument: suspend GetReleasePlainArgsBuilder.() -> Unit): GetReleaseResult
suspend fun getRelease(assets: GetReleaseAssets? = null, projectId: String, tagName: String): GetReleaseResult
Link copied to clipboard

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

suspend fun getReleaseLink(linkId: Int, project: String, tagName: String): GetReleaseLinkResult
Link copied to clipboard

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

suspend fun getReleaseLinks(project: String, tagName: String): GetReleaseLinksResult
Link copied to clipboard

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(filePath: String, project: String, ref: String): GetRepositoryFileResult
Link copied to clipboard

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(path: String? = null, project: String, recursive: Boolean? = null, ref: String): GetRepositoryTreeResult
Link copied to clipboard

The gitlab.getRunners data source retrieves information about all gitlab runners. Upstream API: GitLab REST API docs

suspend fun getRunners(argument: suspend GetRunnersPlainArgsBuilder.() -> Unit): GetRunnersResult
suspend fun getRunners(paused: Boolean? = null, status: String? = null, tagLists: List<String>? = null, type: String? = null): GetRunnersResult
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, excludeExternal: Boolean? = null, excludeInternal: Boolean? = null, externProvider: String? = null, externUid: String? = null, external: Boolean? = null, orderBy: String? = null, search: String? = null, sort: String? = null, username: String? = null, withoutProjectBots: Boolean? = null): GetUsersResult
Link copied to clipboard

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(userId: Int? = null, username: String? = null): GetUserSshkeysResult