Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. DataRobot
  3. API Docs
  4. CustomMetricJob
DataRobot v0.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

datarobot.CustomMetricJob

Explore with Pulumi AI

datarobot logo
DataRobot v0.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
datarobot-community/pulumi-datarobot

    Custom Job

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datarobot from "@datarobot/pulumi-datarobot";

const example = new datarobot.CustomMetricJob("example", {
    files: [
        "file1.py",
        "file2.py",
    ],
    environmentId: "65f9b27eab986d30d4c64268",
    description: "Example Custom Metric Job Description",
    runtimeParameterValues: [{
        key: "EXAMPLE_PARAM",
        type: "string",
        value: "val",
    }],
    egressNetworkPolicy: "none",
    resourceBundleId: "cpu.micro",
    units: "count",
    directionality: "lowerIsBetter",
    type: "sum",
    isModelSpecific: false,
});
export const exampleId = example.id;

    import pulumi
import pulumi_datarobot as datarobot

example = datarobot.CustomMetricJob("example",
    files=[
        "file1.py",
        "file2.py",
    ],
    environment_id="65f9b27eab986d30d4c64268",
    description="Example Custom Metric Job Description",
    runtime_parameter_values=[{
        "key": "EXAMPLE_PARAM",
        "type": "string",
        "value": "val",
    }],
    egress_network_policy="none",
    resource_bundle_id="cpu.micro",
    units="count",
    directionality="lowerIsBetter",
    type="sum",
    is_model_specific=False)
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.NewCustomMetricJob(ctx, "example", &datarobot.CustomMetricJobArgs{
			Files: pulumi.Any{
				"file1.py",
				"file2.py",
			},
			EnvironmentId: pulumi.String("65f9b27eab986d30d4c64268"),
			Description:   pulumi.String("Example Custom Metric Job Description"),
			RuntimeParameterValues: datarobot.CustomMetricJobRuntimeParameterValueArray{
				&datarobot.CustomMetricJobRuntimeParameterValueArgs{
					Key:   pulumi.String("EXAMPLE_PARAM"),
					Type:  pulumi.String("string"),
					Value: pulumi.String("val"),
				},
			},
			EgressNetworkPolicy: pulumi.String("none"),
			ResourceBundleId:    pulumi.String("cpu.micro"),
			Units:               pulumi.String("count"),
			Directionality:      pulumi.String("lowerIsBetter"),
			Type:                pulumi.String("sum"),
			IsModelSpecific:     pulumi.Bool(false),
		})
		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.CustomMetricJob("example", new()
    {
        Files = new[]
        {
            "file1.py",
            "file2.py",
        },
        EnvironmentId = "65f9b27eab986d30d4c64268",
        Description = "Example Custom Metric Job Description",
        RuntimeParameterValues = new[]
        {
            new Datarobot.Inputs.CustomMetricJobRuntimeParameterValueArgs
            {
                Key = "EXAMPLE_PARAM",
                Type = "string",
                Value = "val",
            },
        },
        EgressNetworkPolicy = "none",
        ResourceBundleId = "cpu.micro",
        Units = "count",
        Directionality = "lowerIsBetter",
        Type = "sum",
        IsModelSpecific = false,
    });

    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.CustomMetricJob;
import com.pulumi.datarobot.CustomMetricJobArgs;
import com.pulumi.datarobot.inputs.CustomMetricJobRuntimeParameterValueArgs;
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 CustomMetricJob("example", CustomMetricJobArgs.builder()
            .files(            
                "file1.py",
                "file2.py")
            .environmentId("65f9b27eab986d30d4c64268")
            .description("Example Custom Metric Job Description")
            .runtimeParameterValues(CustomMetricJobRuntimeParameterValueArgs.builder()
                .key("EXAMPLE_PARAM")
                .type("string")
                .value("val")
                .build())
            .egressNetworkPolicy("none")
            .resourceBundleId("cpu.micro")
            .units("count")
            .directionality("lowerIsBetter")
            .type("sum")
            .isModelSpecific(false)
            .build());

        ctx.export("exampleId", example.id());
    }
}

    resources:
  example:
    type: datarobot:CustomMetricJob
    properties:
      files:
        - file1.py
        - file2.py
      environmentId: 65f9b27eab986d30d4c64268
      # Optional
      description: Example Custom Metric Job Description
      runtimeParameterValues:
        - key: EXAMPLE_PARAM
          type: string
          value: val
      egressNetworkPolicy: none
      resourceBundleId: cpu.micro
      units: count
      directionality: lowerIsBetter
      type: sum
      isModelSpecific: false
