1. Packages
  2. DataRobot
  3. API Docs
  4. UseCase
DataRobot v0.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.

datarobot.UseCase

Explore with Pulumi AI

datarobot logo
DataRobot v0.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.

    Use case

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as datarobot from "@datarobot/pulumi-datarobot";
    
    const example = new datarobot.UseCase("example", {});
    export const exampleId = example.id;
    
    import pulumi
    import pulumi_datarobot as datarobot
    
    example = datarobot.UseCase("example")
    pulumi.export("exampleId", example.id)
    
    package main
    
    import (
    	"github.com/datarobot-community/pulumi-datarobot/sdk/go/datarobot"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := datarobot.NewUseCase(ctx, "example", nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleId", example.ID())
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Datarobot = DataRobotPulumi.Datarobot;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Datarobot.UseCase("example");
    
        return new Dictionary<string, object?>
        {
            ["exampleId"] = example.Id,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.datarobot.UseCase;
    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) {
            var example = new UseCase("example");
    
            ctx.export("exampleId", example.id());
        }
    }
    
    resources:
      example:
        type: datarobot:UseCase
    outputs:
      exampleId: ${example.id}
    

    Create UseCase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UseCase(name: string, args?: UseCaseArgs, opts?: CustomResourceOptions);
    @overload
    def UseCase(resource_name: str,
                args: Optional[UseCaseArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def UseCase(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                description: Optional[str] = None,
                name: Optional[str] = None)
    func NewUseCase(ctx *Context, name string, args *UseCaseArgs, opts ...ResourceOption) (*UseCase, error)
    public UseCase(string name, UseCaseArgs? args = null, CustomResourceOptions? opts = null)
    public UseCase(String name, UseCaseArgs args)
    public UseCase(String name, UseCaseArgs args, CustomResourceOptions options)
    
    type: datarobot:UseCase
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UseCaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UseCaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UseCaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UseCaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UseCaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var useCaseResource = new Datarobot.UseCase("useCaseResource", new()
    {
        Description = "string",
        Name = "string",
    });
    
    example, err := datarobot.NewUseCase(ctx, "useCaseResource", &datarobot.UseCaseArgs{
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var useCaseResource = new UseCase("useCaseResource", UseCaseArgs.builder()
        .description("string")
        .name("string")
        .build());
    
    use_case_resource = datarobot.UseCase("useCaseResource",
        description="string",
        name="string")
    
    const useCaseResource = new datarobot.UseCase("useCaseResource", {
        description: "string",
        name: "string",
    });
    
    type: datarobot:UseCase
    properties:
        description: string
        name: string
    

    UseCase Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UseCase resource accepts the following input properties:

    Description string
    The description of the Use Case.
    Name string
    The name of the Use Case.
    Description string
    The description of the Use Case.
    Name string
    The name of the Use Case.
    description String
    The description of the Use Case.
    name String
    The name of the Use Case.
    description string
    The description of the Use Case.
    name string
    The name of the Use Case.
    description str
    The description of the Use Case.
    name str
    The name of the Use Case.
    description String
    The description of the Use Case.
    name String
    The name of the Use Case.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UseCase resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UseCase Resource

    Get an existing UseCase resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UseCaseState, opts?: CustomResourceOptions): UseCase
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            name: Optional[str] = None) -> UseCase
    func GetUseCase(ctx *Context, name string, id IDInput, state *UseCaseState, opts ...ResourceOption) (*UseCase, error)
    public static UseCase Get(string name, Input<string> id, UseCaseState? state, CustomResourceOptions? opts = null)
    public static UseCase get(String name, Output<String> id, UseCaseState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of the Use Case.
    Name string
    The name of the Use Case.
    Description string
    The description of the Use Case.
    Name string
    The name of the Use Case.
    description String
    The description of the Use Case.
    name String
    The name of the Use Case.
    description string
    The description of the Use Case.
    name string
    The name of the Use Case.
    description str
    The description of the Use Case.
    name str
    The name of the Use Case.
    description String
    The description of the Use Case.
    name String
    The name of the Use Case.

    Package Details

    Repository
    datarobot datarobot-community/pulumi-datarobot
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datarobot Terraform Provider.
    datarobot logo
    DataRobot v0.4.5 published on Monday, Nov 18, 2024 by DataRobot, Inc.