Model Class

Package:

com.azure.resourcemanager.machinelearningservices.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-machinelearningservices:1.0.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.machinelearningservices.models.Model

public final class Model

An Azure Machine Learning Model.

Constructor Summary

Constructor	Description
Model()

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	createdTime() Get the createdTime property: The Model creation time (UTC).
List<DatasetReference>	datasets() Get the datasets property: The list of datasets associated with the model.
List<String>	derivedModelIds() Get the derivedModelIds property: Models derived from this model.
String	description() Get the description property: The Model description text.
String	experimentName() Get the experimentName property: The name of the experiment where this model was created.
String	framework() Get the framework property: The Model framework.
String	frameworkVersion() Get the frameworkVersion property: The Model framework version.
String	id() Get the id property: The Model Id.
Map<String,String>	kvTags() Get the kvTags property: The Model tag dictionary.
String	mimeType() Get the mimeType property: The MIME type of Model content.
OffsetDateTime	modifiedTime() Get the modifiedTime property: The Model last modified time (UTC).
String	name() Get the name property: The Model name.
String	parentModelId() Get the parentModelId property: The Parent Model Id.
Map<String,String>	properties() Get the properties property: The Model property dictionary.
ContainerResourceRequirements	resourceRequirements() Get the resourceRequirements property: Resource requirements for the model.
String	runId() Get the runId property: The RunId that created this model.
String	sampleInputData() Get the sampleInputData property: Sample Input Data for the Model.
String	sampleOutputData() Get the sampleOutputData property: Sample Output Data for the Model.
Boolean	unpack() Get the unpack property: Indicates whether we need to unpack the Model during docker Image creation.
String	url() Get the url property: The URL of the Model.
void	validate() Validates the instance.
Long	version() Get the version property: The Model version assigned by Model Management Service.
Model	withCreatedTime(OffsetDateTime createdTime) Set the createdTime property: The Model creation time (UTC).
Model	withDatasets(List<DatasetReference> datasets) Set the datasets property: The list of datasets associated with the model.
Model	withDerivedModelIds(List<String> derivedModelIds) Set the derivedModelIds property: Models derived from this model.
Model	withDescription(String description) Set the description property: The Model description text.
Model	withExperimentName(String experimentName) Set the experimentName property: The name of the experiment where this model was created.
Model	withFramework(String framework) Set the framework property: The Model framework.
Model	withFrameworkVersion(String frameworkVersion) Set the frameworkVersion property: The Model framework version.
Model	withId(String id) Set the id property: The Model Id.
Model	withKvTags(Map<String,String> kvTags) Set the kvTags property: The Model tag dictionary.
Model	withMimeType(String mimeType) Set the mimeType property: The MIME type of Model content.
Model	withModifiedTime(OffsetDateTime modifiedTime) Set the modifiedTime property: The Model last modified time (UTC).
Model	withName(String name) Set the name property: The Model name.
Model	withParentModelId(String parentModelId) Set the parentModelId property: The Parent Model Id.
Model	withProperties(Map<String,String> properties) Set the properties property: The Model property dictionary.
Model	withResourceRequirements(ContainerResourceRequirements resourceRequirements) Set the resourceRequirements property: Resource requirements for the model.
Model	withRunId(String runId) Set the runId property: The RunId that created this model.
Model	withSampleInputData(String sampleInputData) Set the sampleInputData property: Sample Input Data for the Model.
Model	withSampleOutputData(String sampleOutputData) Set the sampleOutputData property: Sample Output Data for the Model.
Model	withUnpack(Boolean unpack) Set the unpack property: Indicates whether we need to unpack the Model during docker Image creation.
Model	withUrl(String url) Set the url property: The URL of the Model.
Model	withVersion(Long version) Set the version property: The Model version assigned by Model Management Service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Model

public Model()

Method Details

createdTime

public OffsetDateTime createdTime()

Get the createdTime property: The Model creation time (UTC).

Returns:

the createdTime value.

datasets

public List datasets()

Get the datasets property: The list of datasets associated with the model.

Returns:

the datasets value.

derivedModelIds

public List derivedModelIds()

Get the derivedModelIds property: Models derived from this model.

Returns:

the derivedModelIds value.

description

public String description()

Get the description property: The Model description text.

Returns:

the description value.

experimentName

public String experimentName()

Get the experimentName property: The name of the experiment where this model was created.

Returns:

the experimentName value.

framework

public String framework()

Get the framework property: The Model framework.

Returns:

the framework value.

frameworkVersion

public String frameworkVersion()

Get the frameworkVersion property: The Model framework version.

Returns:

the frameworkVersion value.

id

public String id()

Get the id property: The Model Id.

Returns:

the id value.

kvTags

public Map kvTags()

Get the kvTags property: The Model tag dictionary. Items are mutable.

Returns:

the kvTags value.

mimeType

public String mimeType()

Get the mimeType property: The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml.

Returns:

the mimeType value.

modifiedTime

public OffsetDateTime modifiedTime()

Get the modifiedTime property: The Model last modified time (UTC).

Returns:

the modifiedTime value.

name

public String name()

Get the name property: The Model name.

Returns:

the name value.

parentModelId

public String parentModelId()