outputs:
  exampleId: ${example.id}

    Create CustomMetricJob Resource

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

    Constructor syntax

    new CustomMetricJob(name: string, args?: CustomMetricJobArgs, opts?: CustomResourceOptions);
    @overload
def CustomMetricJob(resource_name: str,
                    args: Optional[CustomMetricJobArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def CustomMetricJob(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    description: Optional[str] = None,
                    directionality: Optional[str] = None,
                    egress_network_policy: Optional[str] = None,
                    environment_id: Optional[str] = None,
                    environment_version_id: Optional[str] = None,
                    files: Optional[Any] = None,
                    folder_path: Optional[str] = None,
                    is_model_specific: Optional[bool] = None,
                    name: Optional[str] = None,
                    resource_bundle_id: Optional[str] = None,
                    runtime_parameter_values: Optional[Sequence[CustomMetricJobRuntimeParameterValueArgs]] = None,
                    time_step: Optional[str] = None,
                    type: Optional[str] = None,
                    units: Optional[str] = None)
    func NewCustomMetricJob(ctx *Context, name string, args *CustomMetricJobArgs, opts ...ResourceOption) (*CustomMetricJob, error)
    public CustomMetricJob(string name, CustomMetricJobArgs? args = null, CustomResourceOptions? opts = null)
    public CustomMetricJob(String name, CustomMetricJobArgs args)
public CustomMetricJob(String name, CustomMetricJobArgs args, CustomResourceOptions options)

    type: datarobot:CustomMetricJob
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 CustomMetricJobArgs
    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 CustomMetricJobArgs
    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 CustomMetricJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomMetricJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomMetricJobArgs
    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 customMetricJobResource = new Datarobot.CustomMetricJob("customMetricJobResource", new()
{
    Description = "string",
    Directionality = "string",
    EgressNetworkPolicy = "string",
    EnvironmentId = "string",
    EnvironmentVersionId = "string",
    Files = "any",
    FolderPath = "string",
    IsModelSpecific = false,
    Name = "string",
    ResourceBundleId = "string",
    RuntimeParameterValues = new[]
    {
        new Datarobot.Inputs.CustomMetricJobRuntimeParameterValueArgs
        {
            Key = "string",
            Type = "string",
            Value = "string",
        },
    },
    TimeStep = "string",
    Type = "string",
    Units = "string",
});

    example, err := datarobot.NewCustomMetricJob(ctx, "customMetricJobResource", &datarobot.CustomMetricJobArgs{
	Description:          pulumi.String("string"),
	Directionality:       pulumi.String("string"),
	EgressNetworkPolicy:  pulumi.String("string"),
	EnvironmentId:        pulumi.String("string"),
	EnvironmentVersionId: pulumi.String("string"),
	Files:                pulumi.Any("any"),
	FolderPath:           pulumi.String("string"),
	IsModelSpecific:      pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	ResourceBundleId:     pulumi.String("string"),
	RuntimeParameterValues: datarobot.CustomMetricJobRuntimeParameterValueArray{
		&datarobot.CustomMetricJobRuntimeParameterValueArgs{
			Key:   pulumi.String("string"),
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TimeStep: pulumi.String("string"),
	Type:     pulumi.String("string"),
	Units:    pulumi.String("string"),
})

    var customMetricJobResource = new CustomMetricJob("customMetricJobResource", CustomMetricJobArgs.builder()
    .description("string")
    .directionality("string")
    .egressNetworkPolicy("string")
    .environmentId("string")
    .environmentVersionId("string")
    .files("any")
    .folderPath("string")
    .isModelSpecific(false)
    .name("string")
    .resourceBundleId("string")
    .runtimeParameterValues(CustomMetricJobRuntimeParameterValueArgs.builder()
        .key("string")
        .type("string")
        .value("string")
        .build())
    .timeStep("string")
    .type("string")
    .units("string")
    .build());

    custom_metric_job_resource = datarobot.CustomMetricJob("customMetricJobResource",
    description="string",
    directionality="string",
    egress_network_policy="string",
    environment_id="string",
    environment_version_id="string",
    files="any",
    folder_path="string",
    is_model_specific=False,
    name="string",
    resource_bundle_id="string",
    runtime_parameter_values=[{
        "key": "string",
        "type": "string",
        "value": "string",
    }],
    time_step="string",
    type="string",
    units="string")

    const customMetricJobResource = new datarobot.CustomMetricJob("customMetricJobResource", {
    description: "string",
    directionality: "string",
    egressNetworkPolicy: "string",
    environmentId: "string",
    environmentVersionId: "string",
    files: "any",
    folderPath: "string",
    isModelSpecific: false,
    name: "string",
    resourceBundleId: "string",
    runtimeParameterValues: [{
        key: "string",
        type: "string",
        value: "string",
    }],
    timeStep: "string",
    type: "string",
    units: "string",
});

    type: datarobot:CustomMetricJob
properties:
    description: string
    directionality: string
    egressNetworkPolicy: string
    environmentId: string
    environmentVersionId: string
    files: any
    folderPath: string
    isModelSpecific: false
    name: string
    resourceBundleId: string
    runtimeParameterValues:
        - key: string
          type: string
          value: string
    timeStep: string
    type: string
    units: string

    CustomMetricJob 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 CustomMetricJob resource accepts the following input properties:

    Description string
    The description of the Custom Metric Job.
    Directionality string
    The directionality of the Custom Metric.
    EgressNetworkPolicy string
    The egress network policy for the Job.
    EnvironmentId string
    The ID of the environment to use with the Job.
    EnvironmentVersionId string
    The ID of the environment version to use with the Job.
    Files object
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    FolderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    IsModelSpecific bool
    Determines whether the metric is related to the model or deployment.
    Name string
    The name of the Custom Metric Job.
    ResourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    RuntimeParameterValues List<DataRobotCustomMetricJobRuntimeParameterValue>
    Additional parameters to be injected into a Job at runtime.
    TimeStep string
    Custom metric time bucket size.
    Type string
    The aggregation type of the custom metric.
    Units string
    The units, or the y-axis label, of the given custom metric.
    Description string
    The description of the Custom Metric Job.
    Directionality string
    The directionality of the Custom Metric.
    EgressNetworkPolicy string
    The egress network policy for the Job.
    EnvironmentId string
    The ID of the environment to use with the Job.
    EnvironmentVersionId string
    The ID of the environment version to use with the Job.
    Files interface{}
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    FolderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    IsModelSpecific bool
    Determines whether the metric is related to the model or deployment.
    Name string
    The name of the Custom Metric Job.
    ResourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    RuntimeParameterValues []CustomMetricJobRuntimeParameterValueArgs
    Additional parameters to be injected into a Job at runtime.
    TimeStep string
    Custom metric time bucket size.
    Type string
    The aggregation type of the custom metric.
    Units string
    The units, or the y-axis label, of the given custom metric.
    description String
    The description of the Custom Metric Job.
    directionality String
    The directionality of the Custom Metric.
    egressNetworkPolicy String
    The egress network policy for the Job.
    environmentId String
    The ID of the environment to use with the Job.
    environmentVersionId String
    The ID of the environment version to use with the Job.
    files Object
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    folderPath String
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    isModelSpecific Boolean
    Determines whether the metric is related to the model or deployment.
    name String
    The name of the Custom Metric Job.
    resourceBundleId String
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues List<CustomMetricJobRuntimeParameterValue>
    Additional parameters to be injected into a Job at runtime.
    timeStep String
    Custom metric time bucket size.
    type String
    The aggregation type of the custom metric.
    units String
    The units, or the y-axis label, of the given custom metric.
    description string
    The description of the Custom Metric Job.
    directionality string
    The directionality of the Custom Metric.
    egressNetworkPolicy string
    The egress network policy for the Job.
    environmentId string
    The ID of the environment to use with the Job.
    environmentVersionId string
    The ID of the environment version to use with the Job.
    files any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    folderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    isModelSpecific boolean
    Determines whether the metric is related to the model or deployment.
    name string
    The name of the Custom Metric Job.
    resourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues CustomMetricJobRuntimeParameterValue[]
    Additional parameters to be injected into a Job at runtime.
    timeStep string
    Custom metric time bucket size.
    type string
    The aggregation type of the custom metric.
    units string
    The units, or the y-axis label, of the given custom metric.
    description str
    The description of the Custom Metric Job.
    directionality str
    The directionality of the Custom Metric.
    egress_network_policy str
    The egress network policy for the Job.
    environment_id str
    The ID of the environment to use with the Job.
    environment_version_id str
    The ID of the environment version to use with the Job.
    files Any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    folder_path str
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    is_model_specific bool
    Determines whether the metric is related to the model or deployment.
    name str
    The name of the Custom Metric Job.
    resource_bundle_id str
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtime_parameter_values Sequence[CustomMetricJobRuntimeParameterValueArgs]
    Additional parameters to be injected into a Job at runtime.
    time_step str
    Custom metric time bucket size.
    type str
    The aggregation type of the custom metric.
    units str
    The units, or the y-axis label, of the given custom metric.
    description String
    The description of the Custom Metric Job.
    directionality String
    The directionality of the Custom Metric.
    egressNetworkPolicy String
    The egress network policy for the Job.
    environmentId String
    The ID of the environment to use with the Job.
    environmentVersionId String
    The ID of the environment version to use with the Job.
    files Any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    folderPath String
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    isModelSpecific Boolean
    Determines whether the metric is related to the model or deployment.
    name String
    The name of the Custom Metric Job.
    resourceBundleId String
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues List<Property Map>
    Additional parameters to be injected into a Job at runtime.
    timeStep String
    Custom metric time bucket size.
    type String
    The aggregation type of the custom metric.
    units String
    The units, or the y-axis label, of the given custom metric.

    Outputs

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

    FilesHashes List<string>
    The hash of file contents for each file in files.
    FolderPathHash string
    The hash of the folder path contents.
    Id string
    The provider-assigned unique ID for this managed resource.
    FilesHashes []string
    The hash of file contents for each file in files.
    FolderPathHash string
    The hash of the folder path contents.
    Id string
    The provider-assigned unique ID for this managed resource.
    filesHashes List<String>
    The hash of file contents for each file in files.
    folderPathHash String
    The hash of the folder path contents.
    id String
    The provider-assigned unique ID for this managed resource.
    filesHashes string[]
    The hash of file contents for each file in files.
    folderPathHash string
    The hash of the folder path contents.
    id string
    The provider-assigned unique ID for this managed resource.
    files_hashes Sequence[str]
    The hash of file contents for each file in files.
    folder_path_hash str
    The hash of the folder path contents.
    id str
    The provider-assigned unique ID for this managed resource.
    filesHashes List<String>
    The hash of file contents for each file in files.
    folderPathHash String
    The hash of the folder path contents.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomMetricJob Resource

    Get an existing CustomMetricJob 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?: CustomMetricJobState, opts?: CustomResourceOptions): CustomMetricJob
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        directionality: Optional[str] = None,
        egress_network_policy: Optional[str] = None,
        environment_id: Optional[str] = None,
        environment_version_id: Optional[str] = None,
        files: Optional[Any] = None,
        files_hashes: Optional[Sequence[str]] = None,
        folder_path: Optional[str] = None,
        folder_path_hash: Optional[str] = None,
        is_model_specific: Optional[bool] = None,
        name: Optional[str] = None,
        resource_bundle_id: Optional[str] = None,
        runtime_parameter_values: Optional[Sequence[CustomMetricJobRuntimeParameterValueArgs]] = None,
        time_step: Optional[str] = None,
        type: Optional[str] = None,
        units: Optional[str] = None) -> CustomMetricJob
    func GetCustomMetricJob(ctx *Context, name string, id IDInput, state *CustomMetricJobState, opts ...ResourceOption) (*CustomMetricJob, error)
    public static CustomMetricJob Get(string name, Input<string> id, CustomMetricJobState? state, CustomResourceOptions? opts = null)
    public static CustomMetricJob get(String name, Output<String> id, CustomMetricJobState 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 Custom Metric Job.
    Directionality string
    The directionality of the Custom Metric.
    EgressNetworkPolicy string
    The egress network policy for the Job.
    EnvironmentId string
    The ID of the environment to use with the Job.
    EnvironmentVersionId string
    The ID of the environment version to use with the Job.
    Files object
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    FilesHashes List<string>
    The hash of file contents for each file in files.
    FolderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    FolderPathHash string
    The hash of the folder path contents.
    IsModelSpecific bool
    Determines whether the metric is related to the model or deployment.
    Name string
    The name of the Custom Metric Job.
    ResourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    RuntimeParameterValues List<DataRobotCustomMetricJobRuntimeParameterValue>
    Additional parameters to be injected into a Job at runtime.
    TimeStep string
    Custom metric time bucket size.
    Type string
    The aggregation type of the custom metric.
    Units string
    The units, or the y-axis label, of the given custom metric.
    Description string
    The description of the Custom Metric Job.
    Directionality string
    The directionality of the Custom Metric.
    EgressNetworkPolicy string
    The egress network policy for the Job.
    EnvironmentId string
    The ID of the environment to use with the Job.
    EnvironmentVersionId string
    The ID of the environment version to use with the Job.
    Files interface{}
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    FilesHashes []string
    The hash of file contents for each file in files.
    FolderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    FolderPathHash string
    The hash of the folder path contents.
    IsModelSpecific bool
    Determines whether the metric is related to the model or deployment.
    Name string
    The name of the Custom Metric Job.
    ResourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    RuntimeParameterValues []CustomMetricJobRuntimeParameterValueArgs
    Additional parameters to be injected into a Job at runtime.
    TimeStep string
    Custom metric time bucket size.
    Type string
    The aggregation type of the custom metric.
    Units string
    The units, or the y-axis label, of the given custom metric.
    description String
    The description of the Custom Metric Job.
    directionality String
    The directionality of the Custom Metric.
    egressNetworkPolicy String
    The egress network policy for the Job.
    environmentId String
    The ID of the environment to use with the Job.
    environmentVersionId String
    The ID of the environment version to use with the Job.
    files Object
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    filesHashes List<String>
    The hash of file contents for each file in files.
    folderPath String
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    folderPathHash String
    The hash of the folder path contents.
    isModelSpecific Boolean
    Determines whether the metric is related to the model or deployment.
    name String
    The name of the Custom Metric Job.
    resourceBundleId String
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues List<CustomMetricJobRuntimeParameterValue>
    Additional parameters to be injected into a Job at runtime.
    timeStep String
    Custom metric time bucket size.
    type String
    The aggregation type of the custom metric.
    units String
    The units, or the y-axis label, of the given custom metric.
    description string
    The description of the Custom Metric Job.
    directionality string
    The directionality of the Custom Metric.
    egressNetworkPolicy string
    The egress network policy for the Job.
    environmentId string
    The ID of the environment to use with the Job.
    environmentVersionId string
    The ID of the environment version to use with the Job.
    files any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    filesHashes string[]
    The hash of file contents for each file in files.
    folderPath string
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    folderPathHash string
    The hash of the folder path contents.
    isModelSpecific boolean
    Determines whether the metric is related to the model or deployment.
    name string
    The name of the Custom Metric Job.
    resourceBundleId string
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues CustomMetricJobRuntimeParameterValue[]
    Additional parameters to be injected into a Job at runtime.
    timeStep string
    Custom metric time bucket size.
    type string
    The aggregation type of the custom metric.
    units string
    The units, or the y-axis label, of the given custom metric.
    description str
    The description of the Custom Metric Job.
    directionality str
    The directionality of the Custom Metric.
    egress_network_policy str
    The egress network policy for the Job.
    environment_id str
    The ID of the environment to use with the Job.
    environment_version_id str
    The ID of the environment version to use with the Job.
    files Any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    files_hashes Sequence[str]
    The hash of file contents for each file in files.
    folder_path str
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    folder_path_hash str
    The hash of the folder path contents.
    is_model_specific bool
    Determines whether the metric is related to the model or deployment.
    name str
    The name of the Custom Metric Job.
    resource_bundle_id str
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtime_parameter_values Sequence[CustomMetricJobRuntimeParameterValueArgs]
    Additional parameters to be injected into a Job at runtime.
    time_step str
    Custom metric time bucket size.
    type str
    The aggregation type of the custom metric.
    units str
    The units, or the y-axis label, of the given custom metric.
    description String
    The description of the Custom Metric Job.
    directionality String
    The directionality of the Custom Metric.
    egressNetworkPolicy String
    The egress network policy for the Job.
    environmentId String
    The ID of the environment to use with the Job.
    environmentVersionId String
    The ID of the environment version to use with the Job.
    files Any
    The list of tuples, where values in each tuple are the local filesystem path and the path the file should be placed in the Job. If list is of strings, then basenames will be used for tuples.
    filesHashes List<String>
    The hash of file contents for each file in files.
    folderPath String
    The path to a folder containing files to be uploaded. Each file in the folder is uploaded under path relative to a folder path.
    folderPathHash String
    The hash of the folder path contents.
    isModelSpecific Boolean
    Determines whether the metric is related to the model or deployment.
    name String
    The name of the Custom Metric Job.
    resourceBundleId String
    A single identifier that represents a bundle of resources: Memory, CPU, GPU, etc.
    runtimeParameterValues List<Property Map>
    Additional parameters to be injected into a Job at runtime.
    timeStep String
    Custom metric time bucket size.
    type String
    The aggregation type of the custom metric.
    units String
    The units, or the y-axis label, of the given custom metric.

    Supporting Types

    CustomMetricJobRuntimeParameterValue, CustomMetricJobRuntimeParameterValueArgs

    Key string
    The name of the runtime parameter.
    Type string
    The type of the runtime parameter.
    Value string
    The value of the runtime parameter (type conversion is handled internally).
    Key string
    The name of the runtime parameter.
    Type string
    The type of the runtime parameter.
    Value string
    The value of the runtime parameter (type conversion is handled internally).
    key String
    The name of the runtime parameter.
    type String
    The type of the runtime parameter.
    value String
    The value of the runtime parameter (type conversion is handled internally).
    key string
    The name of the runtime parameter.
    type string
    The type of the runtime parameter.
    value string
    The value of the runtime parameter (type conversion is handled internally).
    key str
    The name of the runtime parameter.
    type str
    The type of the runtime parameter.
    value str
    The value of the runtime parameter (type conversion is handled internally).
    key String
    The name of the runtime parameter.
    type String
    The type of the runtime parameter.
    value String
    The value of the runtime parameter (type conversion is handled internally).

    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.5.1 published on Friday, Nov 29, 2024 by DataRobot, Inc.
    datarobot-community/pulumi-datarobot