Package com.oracle.bmc.datascience.model

Class CreateModelDetails

java.lang.Object

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

com.oracle.bmc.datascience.model.CreateModelDetails

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

Parameters needed to create a new model.

Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifact.
Note: Objects should always be created or deserialized using the CreateModelDetails.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 CreateModelDetails.Builder, which maintain a set of all explicitly set fields called CreateModelDetails.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	CreateModelDetails.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
CreateModelDetails(String compartmentId, String projectId, String displayName, String description, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<Metadata> customMetadataList, List<Metadata> definedMetadataList, String inputSchema, String outputSchema, String modelVersionSetId, String versionLabel, RetentionSetting retentionSetting, BackupSetting backupSetting)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateModelDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
BackupSetting	getBackupSetting()
String	getCompartmentId()	The OCID of the compartment to create the model in.
List<Metadata>	getCustomMetadataList()	An array of custom metadata details for the model.
List<Metadata>	getDefinedMetadataList()	An array of defined metadata details for the model.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	A short description of the model.
String	getDisplayName()	A user-friendly display name for the resource.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
String	getInputSchema()	Input schema file content in String format
String	getModelVersionSetId()	The OCID of the model version set that the model is associated to.
String	getOutputSchema()	Output schema file content in String format
String	getProjectId()	The OCID of the project to associate with the model.
RetentionSetting	getRetentionSetting()
String	getVersionLabel()	The version label can add an additional description of the lifecycle state of the model or the application using/training the model.
int	hashCode()
CreateModelDetails.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

CreateModelDetails

@Deprecated
@ConstructorProperties({"compartmentId","projectId","displayName","description","freeformTags","definedTags","customMetadataList","definedMetadataList","inputSchema","outputSchema","modelVersionSetId","versionLabel","retentionSetting","backupSetting"})
public CreateModelDetails(String compartmentId,
                          String projectId,
                          String displayName,
                          String description,
                          Map<String,String> freeformTags,
                          Map<String,Map<String,Object>> definedTags,
                          List<Metadata> customMetadataList,
                          List<Metadata> definedMetadataList,
                          String inputSchema,
                          String outputSchema,
                          String modelVersionSetId,
                          String versionLabel,
                          RetentionSetting retentionSetting,
                          BackupSetting backupSetting)

Deprecated.

Method Detail

builder

public static CreateModelDetails.Builder builder()

Create a new builder.

toBuilder

public CreateModelDetails.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to create the model in.

Returns:

the value

getProjectId

public String getProjectId()

The OCID of the project to associate with the model.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly display name for the resource.

It does not have to be unique and can be modified. Avoid entering confidential information. Example: My Model

Returns:

the value

getDescription

public String getDescription()

A short description of the model.

Returns:

the value

getFreeformTags

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. See Resource Tags. Example: {“Department”: “Finance”}

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. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:

the value

getCustomMetadataList

public List<Metadata> getCustomMetadataList()

An array of custom metadata details for the model.

Returns:

the value

getDefinedMetadataList

public List<Metadata> getDefinedMetadataList()

An array of defined metadata details for the model.

Returns:

the value

getInputSchema

public String getInputSchema()

Input schema file content in String format

Returns:

the value

getOutputSchema

public String getOutputSchema()

Output schema file content in String format

Returns:

the value

getModelVersionSetId

public String getModelVersionSetId()

The OCID of the model version set that the model is associated to.

Returns:

the value

getVersionLabel

public String getVersionLabel()

The version label can add an additional description of the lifecycle state of the model or the application using/training the model.

Returns:

the value

getRetentionSetting

public RetentionSetting getRetentionSetting()

getBackupSetting

public BackupSetting getBackupSetting()

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