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

datarobot.CustomMetricFromJob

Explore with Pulumi AI

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

    Custom Metric From Job

    Example Usage

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

const example = new datarobot.CustomMetricFromJob("example", {
    deploymentId: datarobot_deployment.example.id,
    customJobId: datarobot_custom_metric_job.example.id,
});
export const exampleId = example.id;

    import pulumi
import pulumi_datarobot as datarobot

example = datarobot.CustomMetricFromJob("example",
    deployment_id=datarobot_deployment["example"]["id"],
    custom_job_id=datarobot_custom_metric_job["example"]["id"])
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.NewCustomMetricFromJob(ctx, "example", &datarobot.CustomMetricFromJobArgs{
			DeploymentId: pulumi.Any(datarobot_deployment.Example.Id),
			CustomJobId:  pulumi.Any(datarobot_custom_metric_job.Example.Id),
		})
		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.CustomMetricFromJob("example", new()
    {
        DeploymentId = datarobot_deployment.Example.Id,
        CustomJobId = datarobot_custom_metric_job.Example.Id,
    });

    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.CustomMetricFromJob;
import com.pulumi.datarobot.CustomMetricFromJobArgs;
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 CustomMetricFromJob("example", CustomMetricFromJobArgs.builder()
            .deploymentId(datarobot_deployment.example().id())
            .customJobId(datarobot_custom_metric_job.example().id())
            .build());

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

    resources:
  example:
    type: datarobot:CustomMetricFromJob
    properties:
      deploymentId: ${datarobot_deployment.example.id}
      customJobId: ${datarobot_custom_metric_job.example.id}
outputs:
  exampleId: ${example.id}

    Create CustomMetricFromJob Resource

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

    Constructor syntax

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

@overload
def CustomMetricFromJob(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        custom_job_id: Optional[str] = None,
                        deployment_id: Optional[str] = None,
                        baseline_value: Optional[float] = None,
                        batch: Optional[CustomMetricFromJobBatchArgs] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        parameter_overrides: Optional[Sequence[CustomMetricFromJobParameterOverrideArgs]] = None,
                        sample_count: Optional[CustomMetricFromJobSampleCountArgs] = None,
                        schedule: Optional[CustomMetricFromJobScheduleArgs] = None,
                        timestamp: Optional[CustomMetricFromJobTimestampArgs] = None,
                        value: Optional[CustomMetricFromJobValueArgs] = None)
    func NewCustomMetricFromJob(ctx *Context, name string, args CustomMetricFromJobArgs, opts ...ResourceOption) (*CustomMetricFromJob, error)
    public CustomMetricFromJob(string name, CustomMetricFromJobArgs args, CustomResourceOptions? opts = null)
    public CustomMetricFromJob(String name, CustomMetricFromJobArgs args)
