GitLab v8.10.0, Mar 21 25

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

gitlab.getRunners

Explore with Pulumi AI

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

Example Usage

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

const thisUserRunner = new gitlab.UserRunner("this", {
    runnerType: "instance_type",
    tagLists: [
        "tag1",
        "tag2",
    ],
});
const _this = gitlab.getRunners({
    paused: false,
    status: "online",
    tagLists: [
        "tag1",
        "tag2",
    ],
    type: "instance_type",
});

import pulumi
import pulumi_gitlab as gitlab

this_user_runner = gitlab.UserRunner("this",
    runner_type="instance_type",
    tag_lists=[
        "tag1",
        "tag2",
    ])
this = gitlab.get_runners(paused=False,
    status="online",
    tag_lists=[
        "tag1",
        "tag2",
    ],
    type="instance_type")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gitlab.NewUserRunner(ctx, "this", &gitlab.UserRunnerArgs{
			RunnerType: pulumi.String("instance_type"),
			TagLists: pulumi.StringArray{
				pulumi.String("tag1"),
				pulumi.String("tag2"),
			},
		})
		if err != nil {
			return err
		}
		_, err = gitlab.GetRunners(ctx, &gitlab.GetRunnersArgs{
			Paused: pulumi.BoolRef(false),
			Status: pulumi.StringRef("online"),
			TagLists: []string{
				"tag1",
				"tag2",
			},
			Type: pulumi.StringRef("instance_type"),
		}, 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 thisUserRunner = new GitLab.UserRunner("this", new()
    {
        RunnerType = "instance_type",
        TagLists = new[]
        {
            "tag1",
            "tag2",
        },
    });

    var @this = GitLab.GetRunners.Invoke(new()
    {
        Paused = false,
        Status = "online",
        TagLists = new[]
        {
            "tag1",
            "tag2",
        },
        Type = "instance_type",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gitlab.UserRunner;
import com.pulumi.gitlab.UserRunnerArgs;
import com.pulumi.gitlab.GitlabFunctions;
import com.pulumi.gitlab.inputs.GetRunnersArgs;
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) {
        var thisUserRunner = new UserRunner("thisUserRunner", UserRunnerArgs.builder()
            .runnerType("instance_type")
            .tagLists(            
                "tag1",
                "tag2")
            .build());

        final var this = GitlabFunctions.getRunners(GetRunnersArgs.builder()
            .paused(false)
            .status("online")
            .tagLists(            
                "tag1",
                "tag2")
            .type("instance_type")
            .build());

    }
}

resources:
  thisUserRunner:
    type: gitlab:UserRunner
    name: this
    properties:
      runnerType: instance_type
      tagLists:
        - tag1
        - tag2
variables:
  this:
    fn::invoke:
      function: gitlab:getRunners
      arguments:
        paused: false
        status: online
        tagLists:
          - tag1
          - tag2
        type: instance_type

Using getRunners

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 getRunners(args: GetRunnersArgs, opts?: InvokeOptions): Promise<GetRunnersResult>
function getRunnersOutput(args: GetRunnersOutputArgs, opts?: InvokeOptions): Output<GetRunnersResult>

def get_runners(paused: Optional[bool] = None,
                status: Optional[str] = None,
                tag_lists: Optional[Sequence[str]] = None,
                type: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRunnersResult
def get_runners_output(paused: Optional[pulumi.Input[bool]] = None,
                status: Optional[pulumi.Input[str]] = None,
                tag_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                type: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRunnersResult]

func GetRunners(ctx *Context, args *GetRunnersArgs, opts ...InvokeOption) (*GetRunnersResult, error)
func GetRunnersOutput(ctx *Context, args *GetRunnersOutputArgs, opts ...InvokeOption) GetRunnersResultOutput

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

public static class GetRunners 
{
    public static Task<GetRunnersResult> InvokeAsync(GetRunnersArgs args, InvokeOptions? opts = null)
    public static Output<GetRunnersResult> Invoke(GetRunnersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRunnersResult> getRunners(GetRunnersArgs args, InvokeOptions options)
public static Output<GetRunnersResult> getRunners(GetRunnersArgs args, InvokeOptions options)

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

The following arguments are supported:

Paused bool: Filters for runners with the given paused value
Status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
TagLists List<string>: Filters for runners with all of the given tags
Type string: The type of runner to return. Valid values are instance_type, group_type and project_type

Paused bool: Filters for runners with the given paused value
Status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
TagLists []string: Filters for runners with all of the given tags
Type string: The type of runner to return. Valid values are instance_type, group_type and project_type

paused Boolean: Filters for runners with the given paused value
status String: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists List<String>: Filters for runners with all of the given tags
type String: The type of runner to return. Valid values are instance_type, group_type and project_type

paused boolean: Filters for runners with the given paused value
status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists string[]: Filters for runners with all of the given tags
type string: The type of runner to return. Valid values are instance_type, group_type and project_type

paused bool: Filters for runners with the given paused value
status str: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tag_lists Sequence[str]: Filters for runners with all of the given tags
type str: The type of runner to return. Valid values are instance_type, group_type and project_type

paused Boolean: Filters for runners with the given paused value
status String: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists List<String>: Filters for runners with all of the given tags
type String: The type of runner to return. Valid values are instance_type, group_type and project_type

getRunners Result

The following output properties are available:

Id string
Runners List<Pulumi.GitLab.Outputs.GetRunnersRunner>: The list of runners.
Paused bool: Filters for runners with the given paused value
Status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
TagLists List<string>: Filters for runners with all of the given tags
Type string: The type of runner to return. Valid values are instance_type, group_type and project_type

Id string
Runners []GetRunnersRunner: The list of runners.
Paused bool: Filters for runners with the given paused value
Status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
TagLists []string: Filters for runners with all of the given tags
Type string: The type of runner to return. Valid values are instance_type, group_type and project_type

id String
runners List<GetRunnersRunner>: The list of runners.
paused Boolean: Filters for runners with the given paused value
status String: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists List<String>: Filters for runners with all of the given tags
type String: The type of runner to return. Valid values are instance_type, group_type and project_type

id string
runners GetRunnersRunner[]: The list of runners.
paused boolean: Filters for runners with the given paused value
status string: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists string[]: Filters for runners with all of the given tags
type string: The type of runner to return. Valid values are instance_type, group_type and project_type

id str
runners Sequence[GetRunnersRunner]: The list of runners.
paused bool: Filters for runners with the given paused value
status str: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tag_lists Sequence[str]: Filters for runners with all of the given tags
type str: The type of runner to return. Valid values are instance_type, group_type and project_type

id String
runners List<Property Map>: The list of runners.
paused Boolean: Filters for runners with the given paused value
status String: Filters for runners with the given status. Valid Values are online, offline, stale, and never_contacted.
tagLists List<String>: Filters for runners with all of the given tags
type String: The type of runner to return. Valid values are instance_type, group_type and project_type

Supporting Types

GetRunnersRunner

Description string: The description of the runner.
Id int: The runner id.
IsShared bool: Indicates if this is a shared runner
Online bool: The connectivity status of the runner.
Paused bool: Indicates if the runner is accepting or ignoring new jobs.
RunnerType string: The runner type. Values are instance_type, group_type and project_type.
Status string: The status of the runner. Values can be online, offline, stale, and never_contacted.

Description string: The description of the runner.
Id int: The runner id.
IsShared bool: Indicates if this is a shared runner
Online bool: The connectivity status of the runner.
Paused bool: Indicates if the runner is accepting or ignoring new jobs.
RunnerType string: The runner type. Values are instance_type, group_type and project_type.
Status string: The status of the runner. Values can be online, offline, stale, and never_contacted.

description String: The description of the runner.
id Integer: The runner id.
isShared Boolean: Indicates if this is a shared runner
online Boolean: The connectivity status of the runner.
paused Boolean: Indicates if the runner is accepting or ignoring new jobs.
runnerType String: The runner type. Values are instance_type, group_type and project_type.
status String: The status of the runner. Values can be online, offline, stale, and never_contacted.

description string: The description of the runner.
id number: The runner id.
isShared boolean: Indicates if this is a shared runner
online boolean: The connectivity status of the runner.
paused boolean: Indicates if the runner is accepting or ignoring new jobs.
runnerType string: The runner type. Values are instance_type, group_type and project_type.
status string: The status of the runner. Values can be online, offline, stale, and never_contacted.

description str: The description of the runner.
id int: The runner id.
is_shared bool: Indicates if this is a shared runner
online bool: The connectivity status of the runner.
paused bool: Indicates if the runner is accepting or ignoring new jobs.
runner_type str: The runner type. Values are instance_type, group_type and project_type.
status str: The status of the runner. Values can be online, offline, stale, and never_contacted.

description String: The description of the runner.
id Number: The runner id.
isShared Boolean: Indicates if this is a shared runner
online Boolean: The connectivity status of the runner.
paused Boolean: Indicates if the runner is accepting or ignoring new jobs.
runnerType String: The runner type. Values are instance_type, group_type and project_type.
status String: The status of the runner. Values can be online, offline, stale, and never_contacted.

Package Details

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

GitLab v8.10.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-gitlab

gitlab.getRunners

On this page

On this page

Example Usage

Using getRunners

getRunners Result

Supporting Types

GetRunnersRunner

Package Details

On this page

On this page