@Generated(value="OracleSDKGenerator",
comments="API Version: 20231130")
public final class ModelSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Summary of 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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ModelSummary.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ModelSummary(String id,
String compartmentId,
List<ModelCapability> capabilities,
Model.LifecycleState lifecycleState,
String lifecycleDetails,
String displayName,
String vendor,
String version,
Date timeCreated,
String baseModelId,
Model.Type type,
FineTuneDetails fineTuneDetails,
ModelMetrics modelMetrics,
Boolean isLongTermSupported,
Date timeDeprecated,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ModelSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getBaseModelId()
The OCID of the base model that’s used for fine-tuning.
|
List<ModelCapability> |
getCapabilities()
Describes what this model can be used for.
|
String |
getCompartmentId()
The compartment OCID for fine-tuned models.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
A user-friendly name.
|
FineTuneDetails |
getFineTuneDetails() |
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
An ID that uniquely identifies a pretrained or a fine-tuned model.
|
Boolean |
getIsLongTermSupported()
Whether a model is supported long-term.
|
String |
getLifecycleDetails()
A message describing the current state of the model with detail that can provide actionable
information.
|
Model.LifecycleState |
getLifecycleState()
The lifecycle state of the model.
|
ModelMetrics |
getModelMetrics() |
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The date and time that the model was created in the format of an RFC3339 datetime string.
|
Date |
getTimeDeprecated()
Corresponds to the time when the custom model and its associated foundation model will be
deprecated.
|
Model.Type |
getType()
The model type indicating whether this is a pretrained/base model or a custom/fine-tuned
model.
|
String |
getVendor()
The provider of the model.
|
String |
getVersion()
The version of the model.
|
int |
hashCode() |
ModelSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","compartmentId","capabilities","lifecycleState","lifecycleDetails","displayName","vendor","version","timeCreated","baseModelId","type","fineTuneDetails","modelMetrics","isLongTermSupported","timeDeprecated","freeformTags","definedTags","systemTags"}) public ModelSummary(String id, String compartmentId, List<ModelCapability> capabilities, Model.LifecycleState lifecycleState, String lifecycleDetails, String displayName, String vendor, String version, Date timeCreated, String baseModelId, Model.Type type, FineTuneDetails fineTuneDetails, ModelMetrics modelMetrics, Boolean isLongTermSupported, Date timeDeprecated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static ModelSummary.Builder builder()
Create a new builder.
public ModelSummary.Builder toBuilder()
public String getId()
An ID that uniquely identifies a pretrained or a fine-tuned model.
public String getCompartmentId()
The compartment OCID for fine-tuned models. For pretrained models, this value is null.
public List<ModelCapability> getCapabilities()
Describes what this model can be used for.
public Model.LifecycleState getLifecycleState()
The lifecycle state of the model.
Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED
public String getLifecycleDetails()
A message describing the current state of the model with detail that can provide actionable information.
public String getDisplayName()
A user-friendly name.
public String getVendor()
The provider of the model.
public String getVersion()
The version of the model.
public Date getTimeCreated()
The date and time that the model was created in the format of an RFC3339 datetime string.
public String getBaseModelId()
The OCID of the base model that’s used for fine-tuning. For pretrained models, the value is null.
public Model.Type getType()
The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.
Allowed values are: - BASE - CUSTOM
public FineTuneDetails getFineTuneDetails()
public ModelMetrics getModelMetrics()
public Boolean getIsLongTermSupported()
Whether a model is supported long-term. Applies only to base models.
public Date getTimeDeprecated()
Corresponds to the time when the custom model and its associated foundation model will be deprecated.
public Map<String,String> getFreeformTags()
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.