public CustomMetricFromJob(String name, CustomMetricFromJobArgs args, CustomResourceOptions options)

    type: datarobot:CustomMetricFromJob
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 CustomMetricFromJobArgs
    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 CustomMetricFromJobArgs
    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 CustomMetricFromJobArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomMetricFromJobArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomMetricFromJobArgs
    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 customMetricFromJobResource = new Datarobot.CustomMetricFromJob("customMetricFromJobResource", new()
{
    CustomJobId = "string",
    DeploymentId = "string",
    BaselineValue = 0,
    Batch = new Datarobot.Inputs.CustomMetricFromJobBatchArgs
    {
        ColumnName = "string",
    },
    Description = "string",
    Name = "string",
    ParameterOverrides = new[]
    {
        new Datarobot.Inputs.CustomMetricFromJobParameterOverrideArgs
        {
            Key = "string",
            Type = "string",
            Value = "string",
        },
    },
    SampleCount = new Datarobot.Inputs.CustomMetricFromJobSampleCountArgs
    {
        ColumnName = "string",
    },
    Schedule = new Datarobot.Inputs.CustomMetricFromJobScheduleArgs
    {
        DayOfMonths = new[]
        {
            "string",
        },
        DayOfWeeks = new[]
        {
            "string",
        },
        Hours = new[]
        {
            "string",
        },
        Minutes = new[]
        {
            "string",
        },
        Months = new[]
        {
            "string",
        },
    },
    Timestamp = new Datarobot.Inputs.CustomMetricFromJobTimestampArgs
    {
        ColumnName = "string",
        TimeFormat = "string",
    },
    Value = new Datarobot.Inputs.CustomMetricFromJobValueArgs
    {
        ColumnName = "string",
    },
});

    example, err := datarobot.NewCustomMetricFromJob(ctx, "customMetricFromJobResource", &datarobot.CustomMetricFromJobArgs{
	CustomJobId:   pulumi.String("string"),
	DeploymentId:  pulumi.String("string"),
	BaselineValue: pulumi.Float64(0),
	Batch: &datarobot.CustomMetricFromJobBatchArgs{
		ColumnName: pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	ParameterOverrides: datarobot.CustomMetricFromJobParameterOverrideArray{
		&datarobot.CustomMetricFromJobParameterOverrideArgs{
			Key:   pulumi.String("string"),
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	SampleCount: &datarobot.CustomMetricFromJobSampleCountArgs{
		ColumnName: pulumi.String("string"),
	},
	Schedule: &datarobot.CustomMetricFromJobScheduleArgs{
		DayOfMonths: pulumi.StringArray{
			pulumi.String("string"),
		},
		DayOfWeeks: pulumi.StringArray{
			pulumi.String("string"),
		},
		Hours: pulumi.StringArray{
			pulumi.String("string"),
		},
		Minutes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Months: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Timestamp: &datarobot.CustomMetricFromJobTimestampArgs{
		ColumnName: pulumi.String("string"),
		TimeFormat: pulumi.String("string"),
	},
	Value: &datarobot.CustomMetricFromJobValueArgs{
		ColumnName: pulumi.String("string"),
	},
})

    var customMetricFromJobResource = new CustomMetricFromJob("customMetricFromJobResource", CustomMetricFromJobArgs.builder()
    .customJobId("string")
    .deploymentId("string")
    .baselineValue(0)
    .batch(CustomMetricFromJobBatchArgs.builder()
        .columnName("string")
        .build())
    .description("string")
    .name("string")
    .parameterOverrides(CustomMetricFromJobParameterOverrideArgs.builder()
        .key("string")
        .type("string")
        .value("string")
        .build())
    .sampleCount(CustomMetricFromJobSampleCountArgs.builder()
        .columnName("string")
        .build())
    .schedule(CustomMetricFromJobScheduleArgs.builder()
        .dayOfMonths("string")
        .dayOfWeeks("string")
        .hours("string")
        .minutes("string")
        .months("string")
        .build())
    .timestamp(CustomMetricFromJobTimestampArgs.builder()
        .columnName("string")
        .timeFormat("string")
        .build())
    .value(CustomMetricFromJobValueArgs.builder()
        .columnName("string")
        .build())
    .build());

    custom_metric_from_job_resource = datarobot.CustomMetricFromJob("customMetricFromJobResource",
    custom_job_id="string",
    deployment_id="string",
    baseline_value=0,
    batch={
        "column_name": "string",
    },
    description="string",
    name="string",
    parameter_overrides=[{
        "key": "string",
        "type": "string",
        "value": "string",
    }],
    sample_count={
        "column_name": "string",
    },
    schedule={
        "day_of_months": ["string"],
        "day_of_weeks": ["string"],
        "hours": ["string"],
        "minutes": ["string"],
        "months": ["string"],
    },
    timestamp={
        "column_name": "string",
        "time_format": "string",
    },
    value={
        "column_name": "string",
    })

    const customMetricFromJobResource = new datarobot.CustomMetricFromJob("customMetricFromJobResource", {
    customJobId: "string",
    deploymentId: "string",
    baselineValue: 0,
    batch: {
        columnName: "string",
    },
    description: "string",
    name: "string",
    parameterOverrides: [{
        key: "string",
        type: "string",
        value: "string",
    }],
    sampleCount: {
        columnName: "string",
    },
    schedule: {
        dayOfMonths: ["string"],
        dayOfWeeks: ["string"],
        hours: ["string"],
        minutes: ["string"],
        months: ["string"],
    },
    timestamp: {
        columnName: "string",
        timeFormat: "string",
    },
    value: {
        columnName: "string",
    },
});

    type: datarobot:CustomMetricFromJob
properties:
    baselineValue: 0
    batch:
        columnName: string
    customJobId: string
    deploymentId: string
    description: string
    name: string
    parameterOverrides:
        - key: string
          type: string
          value: string
    sampleCount:
        columnName: string
    schedule:
        dayOfMonths:
            - string
        dayOfWeeks:
            - string
        hours:
            - string
        minutes:
            - string
        months:
            - string
    timestamp:
        columnName: string
        timeFormat: string
    value:
        columnName: string

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

    CustomJobId string
    ID of the Custom Job.
    DeploymentId string
    ID of the Deployment.
    BaselineValue double
    Baseline value for the metric.
    Batch DataRobotCustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    Description string
    Description of the metric.
    Name string
    Name of the metric.
    ParameterOverrides List<DataRobotCustomMetricFromJobParameterOverride>
    Additional parameters to be injected into the Metric Job at runtime.
    SampleCount DataRobotCustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    Schedule DataRobotCustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    Timestamp DataRobotCustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    Value DataRobotCustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    CustomJobId string
    ID of the Custom Job.
    DeploymentId string
    ID of the Deployment.
    BaselineValue float64
    Baseline value for the metric.
    Batch CustomMetricFromJobBatchArgs
    Batch ID source when reading values from columnar dataset like a file.
    Description string
    Description of the metric.
    Name string
    Name of the metric.
    ParameterOverrides []CustomMetricFromJobParameterOverrideArgs
    Additional parameters to be injected into the Metric Job at runtime.
    SampleCount CustomMetricFromJobSampleCountArgs
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    Schedule CustomMetricFromJobScheduleArgs
    Defines at what intervals the metric job should run.
    Timestamp CustomMetricFromJobTimestampArgs
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    Value CustomMetricFromJobValueArgs
    Value source when reading values from columnar dataset like a file.
    customJobId String
    ID of the Custom Job.
    deploymentId String
    ID of the Deployment.
    baselineValue Double
    Baseline value for the metric.
    batch CustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    description String
    Description of the metric.
    name String
    Name of the metric.
    parameterOverrides List<CustomMetricFromJobParameterOverride>
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount CustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    customJobId string
    ID of the Custom Job.
    deploymentId string
    ID of the Deployment.
    baselineValue number
    Baseline value for the metric.
    batch CustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    description string
    Description of the metric.
    name string
    Name of the metric.
    parameterOverrides CustomMetricFromJobParameterOverride[]
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount CustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    custom_job_id str
    ID of the Custom Job.
    deployment_id str
    ID of the Deployment.
    baseline_value float
    Baseline value for the metric.
    batch CustomMetricFromJobBatchArgs
    Batch ID source when reading values from columnar dataset like a file.
    description str
    Description of the metric.
    name str
    Name of the metric.
    parameter_overrides Sequence[CustomMetricFromJobParameterOverrideArgs]
    Additional parameters to be injected into the Metric Job at runtime.
    sample_count CustomMetricFromJobSampleCountArgs
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobScheduleArgs
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestampArgs
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValueArgs
    Value source when reading values from columnar dataset like a file.
    customJobId String
    ID of the Custom Job.
    deploymentId String
    ID of the Deployment.
    baselineValue Number
    Baseline value for the metric.
    batch Property Map
    Batch ID source when reading values from columnar dataset like a file.
    description String
    Description of the metric.
    name String
    Name of the metric.
    parameterOverrides List<Property Map>
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount Property Map
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule Property Map
    Defines at what intervals the metric job should run.
    timestamp Property Map
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value Property Map
    Value source when reading values from columnar dataset like a file.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomMetricFromJob 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 CustomMetricFromJob Resource

    Get an existing CustomMetricFromJob 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?: CustomMetricFromJobState, opts?: CustomResourceOptions): CustomMetricFromJob
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        baseline_value: Optional[float] = None,
        batch: Optional[CustomMetricFromJobBatchArgs] = None,
        custom_job_id: Optional[str] = None,
        deployment_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parameter_overrides: Optional[Sequence[CustomMetricFromJobParameterOverrideArgs]] = None,
        sample_count: Optional[CustomMetricFromJobSampleCountArgs] = None,
        schedule: Optional[CustomMetricFromJobScheduleArgs] = None,
        timestamp: Optional[CustomMetricFromJobTimestampArgs] = None,
        value: Optional[CustomMetricFromJobValueArgs] = None) -> CustomMetricFromJob
    func GetCustomMetricFromJob(ctx *Context, name string, id IDInput, state *CustomMetricFromJobState, opts ...ResourceOption) (*CustomMetricFromJob, error)
    public static CustomMetricFromJob Get(string name, Input<string> id, CustomMetricFromJobState? state, CustomResourceOptions? opts = null)
    public static CustomMetricFromJob get(String name, Output<String> id, CustomMetricFromJobState 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:
    BaselineValue double
    Baseline value for the metric.
    Batch DataRobotCustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    CustomJobId string
    ID of the Custom Job.
    DeploymentId string
    ID of the Deployment.
    Description string
    Description of the metric.
    Name string
    Name of the metric.
    ParameterOverrides List<DataRobotCustomMetricFromJobParameterOverride>
    Additional parameters to be injected into the Metric Job at runtime.
    SampleCount DataRobotCustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    Schedule DataRobotCustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    Timestamp DataRobotCustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    Value DataRobotCustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    BaselineValue float64
    Baseline value for the metric.
    Batch CustomMetricFromJobBatchArgs
    Batch ID source when reading values from columnar dataset like a file.
    CustomJobId string
    ID of the Custom Job.
    DeploymentId string
    ID of the Deployment.
    Description string
    Description of the metric.
    Name string
    Name of the metric.
    ParameterOverrides []CustomMetricFromJobParameterOverrideArgs
    Additional parameters to be injected into the Metric Job at runtime.
    SampleCount CustomMetricFromJobSampleCountArgs
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    Schedule CustomMetricFromJobScheduleArgs
    Defines at what intervals the metric job should run.
    Timestamp CustomMetricFromJobTimestampArgs
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    Value CustomMetricFromJobValueArgs
    Value source when reading values from columnar dataset like a file.
    baselineValue Double
    Baseline value for the metric.
    batch CustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    customJobId String
    ID of the Custom Job.
    deploymentId String
    ID of the Deployment.
    description String
    Description of the metric.
    name String
    Name of the metric.
    parameterOverrides List<CustomMetricFromJobParameterOverride>
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount CustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    baselineValue number
    Baseline value for the metric.
    batch CustomMetricFromJobBatch
    Batch ID source when reading values from columnar dataset like a file.
    customJobId string
    ID of the Custom Job.
    deploymentId string
    ID of the Deployment.
    description string
    Description of the metric.
    name string
    Name of the metric.
    parameterOverrides CustomMetricFromJobParameterOverride[]
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount CustomMetricFromJobSampleCount
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobSchedule
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestamp
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValue
    Value source when reading values from columnar dataset like a file.
    baseline_value float
    Baseline value for the metric.
    batch CustomMetricFromJobBatchArgs
    Batch ID source when reading values from columnar dataset like a file.
    custom_job_id str
    ID of the Custom Job.
    deployment_id str
    ID of the Deployment.
    description str
    Description of the metric.
    name str
    Name of the metric.
    parameter_overrides Sequence[CustomMetricFromJobParameterOverrideArgs]
    Additional parameters to be injected into the Metric Job at runtime.
    sample_count CustomMetricFromJobSampleCountArgs
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule CustomMetricFromJobScheduleArgs
    Defines at what intervals the metric job should run.
    timestamp CustomMetricFromJobTimestampArgs
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value CustomMetricFromJobValueArgs
    Value source when reading values from columnar dataset like a file.
    baselineValue Number
    Baseline value for the metric.
    batch Property Map
    Batch ID source when reading values from columnar dataset like a file.
    customJobId String
    ID of the Custom Job.
    deploymentId String
    ID of the Deployment.
    description String
    Description of the metric.
    name String
    Name of the metric.
    parameterOverrides List<Property Map>
    Additional parameters to be injected into the Metric Job at runtime.
    sampleCount Property Map
    Points to a weight column if users provide pre-aggregated metric values. Used with columnar datasets.
    schedule Property Map
    Defines at what intervals the metric job should run.
    timestamp Property Map
    Timestamp spoofing when reading values from file, like dataset. By default, we replicate pd.to_datetime formatting behaviour.
    value Property Map
    Value source when reading values from columnar dataset like a file.

    Supporting Types

    CustomMetricFromJobBatch, CustomMetricFromJobBatchArgs

    ColumnName string
    Column name.
    ColumnName string
    Column name.
    columnName String
    Column name.
    columnName string
    Column name.
    column_name str
    Column name.
    columnName String
    Column name.

    CustomMetricFromJobParameterOverride, CustomMetricFromJobParameterOverrideArgs

    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).

    CustomMetricFromJobSampleCount, CustomMetricFromJobSampleCountArgs

    ColumnName string
    Column name.
    ColumnName string
    Column name.
    columnName String
    Column name.
    columnName string
    Column name.
    column_name str
    Column name.
    columnName String
    Column name.

    CustomMetricFromJobSchedule, CustomMetricFromJobScheduleArgs

    DayOfMonths List<string>
    Days of the month when the metric job will run.
    DayOfWeeks List<string>
    Days of the week when the metric job will run.
    Hours List<string>
    Hours of the day when the metric job will run.
    Minutes List<string>
    Minutes of the day when the metric job will run.
    Months List<string>
    Months of the year when the metric job will run.
    DayOfMonths []string
    Days of the month when the metric job will run.
    DayOfWeeks []string
    Days of the week when the metric job will run.
    Hours []string
    Hours of the day when the metric job will run.
    Minutes []string
    Minutes of the day when the metric job will run.
    Months []string
    Months of the year when the metric job will run.
    dayOfMonths List<String>
    Days of the month when the metric job will run.
    dayOfWeeks List<String>
    Days of the week when the metric job will run.
    hours List<String>
    Hours of the day when the metric job will run.
    minutes List<String>
    Minutes of the day when the metric job will run.
    months List<String>
    Months of the year when the metric job will run.
    dayOfMonths string[]
    Days of the month when the metric job will run.
    dayOfWeeks string[]
    Days of the week when the metric job will run.
    hours string[]
    Hours of the day when the metric job will run.
    minutes string[]
    Minutes of the day when the metric job will run.
    months string[]
    Months of the year when the metric job will run.
    day_of_months Sequence[str]
    Days of the month when the metric job will run.
    day_of_weeks Sequence[str]
    Days of the week when the metric job will run.
    hours Sequence[str]
    Hours of the day when the metric job will run.
    minutes Sequence[str]
    Minutes of the day when the metric job will run.
    months Sequence[str]
    Months of the year when the metric job will run.
    dayOfMonths List<String>
    Days of the month when the metric job will run.
    dayOfWeeks List<String>
    Days of the week when the metric job will run.
    hours List<String>
    Hours of the day when the metric job will run.
    minutes List<String>
    Minutes of the day when the metric job will run.
    months List<String>
    Months of the year when the metric job will run.

    CustomMetricFromJobTimestamp, CustomMetricFromJobTimestampArgs

    ColumnName string
    Column name.
    TimeFormat string
    Format.
    ColumnName string
    Column name.
    TimeFormat string
    Format.
    columnName String
    Column name.
    timeFormat String
    Format.
    columnName string
    Column name.
    timeFormat string
    Format.
    column_name str
    Column name.
    time_format str
    Format.
    columnName String
    Column name.
    timeFormat String
    Format.

    CustomMetricFromJobValue, CustomMetricFromJobValueArgs

    ColumnName string
    Column name.
    ColumnName string
    Column name.
    columnName String
    Column name.
    columnName string
    Column name.
    column_name str
    Column name.
    columnName String
    Column name.

    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