@lbrlabs/pulumi-grafana/machineLearningJob.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * A job defines the queries and model parameters for a machine learning task.
 */
export declare class MachineLearningJob extends pulumi.CustomResource {
    /**
     * Get an existing MachineLearningJob resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MachineLearningJobState, opts?: pulumi.CustomResourceOptions): MachineLearningJob;
    /**
     * Returns true if the given object is an instance of MachineLearningJob.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is MachineLearningJob;
    /**
     * An object representing the custom labels added on the forecast.
     */
    readonly customLabels: pulumi.Output<{
        [key: string]: any;
    } | undefined>;
    /**
     * The id of the datasource to query.
     */
    readonly datasourceId: pulumi.Output<number | undefined>;
    /**
     * The type of datasource being queried. Currently allowed values are prometheus, graphite, loki, postgres, and datadog.
     */
    readonly datasourceType: pulumi.Output<string>;
    /**
     * The uid of the datasource to query.
     */
    readonly datasourceUid: pulumi.Output<string | undefined>;
    /**
     * A description of the job.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * A list of holiday IDs or names to take into account when training the model.
     */
    readonly holidays: pulumi.Output<string[] | undefined>;
    /**
     * The hyperparameters used to fine tune the algorithm. See https://grafana.com/docs/grafana-cloud/machine-learning/models/ for the full list of available hyperparameters. Defaults to `map[]`.
     */
    readonly hyperParams: pulumi.Output<{
        [key: string]: any;
    } | undefined>;
    /**
     * The data interval in seconds to train the data on. Defaults to `300`.
     */
    readonly interval: pulumi.Output<number | undefined>;
    /**
     * The metric used to query the job results.
     */
    readonly metric: pulumi.Output<string>;
    /**
     * The name of the job.
     */
    readonly name: pulumi.Output<string>;
    /**
     * An object representing the query params to query Grafana with.
     */
    readonly queryParams: pulumi.Output<{
        [key: string]: any;
    }>;
    /**
     * The data interval in seconds to train the data on. Defaults to `7776000`.
     */
    readonly trainingWindow: pulumi.Output<number | undefined>;
    /**
     * Create a MachineLearningJob resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: MachineLearningJobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering MachineLearningJob resources.
 */
export interface MachineLearningJobState {
    /**
     * An object representing the custom labels added on the forecast.
     */
    customLabels?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The id of the datasource to query.
     */
    datasourceId?: pulumi.Input<number>;
    /**
     * The type of datasource being queried. Currently allowed values are prometheus, graphite, loki, postgres, and datadog.
     */
    datasourceType?: pulumi.Input<string>;
    /**
     * The uid of the datasource to query.
     */
    datasourceUid?: pulumi.Input<string>;
    /**
     * A description of the job.
     */
    description?: pulumi.Input<string>;
    /**
     * A list of holiday IDs or names to take into account when training the model.
     */
    holidays?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The hyperparameters used to fine tune the algorithm. See https://grafana.com/docs/grafana-cloud/machine-learning/models/ for the full list of available hyperparameters. Defaults to `map[]`.
     */
    hyperParams?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The data interval in seconds to train the data on. Defaults to `300`.
     */
    interval?: pulumi.Input<number>;
    /**
     * The metric used to query the job results.
     */
    metric?: pulumi.Input<string>;
    /**
     * The name of the job.
     */
    name?: pulumi.Input<string>;
    /**
     * An object representing the query params to query Grafana with.
     */
    queryParams?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The data interval in seconds to train the data on. Defaults to `7776000`.
     */
    trainingWindow?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a MachineLearningJob resource.
 */
export interface MachineLearningJobArgs {
    /**
     * An object representing the custom labels added on the forecast.
     */
    customLabels?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The id of the datasource to query.
     */
    datasourceId?: pulumi.Input<number>;
    /**
     * The type of datasource being queried. Currently allowed values are prometheus, graphite, loki, postgres, and datadog.
     */
    datasourceType: pulumi.Input<string>;
    /**
     * The uid of the datasource to query.
     */
    datasourceUid?: pulumi.Input<string>;
    /**
     * A description of the job.
     */
    description?: pulumi.Input<string>;
    /**
     * A list of holiday IDs or names to take into account when training the model.
     */
    holidays?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The hyperparameters used to fine tune the algorithm. See https://grafana.com/docs/grafana-cloud/machine-learning/models/ for the full list of available hyperparameters. Defaults to `map[]`.
     */
    hyperParams?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The data interval in seconds to train the data on. Defaults to `300`.
     */
    interval?: pulumi.Input<number>;
    /**
     * The metric used to query the job results.
     */
    metric: pulumi.Input<string>;
    /**
     * The name of the job.
     */
    name?: pulumi.Input<string>;
    /**
     * An object representing the query params to query Grafana with.
     */
    queryParams: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * The data interval in seconds to train the data on. Defaults to `7776000`.
     */
    trainingWindow?: pulumi.Input<number>;
}