Package com.oracle.bmc.datalabelingservice.model

Class CreateDatasetDetails

java.lang.Object

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

com.oracle.bmc.datalabelingservice.model.CreateDatasetDetails

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

Parameters needed to create a new Dataset.

A Dataset allows a user to describe the data source that provides the Records and how Annotations should be applied to the Records.
Note: Objects should always be created or deserialized using the CreateDatasetDetails.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 CreateDatasetDetails.Builder, which maintain a set of all explicitly set fields called CreateDatasetDetails.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	CreateDatasetDetails.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

CreateDatasetDetails(String displayName, String description, String compartmentId, String annotationFormat, DatasetSourceDetails datasetSourceDetails, DatasetFormatDetails datasetFormatDetails, InitialRecordGenerationConfiguration initialRecordGenerationConfiguration, InitialImportDatasetConfiguration initialImportDatasetConfiguration, LabelSet labelSet, String labelingInstructions, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateDatasetDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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.
InitialImportDatasetConfiguration	getInitialImportDatasetConfiguration()
InitialRecordGenerationConfiguration	getInitialRecordGenerationConfiguration()
String	getLabelingInstructions()	The labeling instructions for human labelers in rich text format
LabelSet	getLabelSet()
int	hashCode()
CreateDatasetDetails.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

CreateDatasetDetails

@Deprecated
@ConstructorProperties({"displayName","description","compartmentId","annotationFormat","datasetSourceDetails","datasetFormatDetails","initialRecordGenerationConfiguration","initialImportDatasetConfiguration","labelSet","labelingInstructions","freeformTags","definedTags"})
public CreateDatasetDetails(String displayName,
                            String description,
                            String compartmentId,
                            String annotationFormat,
                            DatasetSourceDetails datasetSourceDetails,
                            DatasetFormatDetails datasetFormatDetails,
                            InitialRecordGenerationConfiguration initialRecordGenerationConfiguration,
                            InitialImportDatasetConfiguration initialImportDatasetConfiguration,
                            LabelSet labelSet,
                            String labelingInstructions,
                            Map<String,String> freeformTags,
                            Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateDatasetDetails.Builder builder()

Create a new builder.

toBuilder

public CreateDatasetDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

A user-friendly display name for the resource.

Returns:

the value

getDescription

public String getDescription()

A user provided description of the dataset

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment of the resource.

Returns:

the value

getAnnotationFormat

public String getAnnotationFormat()

The annotation format name required for labeling records.

Returns:

the value

getDatasetSourceDetails

public DatasetSourceDetails getDatasetSourceDetails()

getDatasetFormatDetails

public DatasetFormatDetails getDatasetFormatDetails()

getInitialRecordGenerationConfiguration

public InitialRecordGenerationConfiguration getInitialRecordGenerationConfiguration()

getInitialImportDatasetConfiguration

public InitialImportDatasetConfiguration getInitialImportDatasetConfiguration()

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

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