EngineModel class

> Warning: This resource is deprecated at the API level and will be removed in a future version of Terraform.

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
• How-to Guides
• Official Documentation

Example Usage

Ml Model Basic

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",
});

import pulumi
import pulumi_gcp as gcp

default = gcp.ml.EngineModel("default",
    name="default",
    description="My model",
    regions="us-central1")

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",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_ml_enginemodel" "default" {
  name        = "default"
  description = "My model"
  regions     = "us-central1"
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

resources:
  default:
    type: gcp:ml:EngineModel
    properties:
      name: default
      description: My model
      regions: us-central1

Ml Model Full

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

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,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "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
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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:

$ pulumi import gcp:ml/engineModel:EngineModel default projects/{{project}}/models/{{name}}
$ pulumi import gcp:ml/engineModel:EngineModel default {{project}}/{{name}}
$ pulumi import gcp:ml/engineModel:EngineModel default {{name}}

Constructors

EngineModel(String name, {EngineModelArgs? args, CustomResourceOptions? options})

Creates a new EngineModel. name The Pulumi resource name. args Arguments used to configure this EngineModel. The set of arguments for EngineModel. options Resource options controlling this resource's behavior.

EngineModel.reference(String urn)

Creates a typed reference to an existing EngineModel resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

defaultVersion ↔ Output<EngineModelDefaultVersion?>

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.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

The description specified for the model when it was created.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<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.

late, final

name ↔ Output<String>

The name specified for the model.

late, final

onlinePredictionConsoleLogging ↔ Output<bool?>

If true, online prediction nodes send stderr and stdout streams to Stackdriver Logging

late, final

onlinePredictionLogging ↔ Output<bool?>

If true, online prediction access logs are sent to StackDriver Logging.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

regions ↔ Output<String?>

The list of regions where the model is going to be deployed. Currently only one region per model is supported

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {EngineModelState? state, CustomResourceOptions? options}) → EngineModel

Gets an existing EngineModel resource's state with the given name and id.