1. Packages
  2. Gitlab Provider
  3. API Docs
  4. getProjectHooks
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi

gitlab.getProjectHooks

Explore with Pulumi AI

gitlab logo
GitLab v8.5.0 published on Friday, Oct 18, 2024 by Pulumi

    The gitlab.getProjectHooks data source allows to retrieve details about hooks in a project.

    Upstream API: GitLab REST API docs

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gitlab from "@pulumi/gitlab";
    
    const example = gitlab.getProject({
        id: "foo/bar/baz",
    });
    const examples = example.then(example => gitlab.getProjectHooks({
        project: example.id,
    }));
    
    import pulumi
    import pulumi_gitlab as gitlab
    
    example = gitlab.get_project(id="foo/bar/baz")
    examples = gitlab.get_project_hooks(project=example.id)
    
    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 {
    		example, err := gitlab.LookupProject(ctx, &gitlab.LookupProjectArgs{
    			Id: pulumi.StringRef("foo/bar/baz"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = gitlab.GetProjectHooks(ctx, &gitlab.GetProjectHooksArgs{
    			Project: example.Id,
    		}, 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 example = GitLab.GetProject.Invoke(new()
        {
            Id = "foo/bar/baz",
        });
    
        var examples = GitLab.GetProjectHooks.Invoke(new()
        {
            Project = example.Apply(getProjectResult => getProjectResult.Id),
        });
    
    });
    
    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.GetProjectArgs;
    import com.pulumi.gitlab.inputs.GetProjectHooksArgs;
    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 example = GitlabFunctions.getProject(GetProjectArgs.builder()
                .id("foo/bar/baz")
                .build());
    
            final var examples = GitlabFunctions.getProjectHooks(GetProjectHooksArgs.builder()
                .project(example.applyValue(getProjectResult -> getProjectResult.id()))
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: gitlab:getProject
          Arguments:
            id: foo/bar/baz
      examples:
        fn::invoke:
          Function: gitlab:getProjectHooks
          Arguments:
            project: ${example.id}
    

    Using getProjectHooks

    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 getProjectHooks(args: GetProjectHooksArgs, opts?: InvokeOptions): Promise<GetProjectHooksResult>
    function getProjectHooksOutput(args: GetProjectHooksOutputArgs, opts?: InvokeOptions): Output<GetProjectHooksResult>
    def get_project_hooks(project: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetProjectHooksResult
    def get_project_hooks_output(project: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetProjectHooksResult]
    func GetProjectHooks(ctx *Context, args *GetProjectHooksArgs, opts ...InvokeOption) (*GetProjectHooksResult, error)
    func GetProjectHooksOutput(ctx *Context, args *GetProjectHooksOutputArgs, opts ...InvokeOption) GetProjectHooksResultOutput

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

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

    The following arguments are supported:

    Project string
    The name or id of the project.
    Project string
    The name or id of the project.
    project String
    The name or id of the project.
    project string
    The name or id of the project.
    project str
    The name or id of the project.
    project String
    The name or id of the project.

    getProjectHooks Result

    The following output properties are available:

    Hooks List<Pulumi.GitLab.Outputs.GetProjectHooksHook>
    The list of hooks.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The name or id of the project.
    Hooks []GetProjectHooksHook
    The list of hooks.
    Id string
    The provider-assigned unique ID for this managed resource.
    Project string
    The name or id of the project.
    hooks List<GetProjectHooksHook>
    The list of hooks.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The name or id of the project.
    hooks GetProjectHooksHook[]
    The list of hooks.
    id string
    The provider-assigned unique ID for this managed resource.
    project string
    The name or id of the project.
    hooks Sequence[GetProjectHooksHook]
    The list of hooks.
    id str
    The provider-assigned unique ID for this managed resource.
    project str
    The name or id of the project.
    hooks List<Property Map>
    The list of hooks.
    id String
    The provider-assigned unique ID for this managed resource.
    project String
    The name or id of the project.

    Supporting Types

    GetProjectHooksHook

    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential notes events.
    CustomWebhookTemplate string
    Set a custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    EnableSslVerification bool
    Enable ssl verification when invoking the hook.
    HookId int
    The id of the project hook.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests.
    NoteEvents bool
    Invoke the hook for notes events.
    PipelineEvents bool
    Invoke the hook for pipeline events.
    Project string
    The name or id of the project to add the hook to.
    ProjectId int
    The id of the project for the hook.
    PushEvents bool
    Invoke the hook for push events.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for releases events.
    TagPushEvents bool
    Invoke the hook for tag push events.
    Token string
    A token to present when invoking the hook. The token is not available for imported resources.
    Url string
    The url of the hook to invoke.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    ConfidentialIssuesEvents bool
    Invoke the hook for confidential issues events.
    ConfidentialNoteEvents bool
    Invoke the hook for confidential notes events.
    CustomWebhookTemplate string
    Set a custom webhook template.
    DeploymentEvents bool
    Invoke the hook for deployment events.
    EnableSslVerification bool
    Enable ssl verification when invoking the hook.
    HookId int
    The id of the project hook.
    IssuesEvents bool
    Invoke the hook for issues events.
    JobEvents bool
    Invoke the hook for job events.
    MergeRequestsEvents bool
    Invoke the hook for merge requests.
    NoteEvents bool
    Invoke the hook for notes events.
    PipelineEvents bool
    Invoke the hook for pipeline events.
    Project string
    The name or id of the project to add the hook to.
    ProjectId int
    The id of the project for the hook.
    PushEvents bool
    Invoke the hook for push events.
    PushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    ReleasesEvents bool
    Invoke the hook for releases events.
    TagPushEvents bool
    Invoke the hook for tag push events.
    Token string
    A token to present when invoking the hook. The token is not available for imported resources.
    Url string
    The url of the hook to invoke.
    WikiPageEvents bool
    Invoke the hook for wiki page events.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential notes events.
    customWebhookTemplate String
    Set a custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    enableSslVerification Boolean
    Enable ssl verification when invoking the hook.
    hookId Integer
    The id of the project hook.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests.
    noteEvents Boolean
    Invoke the hook for notes events.
    pipelineEvents Boolean
    Invoke the hook for pipeline events.
    project String
    The name or id of the project to add the hook to.
    projectId Integer
    The id of the project for the hook.
    pushEvents Boolean
    Invoke the hook for push events.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for releases events.
    tagPushEvents Boolean
    Invoke the hook for tag push events.
    token String
    A token to present when invoking the hook. The token is not available for imported resources.
    url String
    The url of the hook to invoke.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.
    confidentialIssuesEvents boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents boolean
    Invoke the hook for confidential notes events.
    customWebhookTemplate string
    Set a custom webhook template.
    deploymentEvents boolean
    Invoke the hook for deployment events.
    enableSslVerification boolean
    Enable ssl verification when invoking the hook.
    hookId number
    The id of the project hook.
    issuesEvents boolean
    Invoke the hook for issues events.
    jobEvents boolean
    Invoke the hook for job events.
    mergeRequestsEvents boolean
    Invoke the hook for merge requests.
    noteEvents boolean
    Invoke the hook for notes events.
    pipelineEvents boolean
    Invoke the hook for pipeline events.
    project string
    The name or id of the project to add the hook to.
    projectId number
    The id of the project for the hook.
    pushEvents boolean
    Invoke the hook for push events.
    pushEventsBranchFilter string
    Invoke the hook for push events on matching branches only.
    releasesEvents boolean
    Invoke the hook for releases events.
    tagPushEvents boolean
    Invoke the hook for tag push events.
    token string
    A token to present when invoking the hook. The token is not available for imported resources.
    url string
    The url of the hook to invoke.
    wikiPageEvents boolean
    Invoke the hook for wiki page events.
    confidential_issues_events bool
    Invoke the hook for confidential issues events.
    confidential_note_events bool
    Invoke the hook for confidential notes events.
    custom_webhook_template str
    Set a custom webhook template.
    deployment_events bool
    Invoke the hook for deployment events.
    enable_ssl_verification bool
    Enable ssl verification when invoking the hook.
    hook_id int
    The id of the project hook.
    issues_events bool
    Invoke the hook for issues events.
    job_events bool
    Invoke the hook for job events.
    merge_requests_events bool
    Invoke the hook for merge requests.
    note_events bool
    Invoke the hook for notes events.
    pipeline_events bool
    Invoke the hook for pipeline events.
    project str
    The name or id of the project to add the hook to.
    project_id int
    The id of the project for the hook.
    push_events bool
    Invoke the hook for push events.
    push_events_branch_filter str
    Invoke the hook for push events on matching branches only.
    releases_events bool
    Invoke the hook for releases events.
    tag_push_events bool
    Invoke the hook for tag push events.
    token str
    A token to present when invoking the hook. The token is not available for imported resources.
    url str
    The url of the hook to invoke.
    wiki_page_events bool
    Invoke the hook for wiki page events.
    confidentialIssuesEvents Boolean
    Invoke the hook for confidential issues events.
    confidentialNoteEvents Boolean
    Invoke the hook for confidential notes events.
    customWebhookTemplate String
    Set a custom webhook template.
    deploymentEvents Boolean
    Invoke the hook for deployment events.
    enableSslVerification Boolean
    Enable ssl verification when invoking the hook.
    hookId Number
    The id of the project hook.
    issuesEvents Boolean
    Invoke the hook for issues events.
    jobEvents Boolean
    Invoke the hook for job events.
    mergeRequestsEvents Boolean
    Invoke the hook for merge requests.
    noteEvents Boolean
    Invoke the hook for notes events.
    pipelineEvents Boolean
    Invoke the hook for pipeline events.
    project String
    The name or id of the project to add the hook to.
    projectId Number
    The id of the project for the hook.
    pushEvents Boolean
    Invoke the hook for push events.
    pushEventsBranchFilter String
    Invoke the hook for push events on matching branches only.
    releasesEvents Boolean
    Invoke the hook for releases events.
    tagPushEvents Boolean
    Invoke the hook for tag push events.
    token String
    A token to present when invoking the hook. The token is not available for imported resources.
    url String
    The url of the hook to invoke.
    wikiPageEvents Boolean
    Invoke the hook for wiki page events.

    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.5.0 published on Friday, Oct 18, 2024 by Pulumi