1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getMetadata
GitLab v8.4.1 published on Tuesday, Sep 24, 2024 by Pulumi

gitlab.getMetadata

Explore with Pulumi AI

gitlab logo
GitLab v8.4.1 published on Tuesday, Sep 24, 2024 by Pulumi

    The gitlab.getMetadata data source retrieves the metadata of the GitLab instance.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const this = gitlab.getMetadata({});
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    this = gitlab.get_metadata()
    
    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.GetMetadata(ctx, nil, 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 @this = GitLab.GetMetadata.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gitlab.GitlabFunctions;
    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) {
            final var this = GitlabFunctions.getMetadata();
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          Function: gitlab:getMetadata
          Arguments: {}
    

    Using getMetadata

    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 getMetadata(opts?: InvokeOptions): Promise<GetMetadataResult>
    function getMetadataOutput(opts?: InvokeOptions): Output<GetMetadataResult>
    def get_metadata(opts: Optional[InvokeOptions] = None) -> GetMetadataResult
    def get_metadata_output(opts: Optional[InvokeOptions] = None) -> Output[GetMetadataResult]
    func GetMetadata(ctx *Context, opts ...InvokeOption) (*GetMetadataResult, error)
    func GetMetadataOutput(ctx *Context, opts ...InvokeOption) GetMetadataResultOutput

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

    public static class GetMetadata 
    {
        public static Task<GetMetadataResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetMetadataResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMetadataResult> getMetadata(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gitlab:index/getMetadata:getMetadata
      arguments:
        # arguments dictionary

    getMetadata Result

    The following output properties are available:

    Enterprise bool
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    Id string
    The id of the data source. It will always be 1
    Kas Pulumi.GitLab.Outputs.GetMetadataKas
    Metadata about the GitLab agent server for Kubernetes (KAS).
    Revision string
    Revision of the GitLab instance.
    Version string
    Version of the GitLab instance.
    Enterprise bool
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    Id string
    The id of the data source. It will always be 1
    Kas GetMetadataKas
    Metadata about the GitLab agent server for Kubernetes (KAS).
    Revision string
    Revision of the GitLab instance.
    Version string
    Version of the GitLab instance.
    enterprise Boolean
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    id String
    The id of the data source. It will always be 1
    kas GetMetadataKas
    Metadata about the GitLab agent server for Kubernetes (KAS).
    revision String
    Revision of the GitLab instance.
    version String
    Version of the GitLab instance.
    enterprise boolean
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    id string
    The id of the data source. It will always be 1
    kas GetMetadataKas
    Metadata about the GitLab agent server for Kubernetes (KAS).
    revision string
    Revision of the GitLab instance.
    version string
    Version of the GitLab instance.
    enterprise bool
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    id str
    The id of the data source. It will always be 1
    kas GetMetadataKas
    Metadata about the GitLab agent server for Kubernetes (KAS).
    revision str
    Revision of the GitLab instance.
    version str
    Version of the GitLab instance.
    enterprise Boolean
    If the GitLab instance is an enterprise instance or not. Supported for GitLab 15.6 onwards.
    id String
    The id of the data source. It will always be 1
    kas Property Map
    Metadata about the GitLab agent server for Kubernetes (KAS).
    revision String
    Revision of the GitLab instance.
    version String
    Version of the GitLab instance.

    Supporting Types

    GetMetadataKas

    Enabled bool
    Indicates whether KAS is enabled.
    ExternalUrl string
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    Version string
    Version of KAS. It’s null if kas.enabled is false.
    Enabled bool
    Indicates whether KAS is enabled.
    ExternalUrl string
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    Version string
    Version of KAS. It’s null if kas.enabled is false.
    enabled Boolean
    Indicates whether KAS is enabled.
    externalUrl String
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    version String
    Version of KAS. It’s null if kas.enabled is false.
    enabled boolean
    Indicates whether KAS is enabled.
    externalUrl string
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    version string
    Version of KAS. It’s null if kas.enabled is false.
    enabled bool
    Indicates whether KAS is enabled.
    external_url str
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    version str
    Version of KAS. It’s null if kas.enabled is false.
    enabled Boolean
    Indicates whether KAS is enabled.
    externalUrl String
    URL used by the agents to communicate with KAS. It’s null if kas.enabled is false.
    version String
    Version of KAS. It’s null if kas.enabled is false.

    Package Details

    Repository
    GitLab pulumi/pulumi-gitlab
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the gitlab Terraform Provider.
    gitlab logo
    GitLab v8.4.1 published on Tuesday, Sep 24, 2024 by Pulumi