1. Packages
  2. Harness Provider
  3. API Docs
  4. platform
  5. getPipelineList
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

harness.platform.getPipelineList

Explore with Pulumi AI

harness logo
Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi

    Data source for retrieving a Harness pipeline list.

    Example Usage

    Without the Pagination

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getPipelineList({
        orgId: "org_id",
        projectId: "project_id",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_pipeline_list(org_id="org_id",
        project_id="project_id")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.GetPipelineList(ctx, &platform.GetPipelineListArgs{
    			OrgId:     "org_id",
    			ProjectId: "project_id",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetPipelineList.Invoke(new()
        {
            OrgId = "org_id",
            ProjectId = "project_id",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetPipelineListArgs;
    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 = PlatformFunctions.getPipelineList(GetPipelineListArgs.builder()
                .orgId("org_id")
                .projectId("project_id")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getPipelineList
          Arguments:
            orgId: org_id
            projectId: project_id
    

    With Pagination Logic

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const example = harness.platform.getPipelineList({
        orgId: "org_id",
        projectId: "project_id",
        page: 1,
        limit: 4,
    });
    
    import pulumi
    import pulumi_harness as harness
    
    example = harness.platform.get_pipeline_list(org_id="org_id",
        project_id="project_id",
        page=1,
        limit=4)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.GetPipelineList(ctx, &platform.GetPipelineListArgs{
    			OrgId:     "org_id",
    			ProjectId: "project_id",
    			Page:      pulumi.IntRef(1),
    			Limit:     pulumi.IntRef(4),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Harness.Platform.GetPipelineList.Invoke(new()
        {
            OrgId = "org_id",
            ProjectId = "project_id",
            Page = 1,
            Limit = 4,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetPipelineListArgs;
    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 = PlatformFunctions.getPipelineList(GetPipelineListArgs.builder()
                .orgId("org_id")
                .projectId("project_id")
                .page(1)
                .limit(4)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: harness:platform:getPipelineList
          Arguments:
            orgId: org_id
            projectId: project_id
            page: 1
            limit: 4
    

    Using getPipelineList

    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 getPipelineList(args: GetPipelineListArgs, opts?: InvokeOptions): Promise<GetPipelineListResult>
    function getPipelineListOutput(args: GetPipelineListOutputArgs, opts?: InvokeOptions): Output<GetPipelineListResult>
    def get_pipeline_list(identifier: Optional[str] = None,
                          limit: Optional[int] = None,
                          name: Optional[str] = None,
                          org_id: Optional[str] = None,
                          page: Optional[int] = None,
                          project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPipelineListResult
    def get_pipeline_list_output(identifier: Optional[pulumi.Input[str]] = None,
                          limit: Optional[pulumi.Input[int]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          org_id: Optional[pulumi.Input[str]] = None,
                          page: Optional[pulumi.Input[int]] = None,
                          project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPipelineListResult]
    func GetPipelineList(ctx *Context, args *GetPipelineListArgs, opts ...InvokeOption) (*GetPipelineListResult, error)
    func GetPipelineListOutput(ctx *Context, args *GetPipelineListOutputArgs, opts ...InvokeOption) GetPipelineListResultOutput

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

    public static class GetPipelineList 
    {
        public static Task<GetPipelineListResult> InvokeAsync(GetPipelineListArgs args, InvokeOptions? opts = null)
        public static Output<GetPipelineListResult> Invoke(GetPipelineListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPipelineListResult> getPipelineList(GetPipelineListArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getPipelineList:getPipelineList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    Name string
    Page int
    Optional pagination parameter indicating the page number when retrieving entities.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    Name string
    Page int
    Optional pagination parameter indicating the page number when retrieving entities.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier String
    limit Integer
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name String
    page Integer
    Optional pagination parameter indicating the page number when retrieving entities.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    identifier string
    limit number
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name string
    page number
    Optional pagination parameter indicating the page number when retrieving entities.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    identifier str
    limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name str
    page int
    Optional pagination parameter indicating the page number when retrieving entities.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier String
    limit Number
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name String
    page Number
    Optional pagination parameter indicating the page number when retrieving entities.

    getPipelineList Result

    The following output properties are available:

    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Unique identifier of the organization.
    Pipelines List<GetPipelineListPipeline>
    Containing list of all pipeline with details identifier and name.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Identifier string
    Limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    Name string
    Page int
    Optional pagination parameter indicating the page number when retrieving entities.
    Description string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Unique identifier of the organization.
    Pipelines []GetPipelineListPipeline
    Containing list of all pipeline with details identifier and name.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Identifier string
    Limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    Name string
    Page int
    Optional pagination parameter indicating the page number when retrieving entities.
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    Unique identifier of the organization.
    pipelines List<GetPipelineListPipeline>
    Containing list of all pipeline with details identifier and name.
    projectId String
    Unique identifier of the project.
    tags List<String>
    identifier String
    limit Integer
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name String
    page Integer
    Optional pagination parameter indicating the page number when retrieving entities.
    description string
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    Unique identifier of the organization.
    pipelines GetPipelineListPipeline[]
    Containing list of all pipeline with details identifier and name.
    projectId string
    Unique identifier of the project.
    tags string[]
    identifier string
    limit number
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name string
    page number
    Optional pagination parameter indicating the page number when retrieving entities.
    description str
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    Unique identifier of the organization.
    pipelines Sequence[GetPipelineListPipeline]
    Containing list of all pipeline with details identifier and name.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    identifier str
    limit int
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name str
    page int
    Optional pagination parameter indicating the page number when retrieving entities.
    description String
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    Unique identifier of the organization.
    pipelines List<Property Map>
    Containing list of all pipeline with details identifier and name.
    projectId String
    Unique identifier of the project.
    tags List<String>
    identifier String
    limit Number
    Optional pagination parameter indicating the maximum number of entities to retrieve per page.
    name String
    page Number
    Optional pagination parameter indicating the page number when retrieving entities.

    Supporting Types

    GetPipelineListPipeline

    Identifier string
    Name string
    Identifier string
    Name string
    identifier String
    name String
    identifier string
    name string
    identifier String
    name String

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.4.4 published on Tuesday, Nov 12, 2024 by Pulumi