@pulumi/gcp/ml/engineModel.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Represents a machine learning solution.
 *
 * A model can have multiple versions, each of which is a deployed, trained model
 * ready to receive prediction requests. The model itself is just a container.
 *
 * To get more information about Model, see:
 *
 * * [API documentation](https://cloud.google.com/ai-platform/prediction/docs/reference/rest/v1/projects.models)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/ai-platform/prediction/docs/deploying-models)
 *
 * ## Example Usage
 *
 * ### Ml Model Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.ml.EngineModel("default", {
 *     name: "default",
 *     description: "My model",
 *     regions: "us-central1",
 * });
 * ```
 * ### Ml Model Full
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.ml.EngineModel("default", {
 *     name: "default",
 *     description: "My model",
 *     regions: "us-central1",
 *     labels: {
 *         my_model: "foo",
 *     },
 *     onlinePredictionLogging: true,
 *     onlinePredictionConsoleLogging: true,
 * });
 * ```
 *
 * ## Import
 *
 * Model can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/models/{{name}}`
 *
 * * `{{project}}/{{name}}`
 *
 * * `{{name}}`
 *
 * When using the `pulumi import` command, Model can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:ml/engineModel:EngineModel default projects/{{project}}/models/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:ml/engineModel:EngineModel default {{project}}/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:ml/engineModel:EngineModel default {{name}}
 * ```
 */
export declare class EngineModel extends pulumi.CustomResource {
    /**
     * Get an existing EngineModel 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?: EngineModelState, opts?: pulumi.CustomResourceOptions): EngineModel;
    /**
     * Returns true if the given object is an instance of EngineModel.  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 EngineModel;
    /**
     * The default version of the model. This version will be used to handle
     * prediction requests that do not specify a version.
     * Structure is documented below.
     */
    readonly defaultVersion: pulumi.Output<outputs.ml.EngineModelDefaultVersion | undefined>;
    /**
     * The description specified for the model when it was created.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    readonly effectiveLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * One or more labels that you can add, to organize your models.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    readonly labels: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The name specified for the model.
     *
     *
     * - - -
     */
    readonly name: pulumi.Output<string>;
    /**
     * If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging
     */
    readonly onlinePredictionConsoleLogging: pulumi.Output<boolean | undefined>;
    /**
     * If true, online prediction access logs are sent to StackDriver Logging.
     */
    readonly onlinePredictionLogging: pulumi.Output<boolean | undefined>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * The list of regions where the model is going to be deployed.
     * Currently only one region per model is supported
     */
    readonly regions: pulumi.Output<string | undefined>;
    /**
     * Create a EngineModel 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?: EngineModelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering EngineModel resources.
 */
export interface EngineModelState {
    /**
     * The default version of the model. This version will be used to handle
     * prediction requests that do not specify a version.
     * Structure is documented below.
     */
    defaultVersion?: pulumi.Input<inputs.ml.EngineModelDefaultVersion>;
    /**
     * The description specified for the model when it was created.
     */
    description?: pulumi.Input<string>;
    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    effectiveLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * One or more labels that you can add, to organize your models.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The name specified for the model.
     *
     *
     * - - -
     */
    name?: pulumi.Input<string>;
    /**
     * If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging
     */
    onlinePredictionConsoleLogging?: pulumi.Input<boolean>;
    /**
     * If true, online prediction access logs are sent to StackDriver Logging.
     */
    onlinePredictionLogging?: pulumi.Input<boolean>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The list of regions where the model is going to be deployed.
     * Currently only one region per model is supported
     */
    regions?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a EngineModel resource.
 */
export interface EngineModelArgs {
    /**
     * The default version of the model. This version will be used to handle
     * prediction requests that do not specify a version.
     * Structure is documented below.
     */
    defaultVersion?: pulumi.Input<inputs.ml.EngineModelDefaultVersion>;
    /**
     * The description specified for the model when it was created.
     */
    description?: pulumi.Input<string>;
    /**
     * One or more labels that you can add, to organize your models.
     * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
     * Please refer to the field `effectiveLabels` for all of the labels present on the resource.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The name specified for the model.
     *
     *
     * - - -
     */
    name?: pulumi.Input<string>;
    /**
     * If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging
     */
    onlinePredictionConsoleLogging?: pulumi.Input<boolean>;
    /**
     * If true, online prediction access logs are sent to StackDriver Logging.
     */
    onlinePredictionLogging?: pulumi.Input<boolean>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The list of regions where the model is going to be deployed.
     * Currently only one region per model is supported
     */
    regions?: pulumi.Input<string>;
}