All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.ml.kotlin.EngineModel.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.ml.kotlin

import com.pulumi.core.Output
import com.pulumi.gcp.ml.kotlin.outputs.EngineModelDefaultVersion
import com.pulumi.gcp.ml.kotlin.outputs.EngineModelDefaultVersion.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map

/**
 * Builder for [EngineModel].
 */
@PulumiTagMarker
public class EngineModelResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: EngineModelArgs = EngineModelArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend EngineModelArgsBuilder.() -> Unit) {
        val builder = EngineModelArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): EngineModel {
        val builtJavaResource = com.pulumi.gcp.ml.EngineModel(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return EngineModel(builtJavaResource)
    }
}

/**
 * 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",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * default = gcp.ml.EngineModel("default",
 *     name="default",
 *     description="My model",
 *     regions="us-central1")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var @default = new Gcp.ML.EngineModel("default", new()
 *     {
 *         Name = "default",
 *         Description = "My model",
 *         Regions = "us-central1",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/ml"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := ml.NewEngineModel(ctx, "default", &ml.EngineModelArgs{
 * 			Name:        pulumi.String("default"),
 * 			Description: pulumi.String("My model"),
 * 			Regions:     pulumi.String("us-central1"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.gcp.ml.EngineModel;
 * import com.pulumi.gcp.ml.EngineModelArgs;
 * 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 default_ = new EngineModel("default", EngineModelArgs.builder()
 *             .name("default")
 *             .description("My model")
 *             .regions("us-central1")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   default:
 *     type: gcp:ml:EngineModel
 *     properties:
 *       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,
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * default = gcp.ml.EngineModel("default",
 *     name="default",
 *     description="My model",
 *     regions="us-central1",
 *     labels={
 *         "my_model": "foo",
 *     },
 *     online_prediction_logging=True,
 *     online_prediction_console_logging=True)
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var @default = new Gcp.ML.EngineModel("default", new()
 *     {
 *         Name = "default",
 *         Description = "My model",
 *         Regions = "us-central1",
 *         Labels =
 *         {
 *             { "my_model", "foo" },
 *         },
 *         OnlinePredictionLogging = true,
 *         OnlinePredictionConsoleLogging = true,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/ml"
 * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 * )
 * func main() {
 * 	pulumi.Run(func(ctx *pulumi.Context) error {
 * 		_, err := ml.NewEngineModel(ctx, "default", &ml.EngineModelArgs{
 * 			Name:        pulumi.String("default"),
 * 			Description: pulumi.String("My model"),
 * 			Regions:     pulumi.String("us-central1"),
 * 			Labels: pulumi.StringMap{
 * 				"my_model": pulumi.String("foo"),
 * 			},
 * 			OnlinePredictionLogging:        pulumi.Bool(true),
 * 			OnlinePredictionConsoleLogging: pulumi.Bool(true),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		return nil
 * 	})
 * }
 * ```
 * ```java
 * package generated_program;
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.gcp.ml.EngineModel;
 * import com.pulumi.gcp.ml.EngineModelArgs;
 * 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 default_ = new EngineModel("default", EngineModelArgs.builder()
 *             .name("default")
 *             .description("My model")
 *             .regions("us-central1")
 *             .labels(Map.of("my_model", "foo"))
 *             .onlinePredictionLogging(true)
 *             .onlinePredictionConsoleLogging(true)
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   default:
 *     type: gcp:ml:EngineModel
 *     properties:
 *       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}}
 * ```
 */
public class EngineModel internal constructor(
    override val javaResource: com.pulumi.gcp.ml.EngineModel,
) : KotlinCustomResource(javaResource, EngineModelMapper) {
    /**
     * 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.
     */
    public val defaultVersion: Output?
        get() = javaResource.defaultVersion().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> toKotlin(args0) })
            }).orElse(null)
        })

    /**
     * The description specified for the model when it was created.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
     */
    public val effectiveLabels: Output>
        get() = javaResource.effectiveLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * 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 `effective_labels` for all of the labels present on the resource.
     */
    public val labels: Output>?
        get() = javaResource.labels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.key.to(args0.value)
                }).toMap()
            }).orElse(null)
        })

    /**
     * The name specified for the model.
     * - - -
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging
     */
    public val onlinePredictionConsoleLogging: Output?
        get() = javaResource.onlinePredictionConsoleLogging().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * If true, online prediction access logs are sent to StackDriver Logging.
     */
    public val onlinePredictionLogging: Output?
        get() = javaResource.onlinePredictionLogging().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    public val project: Output
        get() = javaResource.project().applyValue({ args0 -> args0 })

    /**
     * The combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    public val pulumiLabels: Output>
        get() = javaResource.pulumiLabels().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.key.to(args0.value)
            }).toMap()
        })

    /**
     * The list of regions where the model is going to be deployed.
     * Currently only one region per model is supported
     */
    public val regions: Output?
        get() = javaResource.regions().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}

public object EngineModelMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.ml.EngineModel::class == javaResource::class

    override fun map(javaResource: Resource): EngineModel = EngineModel(
        javaResource as
            com.pulumi.gcp.ml.EngineModel,
    )
}

/**
 * @see [EngineModel].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [EngineModel].
 */
public suspend fun engineModel(name: String, block: suspend EngineModelResourceBuilder.() -> Unit): EngineModel {
    val builder = EngineModelResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [EngineModel].
 * @param name The _unique_ name of the resulting resource.
 */
public fun engineModel(name: String): EngineModel {
    val builder = EngineModelResourceBuilder()
    builder.name(name)
    return builder.build()
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy