com.oracle.bmc.datalabelingservice.model

Class Dataset.Builder

java.lang.Object

com.oracle.bmc.datalabelingservice.model.Dataset.Builder

Enclosing class:

Dataset

public static class Dataset.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Dataset.Builder	additionalProperties(Map<String,String> additionalProperties) A simple key-value pair that is applied without any predefined name, type, or scope.
Dataset.Builder	annotationFormat(String annotationFormat) The annotation format name required for labeling records.
Dataset	build()
Dataset.Builder	compartmentId(String compartmentId) The OCID of the compartment of the resource.
Dataset.Builder	copy(Dataset model)
Dataset.Builder	datasetFormatDetails(DatasetFormatDetails datasetFormatDetails)
Dataset.Builder	datasetSourceDetails(DatasetSourceDetails datasetSourceDetails)
Dataset.Builder	definedTags(Map<String,Map<String,Object>> definedTags) The defined tags for this resource.
Dataset.Builder	description(String description) A user provided description of the dataset
Dataset.Builder	displayName(String displayName) A user-friendly display name for the resource.
Dataset.Builder	freeformTags(Map<String,String> freeformTags) A simple key-value pair that is applied without any predefined name, type, or scope.
Dataset.Builder	id(String id) The OCID of the Dataset.
Dataset.Builder	initialImportDatasetConfiguration(InitialImportDatasetConfiguration initialImportDatasetConfiguration)
Dataset.Builder	initialRecordGenerationConfiguration(InitialRecordGenerationConfiguration initialRecordGenerationConfiguration)
Dataset.Builder	labelingInstructions(String labelingInstructions) The labeling instructions for human labelers in rich text format
Dataset.Builder	labelSet(LabelSet labelSet)
Dataset.Builder	lifecycleDetails(String lifecycleDetails) A message describing the current state in more detail.
Dataset.Builder	lifecycleState(Dataset.LifecycleState lifecycleState) The state of a dataset.
Dataset.Builder	lifecycleSubstate(Dataset.LifecycleSubstate lifecycleSubstate) The sub-state of the dataset.
Dataset.Builder	systemTags(Map<String,Map<String,Object>> systemTags) The usage of system tag keys.
Dataset.Builder	timeCreated(Date timeCreated) The date and time the resource was created, in the timestamp format defined by RFC3339.
Dataset.Builder	timeUpdated(Date timeUpdated) The date and time the resource was last updated, in the timestamp format defined by RFC3339.

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 Dataset.Builder id(String id)

The OCID of the Dataset.

Parameters:

id - the value to set

Returns:

this builder

displayName

public Dataset.Builder displayName(String displayName)

A user-friendly display name for the resource.

Parameters:

displayName - the value to set

Returns:

this builder

compartmentId

public Dataset.Builder compartmentId(String compartmentId)

The OCID of the compartment of the resource.

Parameters:

compartmentId - the value to set

Returns:

this builder

description

public Dataset.Builder description(String description)

A user provided description of the dataset

Parameters:

description - the value to set

Returns:

this builder

timeCreated

public Dataset.Builder timeCreated(Date timeCreated)

The date and time the resource was created, in the timestamp format defined by RFC3339.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public Dataset.Builder timeUpdated(Date timeUpdated)

The date and time the resource was last updated, in the timestamp format defined by RFC3339.

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public Dataset.Builder lifecycleState(Dataset.LifecycleState lifecycleState)

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.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public Dataset.Builder lifecycleDetails(String lifecycleDetails)

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.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

lifecycleSubstate

public Dataset.Builder lifecycleSubstate(Dataset.LifecycleSubstate lifecycleSubstate)

The sub-state of the dataset. IMPORT_DATASET - The dataset is being imported.

Parameters:

lifecycleSubstate - the value to set

Returns:

this builder

annotationFormat

public Dataset.Builder annotationFormat(String annotationFormat)

The annotation format name required for labeling records.

Parameters:

annotationFormat - the value to set

Returns:

this builder

datasetSourceDetails

public Dataset.Builder datasetSourceDetails(DatasetSourceDetails datasetSourceDetails)

datasetFormatDetails

public Dataset.Builder datasetFormatDetails(DatasetFormatDetails datasetFormatDetails)

labelSet

public Dataset.Builder labelSet(LabelSet labelSet)

initialRecordGenerationConfiguration

public Dataset.Builder initialRecordGenerationConfiguration(InitialRecordGenerationConfiguration initialRecordGenerationConfiguration)

initialImportDatasetConfiguration

public Dataset.Builder initialImportDatasetConfiguration(InitialImportDatasetConfiguration initialImportDatasetConfiguration)

labelingInstructions

public Dataset.Builder labelingInstructions(String labelingInstructions)

The labeling instructions for human labelers in rich text format

Parameters:

labelingInstructions - the value to set

Returns:

this builder

freeformTags

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

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

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

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

The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {"foo-namespace": {"bar-key": "value"}}

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

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

The usage of system tag keys. These predefined keys are scoped to namespaces. For example: {"orcl-cloud": {"free-tier-retained": "true"}}

Parameters:

systemTags - the value to set

Returns:

this builder

additionalProperties

public Dataset.Builder additionalProperties(Map<String,String> additionalProperties)

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

Parameters:

additionalProperties - the value to set

Returns:

this builder

build

public Dataset build()

copy

public Dataset.Builder copy(Dataset model)