Package com.oracle.bmc.datalabelingservice.model

Class Dataset

  • @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, type of annotations allowed on these records, and 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).

    • Method Detail

      • getId

        public String getId()
        The OCID of the Dataset.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name for the resource.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment of the resource.
        Returns:
        the value

      • getDescription

        public String getDescription()
        A user provided description of the dataset
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the resource was created, in the timestamp format defined by RFC3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the resource was last updated, in the timestamp format defined by RFC3339.
        Returns:
        the value

      • getLifecycleState

        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.

        Returns:
        the value

      • getLifecycleDetails

        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.

        Returns:
        the value

      • getLifecycleSubstate

        public Dataset.LifecycleSubstate getLifecycleSubstate()
        The sub-state of the dataset.

        IMPORT_DATASET - The dataset is being imported.

        Returns:
        the value

      • getAnnotationFormat

        public String getAnnotationFormat()
        The annotation format name required for labeling records.
        Returns:
        the value

      • getLabelSet

        public LabelSet getLabelSet()

      • getLabelingInstructions

        public String getLabelingInstructions()
        The labeling instructions for human labelers in rich text format
        Returns:
        the value

      • getFreeformTags

        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”}

        Returns:
        the value

      • getDefinedTags

        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”}}

        Returns:
        the value

      • getSystemTags

        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”}}

        Returns:
        the value

      • getAdditionalProperties

        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”}

        Returns:
        the value

      • 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