@Generated(value="OracleSDKGenerator", comments="API Version: 20211001") public final class Dataset extends Object
A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record’s source, format, the type of annotations allowed for the record, and the labels allowed on annotations.
Dataset.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 Dataset.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
Dataset.Builder |
static class |
Dataset.LifecycleState
The state of a dataset.
|
| Constructor and Description |
|---|
Dataset(String id,
String displayName,
String compartmentId,
String description,
Date timeCreated,
Date timeUpdated,
Dataset.LifecycleState lifecycleState,
String lifecycleDetails,
String annotationFormat,
DatasetSourceDetails datasetSourceDetails,
DatasetFormatDetails datasetFormatDetails,
LabelSet labelSet,
InitialRecordGenerationConfiguration initialRecordGenerationConfiguration,
String labelingInstructions,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Dataset.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getAnnotationFormat()
The annotation format name required for labeling records.
|
String |
getCompartmentId()
The OCID of the compartment of the resource.
|
DatasetFormatDetails |
getDatasetFormatDetails() |
DatasetSourceDetails |
getDatasetSourceDetails() |
Map<String,Map<String,Object>> |
getDefinedTags()
The defined tags for this resource.
|
String |
getDescription()
A user-provided description of the dataset
|
String |
getDisplayName()
A user-friendly display name for the resource.
|
Map<String,String> |
getFreeformTags()
A simple key-value pair that is applied without any predefined name, type, or scope.
|
String |
getId()
The OCID of the dataset.
|
InitialRecordGenerationConfiguration |
getInitialRecordGenerationConfiguration() |
String |
getLabelingInstructions()
The labeling instructions for human labelers in rich text format
|
LabelSet |
getLabelSet() |
String |
getLifecycleDetails()
A message describing the current state in more detail.
|
Dataset.LifecycleState |
getLifecycleState()
The state of a dataset.
|
Map<String,Map<String,Object>> |
getSystemTags()
The usage of system tag keys.
|
Date |
getTimeCreated()
The date and time the resource was created, in the timestamp format defined by RFC3339.
|
Date |
getTimeUpdated()
The date and time the resource was updated, in the timestamp format defined by RFC3339.
|
int |
hashCode() |
Dataset.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","displayName","compartmentId","description","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","annotationFormat","datasetSourceDetails","datasetFormatDetails","labelSet","initialRecordGenerationConfiguration","labelingInstructions","freeformTags","definedTags","systemTags"}) @Deprecated public Dataset(String id, String displayName, String compartmentId, String description, Date timeCreated, Date timeUpdated, Dataset.LifecycleState lifecycleState, String lifecycleDetails, String annotationFormat, DatasetSourceDetails datasetSourceDetails, DatasetFormatDetails datasetFormatDetails, LabelSet labelSet, InitialRecordGenerationConfiguration initialRecordGenerationConfiguration, String labelingInstructions, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static Dataset.Builder builder()
Create a new builder.
public Dataset.Builder toBuilder()
public String getId()
The OCID of the dataset.
public String getDisplayName()
A user-friendly display name for the resource.
public String getCompartmentId()
The OCID of the compartment of the resource.
public String getDescription()
A user-provided description of the dataset
public Date getTimeCreated()
The date and time the resource was created, in the timestamp format defined by RFC3339.
public Date getTimeUpdated()
The date and time the resource was updated, in the timestamp format defined by RFC3339.
public Dataset.LifecycleState getLifecycleState()
The state of a dataset. CREATING - The dataset is being created. It transitions to ACTIVE when it is ready for labeling. ACTIVE - The dataset is ready for labeling. UPDATING - The dataset is being updated. It, and its related resources, might be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updaten operation has failed due to validation or other errors, and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED - The dataset has been deleted and is no longer available. FAILED - The dataset has failed due to validation or other errors.
public String getLifecycleDetails()
A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.
public String getAnnotationFormat()
The annotation format name required for labeling records.
public DatasetSourceDetails getDatasetSourceDetails()
public DatasetFormatDetails getDatasetFormatDetails()
public LabelSet getLabelSet()
public InitialRecordGenerationConfiguration getInitialRecordGenerationConfiguration()
public String getLabelingInstructions()
The labeling instructions for human labelers in rich text format
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"}
public Map<String,Map<String,Object>> getDefinedTags()
The defined tags for this resource. Each key is predefined and scoped to a namespace.
For example: {"foo-namespace": {"bar-key": "value"}}
public Map<String,Map<String,Object>> getSystemTags()
The usage of system tag keys. These predefined keys are scoped to namespaces.
For example: {"orcl-cloud": {"free-tier-retained": "true"}}
Copyright © 2016–2022. All rights reserved.