com.oracle.bmc.ailanguage.model

Class ModelSummary.Builder

java.lang.Object

com.oracle.bmc.ailanguage.model.ModelSummary.Builder

Enclosing class:

ModelSummary

public static class ModelSummary.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ModelSummary	build()
ModelSummary.Builder	compartmentId(String compartmentId) The OCID for the model’s compartment.
ModelSummary.Builder	copy(ModelSummary model)
ModelSummary.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
ModelSummary.Builder	description(String description) A short description of the Model.
ModelSummary.Builder	displayName(String displayName) A user-friendly display name for the resource.
ModelSummary.Builder	freeformTags(Map<String,String> freeformTags) Simple key-value pair that is applied without any predefined name, type or scope.
ModelSummary.Builder	id(String id) Unique identifier model OCID of a model that is immutable on creation
ModelSummary.Builder	lifecycleDetails(String lifecycleDetails) A message describing the current state in more detail.
ModelSummary.Builder	lifecycleState(Model.LifecycleState lifecycleState) The state of the model.
ModelSummary.Builder	modelDetails(ModelDetails modelDetails)
ModelSummary.Builder	projectId(String projectId) The OCID of the project to associate with the model.
ModelSummary.Builder	systemTags(Map<String,Map<String,Object>> systemTags) Usage of system tag keys.
ModelSummary.Builder	timeCreated(Date timeCreated) The time the the Model was created.
ModelSummary.Builder	version(String version) For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::«service-name>>_<<model-type-version»::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public ModelSummary.Builder id(String id)

Unique identifier model OCID of a model that is immutable on creation

Parameters:

id - the value to set

Returns:

this builder

displayName

public ModelSummary.Builder displayName(String displayName)

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Parameters:

displayName - the value to set

Returns:

this builder

compartmentId

public ModelSummary.Builder compartmentId(String compartmentId)

The OCID for the model’s compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder

description

public ModelSummary.Builder description(String description)

A short description of the Model.

Parameters:

description - the value to set

Returns:

this builder

modelDetails

public ModelSummary.Builder modelDetails(ModelDetails modelDetails)

timeCreated

public ModelSummary.Builder timeCreated(Date timeCreated)

The time the the Model was created. An RFC3339 formatted datetime string.

Parameters:

timeCreated - the value to set

Returns:

this builder

lifecycleState

public ModelSummary.Builder lifecycleState(Model.LifecycleState lifecycleState)

The state of the model.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public ModelSummary.Builder lifecycleDetails(String lifecycleDetails)

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

projectId

public ModelSummary.Builder projectId(String projectId)

The OCID of the project to associate with the model.

Parameters:

projectId - the value to set

Returns:

this builder

version

public ModelSummary.Builder version(String version)

For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::«service-name>>_<<model-type-version»::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0

Parameters:

version - the value to set

Returns:

this builder

freeformTags

public ModelSummary.Builder freeformTags(Map<String,String> freeformTags)

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public ModelSummary.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

public ModelSummary.Builder systemTags(Map<String,Map<String,Object>> systemTags)

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } }

Parameters:

systemTags - the value to set

Returns:

this builder

build

public ModelSummary build()

copy

public ModelSummary.Builder copy(ModelSummary model)