Get the parentModelId property: The Parent Model Id.

Returns:

the parentModelId value.

properties

public Map properties()

Get the properties property: The Model property dictionary. Properties are immutable.

Returns:

the properties value.

resourceRequirements

public ContainerResourceRequirements resourceRequirements()

Get the resourceRequirements property: Resource requirements for the model.

Returns:

the resourceRequirements value.

runId

public String runId()

Get the runId property: The RunId that created this model.

Returns:

the runId value.

sampleInputData

public String sampleInputData()

Get the sampleInputData property: Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}.

Returns:

the sampleInputData value.

sampleOutputData

public String sampleOutputData()

Get the sampleOutputData property: Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}.

Returns:

the sampleOutputData value.

unpack

public Boolean unpack()

Get the unpack property: Indicates whether we need to unpack the Model during docker Image creation.

Returns:

the unpack value.

url

public String url()

Get the url property: The URL of the Model. Usually a SAS URL.

Returns:

the url value.

validate

public void validate()

Validates the instance.

version

public Long version()

Get the version property: The Model version assigned by Model Management Service.

Returns:

the version value.

withCreatedTime

public Model withCreatedTime(OffsetDateTime createdTime)

Set the createdTime property: The Model creation time (UTC).

Parameters:

createdTime - the createdTime value to set.

Returns:

the Model object itself.

withDatasets

public Model withDatasets(List datasets)

Set the datasets property: The list of datasets associated with the model.

Parameters:

datasets - the datasets value to set.

Returns:

the Model object itself.

withDerivedModelIds

public Model withDerivedModelIds(List derivedModelIds)

Set the derivedModelIds property: Models derived from this model.

Parameters:

derivedModelIds - the derivedModelIds value to set.

Returns:

the Model object itself.

withDescription

public Model withDescription(String description)

Set the description property: The Model description text.

Parameters:

description - the description value to set.

Returns:

the Model object itself.

withExperimentName

public Model withExperimentName(String experimentName)

Set the experimentName property: The name of the experiment where this model was created.

Parameters:

experimentName - the experimentName value to set.

Returns:

the Model object itself.

withFramework

public Model withFramework(String framework)

Set the framework property: The Model framework.

Parameters:

framework - the framework value to set.

Returns:

the Model object itself.

withFrameworkVersion

public Model withFrameworkVersion(String frameworkVersion)

Set the frameworkVersion property: The Model framework version.

Parameters:

frameworkVersion - the frameworkVersion value to set.

Returns:

the Model object itself.

withId

public Model withId(String id)

Set the id property: The Model Id.

Parameters:

id - the id value to set.

Returns:

the Model object itself.

withKvTags

public Model withKvTags(Map kvTags)

Set the kvTags property: The Model tag dictionary. Items are mutable.

Parameters:

kvTags - the kvTags value to set.

Returns:

the Model object itself.

withMimeType

public Model withMimeType(String mimeType)

Set the mimeType property: The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml.

Parameters:

mimeType - the mimeType value to set.

Returns:

the Model object itself.

withModifiedTime

public Model withModifiedTime(OffsetDateTime modifiedTime)

Set the modifiedTime property: The Model last modified time (UTC).

Parameters:

modifiedTime - the modifiedTime value to set.

Returns:

the Model object itself.

withName

public Model withName(String name)

Set the name property: The Model name.

Parameters:

name - the name value to set.

Returns:

the Model object itself.

withParentModelId

public Model withParentModelId(String parentModelId)

Set the parentModelId property: The Parent Model Id.

Parameters:

parentModelId - the parentModelId value to set.

Returns:

the Model object itself.

withProperties

public Model withProperties(Map properties)

Set the properties property: The Model property dictionary. Properties are immutable.

Parameters:

properties - the properties value to set.

Returns:

the Model object itself.

withResourceRequirements

public Model withResourceRequirements(ContainerResourceRequirements resourceRequirements)

Set the resourceRequirements property: Resource requirements for the model.

Parameters:

resourceRequirements - the resourceRequirements value to set.

Returns:

the Model object itself.

withRunId

public Model withRunId(String runId)

Set the runId property: The RunId that created this model.

Parameters:

runId - the runId value to set.

Returns:

the Model object itself.

withSampleInputData

public Model withSampleInputData(String sampleInputData)

Set the sampleInputData property: Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}.

Parameters:

sampleInputData - the sampleInputData value to set.

Returns:

the Model object itself.

withSampleOutputData

public Model withSampleOutputData(String sampleOutputData)

Set the sampleOutputData property: Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}.

Parameters:

sampleOutputData - the sampleOutputData value to set.

Returns:

the Model object itself.

withUnpack

public Model withUnpack(Boolean unpack)

Set the unpack property: Indicates whether we need to unpack the Model during docker Image creation.

Parameters:

unpack - the unpack value to set.

Returns:

the Model object itself.

withUrl

public Model withUrl(String url)

Set the url property: The URL of the Model. Usually a SAS URL.

Parameters:

url - the url value to set.

Returns:

the Model object itself.

withVersion

public Model withVersion(Long version)

Set the version property: The Model version assigned by Model Management Service.

Parameters:

version - the version value to set.

Returns:

the Model object itself.