Package com.oracle.bmc.aivision.model

Class ModelSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.aivision.model.ModelSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220125")
public final class ModelSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The metadata about the model.
Note: Objects should always be created or deserialized using the ModelSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ModelSummary.Builder, which maintain a set of all explicitly set fields called ModelSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModelSummary.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor

Description

ModelSummary(String id, String displayName, String description, String compartmentId, Model.ModelType modelType, String modelVersion, String projectId, Date timeCreated, Date timeUpdated, Model.LifecycleState lifecycleState, String lifecycleDetails, Float precision, Dataset trainingDataset, Dataset testingDataset, Dataset validationDataset, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static ModelSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The compartment identifier.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	An optional description of the model.
String	getDisplayName()	A human-friendly name for the model, which can be changed.
Map<String,String>	getFreeformTags()	A simple key-value pair that is applied without any predefined name, type, or scope.
String	getId()	A unique identifier that is immutable after creation.
String	getLifecycleDetails()	A message describing the current state in more detail, that can provide actionable information if training failed.
Model.LifecycleState	getLifecycleState()	The current state of the model.
Model.ModelType	getModelType()	What type of Vision model this is.
String	getModelVersion()	The version of the model.
Float	getPrecision()	The precision of the trained model.
String	getProjectId()	The OCID of the project that contains the model.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Dataset	getTestingDataset()
Date	getTimeCreated()	When the model was created, as an RFC3339 datetime string.
Date	getTimeUpdated()	When the model was modified, as an RFC3339 datetime string.
Dataset	getTrainingDataset()
Dataset	getValidationDataset()
int	hashCode()
ModelSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelSummary

@Deprecated
@ConstructorProperties({"id","displayName","description","compartmentId","modelType","modelVersion","projectId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","precision","trainingDataset","testingDataset","validationDataset","freeformTags","definedTags","systemTags"})
public ModelSummary(String id,
                    String displayName,
                    String description,
                    String compartmentId,
                    Model.ModelType modelType,
                    String modelVersion,
                    String projectId,
                    Date timeCreated,
                    Date timeUpdated,
                    Model.LifecycleState lifecycleState,
                    String lifecycleDetails,
                    Float precision,
                    Dataset trainingDataset,
                    Dataset testingDataset,
                    Dataset validationDataset,
                    Map<String,String> freeformTags,
                    Map<String,Map<String,Object>> definedTags,
                    Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ModelSummary.Builder builder()

Create a new builder.

toBuilder

public ModelSummary.Builder toBuilder()

getId

public String getId()

A unique identifier that is immutable after creation.

Returns:

the value

getDisplayName

public String getDisplayName()

A human-friendly name for the model, which can be changed.

Returns:

the value

getDescription

public String getDescription()

An optional description of the model.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The compartment identifier.

Returns:

the value

getModelType

public Model.ModelType getModelType()

What type of Vision model this is.

Returns:

the value

getModelVersion

public String getModelVersion()

The version of the model.

Returns:

the value

getProjectId

public String getProjectId()

The OCID of the project that contains the model.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

When the model was created, as an RFC3339 datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

When the model was modified, as an RFC3339 datetime string.

Returns:

the value

getLifecycleState

public Model.LifecycleState getLifecycleState()

The current state of the model.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

A message describing the current state in more detail, that can provide actionable information if training failed.

Returns:

the value

getPrecision

public Float getPrecision()

The precision of the trained model.

Returns:

the value

getTrainingDataset

public Dataset getTrainingDataset()

getTestingDataset

public Dataset getTestingDataset()

getValidationDataset

public Dataset getValidationDataset()

getFreeformTags

public Map<String,String> getFreeformTags()

A simple key-value pair that is applied without any predefined name, type, or scope.

It exists for cross-compatibility only. For example: {“bar-key”: “value”}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

These predefined keys are scoped to namespaces. For example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel