1. Packages
  2. Hsdp Provider
  3. API Docs
  4. getCdlLabelDefinition
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.getCdlLabelDefinition

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Retrieve details on HSDP Clinical Data Lake (CDL) Label Definition.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const labeldef1 = hsdp.getCdlLabelDefinition({
        cdlEndpoint: "https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}",
        labelDefId: "277a5d14-86cd-4a99-92e2-7b8e898cffae",
        studyId: "a1467792-ef81-11eb-8ac2-477a9e3b09aa",
    });
    export const hsdpCdlLabelDefinition = labeldef1;
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    labeldef1 = hsdp.get_cdl_label_definition(cdl_endpoint="https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}",
        label_def_id="277a5d14-86cd-4a99-92e2-7b8e898cffae",
        study_id="a1467792-ef81-11eb-8ac2-477a9e3b09aa")
    pulumi.export("hsdpCdlLabelDefinition", labeldef1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		labeldef1, err := hsdp.LookupCdlLabelDefinition(ctx, &hsdp.LookupCdlLabelDefinitionArgs{
    			CdlEndpoint: "https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}",
    			LabelDefId:  "277a5d14-86cd-4a99-92e2-7b8e898cffae",
    			StudyId:     "a1467792-ef81-11eb-8ac2-477a9e3b09aa",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("hsdpCdlLabelDefinition", labeldef1)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var labeldef1 = Hsdp.GetCdlLabelDefinition.Invoke(new()
        {
            CdlEndpoint = "https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}",
            LabelDefId = "277a5d14-86cd-4a99-92e2-7b8e898cffae",
            StudyId = "a1467792-ef81-11eb-8ac2-477a9e3b09aa",
        });
    
        return new Dictionary<string, object?>
        {
            ["hsdpCdlLabelDefinition"] = labeldef1,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.HsdpFunctions;
    import com.pulumi.hsdp.inputs.GetCdlLabelDefinitionArgs;
    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 labeldef1 = HsdpFunctions.getCdlLabelDefinition(GetCdlLabelDefinitionArgs.builder()
                .cdlEndpoint("https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}")
                .labelDefId("277a5d14-86cd-4a99-92e2-7b8e898cffae")
                .studyId("a1467792-ef81-11eb-8ac2-477a9e3b09aa")
                .build());
    
            ctx.export("hsdpCdlLabelDefinition", labeldef1.applyValue(getCdlLabelDefinitionResult -> getCdlLabelDefinitionResult));
        }
    }
    
    variables:
      labeldef1:
        fn::invoke:
          function: hsdp:getCdlLabelDefinition
          arguments:
            cdlEndpoint: https://{{CDL-HOST}}/store/cdl/{{ORG_ID}}
            labelDefId: 277a5d14-86cd-4a99-92e2-7b8e898cffae
            studyId: a1467792-ef81-11eb-8ac2-477a9e3b09aa
    outputs:
      hsdpCdlLabelDefinition: ${labeldef1}
    

    Using getCdlLabelDefinition

    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 getCdlLabelDefinition(args: GetCdlLabelDefinitionArgs, opts?: InvokeOptions): Promise<GetCdlLabelDefinitionResult>
    function getCdlLabelDefinitionOutput(args: GetCdlLabelDefinitionOutputArgs, opts?: InvokeOptions): Output<GetCdlLabelDefinitionResult>
    def get_cdl_label_definition(cdl_endpoint: Optional[str] = None,
                                 id: Optional[str] = None,
                                 label_def_id: Optional[str] = None,
                                 study_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCdlLabelDefinitionResult
    def get_cdl_label_definition_output(cdl_endpoint: Optional[pulumi.Input[str]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 label_def_id: Optional[pulumi.Input[str]] = None,
                                 study_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCdlLabelDefinitionResult]
    func LookupCdlLabelDefinition(ctx *Context, args *LookupCdlLabelDefinitionArgs, opts ...InvokeOption) (*LookupCdlLabelDefinitionResult, error)
    func LookupCdlLabelDefinitionOutput(ctx *Context, args *LookupCdlLabelDefinitionOutputArgs, opts ...InvokeOption) LookupCdlLabelDefinitionResultOutput

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

    public static class GetCdlLabelDefinition 
    {
        public static Task<GetCdlLabelDefinitionResult> InvokeAsync(GetCdlLabelDefinitionArgs args, InvokeOptions? opts = null)
        public static Output<GetCdlLabelDefinitionResult> Invoke(GetCdlLabelDefinitionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCdlLabelDefinitionResult> getCdlLabelDefinition(GetCdlLabelDefinitionArgs args, InvokeOptions options)
    public static Output<GetCdlLabelDefinitionResult> getCdlLabelDefinition(GetCdlLabelDefinitionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: hsdp:index/getCdlLabelDefinition:getCdlLabelDefinition
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CdlEndpoint string
    The CDL instance endpoint to query
    LabelDefId string
    The ID of the label definition to look up
    StudyId string
    The ID of the Research Study which contains the label definition
    Id string
    The GUID of the Label definitions
    CdlEndpoint string
    The CDL instance endpoint to query
    LabelDefId string
    The ID of the label definition to look up
    StudyId string
    The ID of the Research Study which contains the label definition
    Id string
    The GUID of the Label definitions
    cdlEndpoint String
    The CDL instance endpoint to query
    labelDefId String
    The ID of the label definition to look up
    studyId String
    The ID of the Research Study which contains the label definition
    id String
    The GUID of the Label definitions
    cdlEndpoint string
    The CDL instance endpoint to query
    labelDefId string
    The ID of the label definition to look up
    studyId string
    The ID of the Research Study which contains the label definition
    id string
    The GUID of the Label definitions
    cdl_endpoint str
    The CDL instance endpoint to query
    label_def_id str
    The ID of the label definition to look up
    study_id str
    The ID of the Research Study which contains the label definition
    id str
    The GUID of the Label definitions
    cdlEndpoint String
    The CDL instance endpoint to query
    labelDefId String
    The ID of the label definition to look up
    studyId String
    The ID of the Research Study which contains the label definition
    id String
    The GUID of the Label definitions

    getCdlLabelDefinition Result

    The following output properties are available:

    CdlEndpoint string
    CreatedBy string
    User who created this label definition
    CreatedOn string
    Timestamp when label definition was created
    Description string
    Description of label definition
    Id string
    The GUID of the Label definitions
    LabelDefId string
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels string
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    CdlEndpoint string
    CreatedBy string
    User who created this label definition
    CreatedOn string
    Timestamp when label definition was created
    Description string
    Description of label definition
    Id string
    The GUID of the Label definitions
    LabelDefId string
    LabelDefName string
    Name of the label definition
    LabelName string
    The label name
    LabelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    Labels string
    Use this parameter to specify your labels, or classes. Add one label for each class.
    StudyId string
    Type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint String
    createdBy String
    User who created this label definition
    createdOn String
    Timestamp when label definition was created
    description String
    Description of label definition
    id String
    The GUID of the Label definitions
    labelDefId String
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels String
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint string
    createdBy string
    User who created this label definition
    createdOn string
    Timestamp when label definition was created
    description string
    Description of label definition
    id string
    The GUID of the Label definitions
    labelDefId string
    labelDefName string
    Name of the label definition
    labelName string
    The label name
    labelScope string
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels string
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId string
    type string
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdl_endpoint str
    created_by str
    User who created this label definition
    created_on str
    Timestamp when label definition was created
    description str
    Description of label definition
    id str
    The GUID of the Label definitions
    label_def_id str
    label_def_name str
    Name of the label definition
    label_name str
    The label name
    label_scope str
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels str
    Use this parameter to specify your labels, or classes. Add one label for each class.
    study_id str
    type str
    Use this parameter to define the label type. Supported Values : cdl/video-classification
    cdlEndpoint String
    createdBy String
    User who created this label definition
    createdOn String
    Timestamp when label definition was created
    description String
    Description of label definition
    id String
    The GUID of the Label definitions
    labelDefId String
    labelDefName String
    Name of the label definition
    labelName String
    The label name
    labelScope String
    Use this parameter to specify for which CDL Data the LabelDefinition is applicable
    labels String
    Use this parameter to specify your labels, or classes. Add one label for each class.
    studyId String
    type String
    Use this parameter to define the label type. Supported Values : cdl/video-classification

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software