com.oracle.bmc.datalabelingservicedataplane.model

Class Annotation.Builder

java.lang.Object

com.oracle.bmc.datalabelingservicedataplane.model.Annotation.Builder

Enclosing class:

Annotation

public static class Annotation.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Annotation	build()
Annotation.Builder	compartmentId(String compartmentId) The OCID of the compartment for the annotation.
Annotation.Builder	copy(Annotation model)
Annotation.Builder	createdBy(String createdBy) The OCID of the principal which created the annotation.
Annotation.Builder	definedTags(Map<String,Map<String,Object>> definedTags) The defined tags for this resource.
Annotation.Builder	entities(List<Entity> entities) The entity types are validated against the dataset to ensure consistency.
Annotation.Builder	freeformTags(Map<String,String> freeformTags) A simple key-value pair that is applied without any predefined name, type, or scope.
Annotation.Builder	id(String id) The OCID of the annotation.
Annotation.Builder	lifecycleState(Annotation.LifecycleState lifecycleState) The lifecycle state of an annotation.
Annotation.Builder	recordId(String recordId) The OCID of the record annotated.
Annotation.Builder	timeCreated(Date timeCreated) The date and time the annotation was created, in the timestamp format defined by RFC3339.
Annotation.Builder	timeUpdated(Date timeUpdated) The date and time the resource was updated, in the timestamp format defined by RFC3339.
Annotation.Builder	updatedBy(String updatedBy) The OCID of the principal which updated the annotation.

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

The OCID of the annotation.

Parameters:

id - the value to set

Returns:

this builder

timeCreated

public Annotation.Builder timeCreated(Date timeCreated)

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

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public Annotation.Builder timeUpdated(Date timeUpdated)

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

Parameters:

timeUpdated - the value to set

Returns:

this builder

createdBy

public Annotation.Builder createdBy(String createdBy)

The OCID of the principal which created the annotation.

Parameters:

createdBy - the value to set

Returns:

this builder

updatedBy

public Annotation.Builder updatedBy(String updatedBy)

The OCID of the principal which updated the annotation.

Parameters:

updatedBy - the value to set

Returns:

this builder

recordId

public Annotation.Builder recordId(String recordId)

The OCID of the record annotated.

Parameters:

recordId - the value to set

Returns:

this builder

entities

public Annotation.Builder entities(List<Entity> entities)

The entity types are validated against the dataset to ensure consistency.

Parameters:

entities - the value to set

Returns:

this builder

compartmentId

public Annotation.Builder compartmentId(String compartmentId)

The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself.

Parameters:

compartmentId - the value to set

Returns:

this builder

lifecycleState

public Annotation.Builder lifecycleState(Annotation.LifecycleState lifecycleState)

The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation been deleted and no longer available for labeling.

Parameters:

lifecycleState - the value to set

Returns:

this builder

freeformTags

public Annotation.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 Annotation.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

build

public Annotation build()

copy

public Annotation.Builder copy(Annotation model)