@Generated(value="OracleSDKGenerator",
comments="API Version: 20211001")
public final class Dataset
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the 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 Dataset.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 |
Dataset.Builder |
static class |
Dataset.LifecycleState
The state of a dataset.
|
static class |
Dataset.LifecycleSubstate
The sub-state of the dataset.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Dataset(String id,
String displayName,
String compartmentId,
String description,
Date timeCreated,
Date timeUpdated,
Dataset.LifecycleState lifecycleState,
String lifecycleDetails,
Dataset.LifecycleSubstate lifecycleSubstate,
String annotationFormat,
DatasetSourceDetails datasetSourceDetails,
DatasetFormatDetails datasetFormatDetails,
LabelSet labelSet,
InitialRecordGenerationConfiguration initialRecordGenerationConfiguration,
InitialImportDatasetConfiguration initialImportDatasetConfiguration,
String labelingInstructions,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
Map<String,String> additionalProperties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Dataset.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Map<String,String> |
getAdditionalProperties()
A simple key-value pair that is applied without any predefined name, type, or scope.
|
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.
|
InitialImportDatasetConfiguration |
getInitialImportDatasetConfiguration() |
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.
|
Dataset.LifecycleSubstate |
getLifecycleSubstate()
The sub-state of the 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 last updated, in the timestamp format defined by RFC3339.
|
int |
hashCode() |
Dataset.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","description","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","lifecycleSubstate","annotationFormat","datasetSourceDetails","datasetFormatDetails","labelSet","initialRecordGenerationConfiguration","initialImportDatasetConfiguration","labelingInstructions","freeformTags","definedTags","systemTags","additionalProperties"}) public Dataset(String id, String displayName, String compartmentId, String description, Date timeCreated, Date timeUpdated, Dataset.LifecycleState lifecycleState, String lifecycleDetails, Dataset.LifecycleSubstate lifecycleSubstate, String annotationFormat, DatasetSourceDetails datasetSourceDetails, DatasetFormatDetails datasetFormatDetails, LabelSet labelSet, InitialRecordGenerationConfiguration initialRecordGenerationConfiguration, InitialImportDatasetConfiguration initialImportDatasetConfiguration, String labelingInstructions, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Map<String,String> additionalProperties)
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 last updated, in the timestamp format defined by RFC3339.
public Dataset.LifecycleState getLifecycleState()
The state of a dataset. CREATING - The dataset is being created. It will transition 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 may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation 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 Dataset.LifecycleSubstate getLifecycleSubstate()
The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.
public String getAnnotationFormat()
The annotation format name required for labeling records.
public DatasetSourceDetails getDatasetSourceDetails()
public DatasetFormatDetails getDatasetFormatDetails()
public LabelSet getLabelSet()
public InitialRecordGenerationConfiguration getInitialRecordGenerationConfiguration()
public InitialImportDatasetConfiguration getInitialImportDatasetConfiguration()
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"}}
public Map<String,String> getAdditionalProperties()
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 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.