1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getPipelineFilters
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

harness.platform.getPipelineFilters

Explore with Pulumi AI

harness logo
Harness v0.1.1 published on Friday, Jul 12, 2024 by Pulumi

    Data source for retrieving a Harness Pipeline Filter.

    Using getPipelineFilters

    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 getPipelineFilters(args: GetPipelineFiltersArgs, opts?: InvokeOptions): Promise<GetPipelineFiltersResult>
    function getPipelineFiltersOutput(args: GetPipelineFiltersOutputArgs, opts?: InvokeOptions): Output<GetPipelineFiltersResult>
    def get_pipeline_filters(identifier: Optional[str] = None,
                             org_id: Optional[str] = None,
                             project_id: Optional[str] = None,
                             type: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPipelineFiltersResult
    def get_pipeline_filters_output(identifier: Optional[pulumi.Input[str]] = None,
                             org_id: Optional[pulumi.Input[str]] = None,
                             project_id: Optional[pulumi.Input[str]] = None,
                             type: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPipelineFiltersResult]
    func LookupPipelineFilters(ctx *Context, args *LookupPipelineFiltersArgs, opts ...InvokeOption) (*LookupPipelineFiltersResult, error)
    func LookupPipelineFiltersOutput(ctx *Context, args *LookupPipelineFiltersOutputArgs, opts ...InvokeOption) LookupPipelineFiltersResultOutput

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

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

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    Type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    Identifier string
    Unique identifier of the resource.
    Type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    identifier String
    Unique identifier of the resource.
    type String
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    identifier string
    Unique identifier of the resource.
    type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    identifier str
    Unique identifier of the resource.
    type str
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    org_id str
    Organization Identifier for the Entity.
    project_id str
    Project Identifier for the Entity.
    identifier String
    Unique identifier of the resource.
    type String
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.

    getPipelineFilters Result

    The following output properties are available:

    FilterProperties List<GetPipelineFiltersFilterProperty>
    Properties of the filter entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the Filter.
    Type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    FilterProperties []GetPipelineFiltersFilterProperty
    Properties of the filter entity defined in Harness.
    FilterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the Filter.
    Type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    OrgId string
    Organization Identifier for the Entity.
    ProjectId string
    Project Identifier for the Entity.
    filterProperties List<GetPipelineFiltersFilterProperty>
    Properties of the filter entity defined in Harness.
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the Filter.
    type String
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.
    filterProperties GetPipelineFiltersFilterProperty[]
    Properties of the filter entity defined in Harness.
    filterVisibility string
    This indicates visibility of filter. By default, everyone can view this filter.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the Filter.
    type string
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId string
    Organization Identifier for the Entity.
    projectId string
    Project Identifier for the Entity.
    filter_properties Sequence[GetPipelineFiltersFilterProperty]
    Properties of the filter entity defined in Harness.
    filter_visibility str
    This indicates visibility of filter. By default, everyone can view this filter.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the Filter.
    type str
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    org_id str
    Organization Identifier for the Entity.
    project_id str
    Project Identifier for the Entity.
    filterProperties List<Property Map>
    Properties of the filter entity defined in Harness.
    filterVisibility String
    This indicates visibility of filter. By default, everyone can view this filter.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the Filter.
    type String
    Type of filter. Currently supported types are {PipelineSetup, PipelineExecution, Deployment, Template, EnvironmentGroup, Environment}.
    orgId String
    Organization Identifier for the Entity.
    projectId String
    Project Identifier for the Entity.

    Supporting Types

    GetPipelineFiltersFilterProperty

    Description string
    description of the pipline filter.
    FilterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    ModuleProperties GetPipelineFiltersFilterPropertyModuleProperties
    module properties of the pipline filter.
    Name string
    Name of the pipeline filter.
    PipelineIdentifiers List<string>
    Pipeline identifiers to filter on.
    PipelineTags List<ImmutableDictionary<string, string>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    Tags List<string>
    Tags to associate with the resource. Tags should be in the form name:value.
    Description string
    description of the pipline filter.
    FilterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    ModuleProperties GetPipelineFiltersFilterPropertyModuleProperties
    module properties of the pipline filter.
    Name string
    Name of the pipeline filter.
    PipelineIdentifiers []string
    Pipeline identifiers to filter on.
    PipelineTags []map[string]string
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    Tags []string
    Tags to associate with the resource. Tags should be in the form name:value.
    description String
    description of the pipline filter.
    filterType String
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    moduleProperties GetPipelineFiltersFilterPropertyModuleProperties
    module properties of the pipline filter.
    name String
    Name of the pipeline filter.
    pipelineIdentifiers List<String>
    Pipeline identifiers to filter on.
    pipelineTags List<Map<String,String>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.
    description string
    description of the pipline filter.
    filterType string
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    moduleProperties GetPipelineFiltersFilterPropertyModuleProperties
    module properties of the pipline filter.
    name string
    Name of the pipeline filter.
    pipelineIdentifiers string[]
    Pipeline identifiers to filter on.
    pipelineTags {[key: string]: string}[]
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    tags string[]
    Tags to associate with the resource. Tags should be in the form name:value.
    description str
    description of the pipline filter.
    filter_type str
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    module_properties GetPipelineFiltersFilterPropertyModuleProperties
    module properties of the pipline filter.
    name str
    Name of the pipeline filter.
    pipeline_identifiers Sequence[str]
    Pipeline identifiers to filter on.
    pipeline_tags Sequence[Mapping[str, str]]
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    tags Sequence[str]
    Tags to associate with the resource. Tags should be in the form name:value.
    description String
    description of the pipline filter.
    filterType String
    Corresponding Entity of the filters. Currently supported types are {Connector, DelegateProfile, Delegate, PipelineSetup, PipelineExecution, Deployment, Audit, Template, EnvironmentGroup, FileStore, CCMRecommendation, Anomaly, Environment}.
    moduleProperties Property Map
    module properties of the pipline filter.
    name String
    Name of the pipeline filter.
    pipelineIdentifiers List<String>
    Pipeline identifiers to filter on.
    pipelineTags List<Map<String>>
    Tags to associate with the pipeline. tags should be in the form of {key:key1, value:key1value}
    tags List<String>
    Tags to associate with the resource. Tags should be in the form name:value.

    GetPipelineFiltersFilterPropertyModuleProperties

    Cd GetPipelineFiltersFilterPropertyModulePropertiesCd
    CD related properties to be filtered on.
    Ci GetPipelineFiltersFilterPropertyModulePropertiesCi
    CI related properties to be filtered on.
    Cd GetPipelineFiltersFilterPropertyModulePropertiesCd
    CD related properties to be filtered on.
    Ci GetPipelineFiltersFilterPropertyModulePropertiesCi
    CI related properties to be filtered on.
    cd GetPipelineFiltersFilterPropertyModulePropertiesCd
    CD related properties to be filtered on.
    ci GetPipelineFiltersFilterPropertyModulePropertiesCi
    CI related properties to be filtered on.
    cd GetPipelineFiltersFilterPropertyModulePropertiesCd
    CD related properties to be filtered on.
    ci GetPipelineFiltersFilterPropertyModulePropertiesCi
    CI related properties to be filtered on.
    cd GetPipelineFiltersFilterPropertyModulePropertiesCd
    CD related properties to be filtered on.
    ci GetPipelineFiltersFilterPropertyModulePropertiesCi
    CI related properties to be filtered on.
    cd Property Map
    CD related properties to be filtered on.
    ci Property Map
    CI related properties to be filtered on.

    GetPipelineFiltersFilterPropertyModulePropertiesCd

    ArtifactDisplayNames List<string>
    Artifact display names of the CD pipeline.
    DeploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    EnvironmentNames List<string>
    Environment names of the CD pipeline.
    ServiceNames List<string>
    Service names of the CD pipeline.
    ArtifactDisplayNames []string
    Artifact display names of the CD pipeline.
    DeploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    EnvironmentNames []string
    Environment names of the CD pipeline.
    ServiceNames []string
    Service names of the CD pipeline.
    artifactDisplayNames List<String>
    Artifact display names of the CD pipeline.
    deploymentTypes String
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames List<String>
    Environment names of the CD pipeline.
    serviceNames List<String>
    Service names of the CD pipeline.
    artifactDisplayNames string[]
    Artifact display names of the CD pipeline.
    deploymentTypes string
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames string[]
    Environment names of the CD pipeline.
    serviceNames string[]
    Service names of the CD pipeline.
    artifact_display_names Sequence[str]
    Artifact display names of the CD pipeline.
    deployment_types str
    Deployment type of the CD pipeline, eg. Kubernetes
    environment_names Sequence[str]
    Environment names of the CD pipeline.
    service_names Sequence[str]
    Service names of the CD pipeline.
    artifactDisplayNames List<String>
    Artifact display names of the CD pipeline.
    deploymentTypes String
    Deployment type of the CD pipeline, eg. Kubernetes
    environmentNames List<String>
    Environment names of the CD pipeline.
    serviceNames List<String>
    Service names of the CD pipeline.

    GetPipelineFiltersFilterPropertyModulePropertiesCi

    Branch string
    Branch which was used while building.
    BuildType string
    Build type of the pipeline. Possible values: branch.
    CiExecutionInfo GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    RepoNames string
    name of the repository used in the pipeline.
    Tag string
    Tags to associate with the CI pipeline resource.
    Branch string
    Branch which was used while building.
    BuildType string
    Build type of the pipeline. Possible values: branch.
    CiExecutionInfo GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    RepoNames string
    name of the repository used in the pipeline.
    Tag string
    Tags to associate with the CI pipeline resource.
    branch String
    Branch which was used while building.
    buildType String
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repoNames String
    name of the repository used in the pipeline.
    tag String
    Tags to associate with the CI pipeline resource.
    branch string
    Branch which was used while building.
    buildType string
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repoNames string
    name of the repository used in the pipeline.
    tag string
    Tags to associate with the CI pipeline resource.
    branch str
    Branch which was used while building.
    build_type str
    Build type of the pipeline. Possible values: branch.
    ci_execution_info GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo
    CI execution info for the pipeline.
    repo_names str
    name of the repository used in the pipeline.
    tag str
    Tags to associate with the CI pipeline resource.
    branch String
    Branch which was used while building.
    buildType String
    Build type of the pipeline. Possible values: branch.
    ciExecutionInfo Property Map
    CI execution info for the pipeline.
    repoNames String
    name of the repository used in the pipeline.
    tag String
    Tags to associate with the CI pipeline resource.

    GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfo

    Event string
    Event for the ci execution, Possible values: pullRequest.
    PullRequest GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    Event string
    Event for the ci execution, Possible values: pullRequest.
    PullRequest GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event String
    Event for the ci execution, Possible values: pullRequest.
    pullRequest GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event string
    Event for the ci execution, Possible values: pullRequest.
    pullRequest GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event str
    Event for the ci execution, Possible values: pullRequest.
    pull_request GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest
    The pull request details of the CI pipeline.
    event String
    Event for the ci execution, Possible values: pullRequest.
    pullRequest Property Map
    The pull request details of the CI pipeline.

    GetPipelineFiltersFilterPropertyModulePropertiesCiCiExecutionInfoPullRequest

    SourceBranch string
    Source branch of the pull request.
    TargetBranch string
    Target branch of the pull request.
    SourceBranch string
    Source branch of the pull request.
    TargetBranch string
    Target branch of the pull request.
    sourceBranch String
    Source branch of the pull request.
    targetBranch String
    Target branch of the pull request.
    sourceBranch string
    Source branch of the pull request.
    targetBranch string
    Target branch of the pull request.
    source_branch str
    Source branch of the pull request.
    target_branch str
    Target branch of the pull request.
    sourceBranch String
    Source branch of the pull request.
    targetBranch String
    Target branch of the pull request.

    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.1.1 published on Friday, Jul 12, 2024 by Pulumi