Class protos.google.cloud.aiplatform.v1.Model (3.13.0)

Represents a Model.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IModel);

Constructs a new Model.

Parameter
NameDescription
properties IModel

Properties to set

Properties

artifactUri

public artifactUri: string;

Model artifactUri.

containerSpec

public containerSpec?: (google.cloud.aiplatform.v1.IModelContainerSpec|null);

Model containerSpec.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Model createTime.

dataStats

public dataStats?: (google.cloud.aiplatform.v1.Model.IDataStats|null);

Model dataStats.

deployedModels

public deployedModels: google.cloud.aiplatform.v1.IDeployedModelRef[];

Model deployedModels.

description

public description: string;

Model description.

displayName

public displayName: string;

Model displayName.

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);

Model encryptionSpec.

etag

public etag: string;

Model etag.

explanationSpec

public explanationSpec?: (google.cloud.aiplatform.v1.IExplanationSpec|null);

Model explanationSpec.

labels

public labels: { [k: string]: string };

Model labels.

metadata

public metadata?: (google.protobuf.IValue|null);

Model metadata.

metadataArtifact

public metadataArtifact: string;

Model metadataArtifact.

metadataSchemaUri

public metadataSchemaUri: string;

Model metadataSchemaUri.

modelSourceInfo

public modelSourceInfo?: (google.cloud.aiplatform.v1.IModelSourceInfo|null);

Model modelSourceInfo.

name

public name: string;

Model name.

originalModelInfo

public originalModelInfo?: (google.cloud.aiplatform.v1.Model.IOriginalModelInfo|null);

Model originalModelInfo.

pipelineJob

public pipelineJob: string;

Model pipelineJob.

predictSchemata

public predictSchemata?: (google.cloud.aiplatform.v1.IPredictSchemata|null);

Model predictSchemata.

supportedDeploymentResourcesTypes

public supportedDeploymentResourcesTypes: google.cloud.aiplatform.v1.Model.DeploymentResourcesType[];

Model supportedDeploymentResourcesTypes.

supportedExportFormats

public supportedExportFormats: google.cloud.aiplatform.v1.Model.IExportFormat[];

Model supportedExportFormats.

supportedInputStorageFormats

public supportedInputStorageFormats: string[];

Model supportedInputStorageFormats.

supportedOutputStorageFormats

public supportedOutputStorageFormats: string[];

Model supportedOutputStorageFormats.

trainingPipeline

public trainingPipeline: string;

Model trainingPipeline.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Model updateTime.

versionAliases

public versionAliases: string[];

Model versionAliases.

versionCreateTime

public versionCreateTime?: (google.protobuf.ITimestamp|null);

Model versionCreateTime.

versionDescription

public versionDescription: string;

Model versionDescription.

versionId

public versionId: string;

Model versionId.

versionUpdateTime

public versionUpdateTime?: (google.protobuf.ITimestamp|null);

Model versionUpdateTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IModel): google.cloud.aiplatform.v1.Model;

Creates a new Model instance using the specified properties.

Parameter
NameDescription
properties IModel

Properties to set

Returns
TypeDescription
Model

Model instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Model;

Decodes a Model message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Model

Model

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Model;

Decodes a Model message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Model

Model

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IModel, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Model message. Does not implicitly messages.

Parameters
NameDescription
message IModel

Model message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1.IModel, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Model message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IModel

Model message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Model;

Creates a Model message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Model

Model

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Model

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Model to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.Model, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Model message. Also converts values to other types if specified.

Parameters
NameDescription
message Model

Model

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Model message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not