Package com.oracle.bmc.datalabelingservicedataplane.model

Class Annotation

java.lang.Object

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

com.oracle.bmc.datalabelingservicedataplane.model.Annotation

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

An annotation represents a user- or machine-generated annotation for a given record.

The details of the annotation are captured in the RecordAnnotationDetails.
Note: Objects should always be created or deserialized using the Annotation.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 Annotation.Builder, which maintain a set of all explicitly set fields called Annotation.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	Annotation.Builder
static class	Annotation.LifecycleState	The lifecycle state of an annotation.

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
Annotation(String id, Date timeCreated, Date timeUpdated, String createdBy, String updatedBy, String recordId, List<Entity> entities, String compartmentId, Annotation.LifecycleState lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Annotation.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment for the annotation.
String	getCreatedBy()	The OCID of the principal which created the annotation.
Map<String,Map<String,Object>>	getDefinedTags()	The defined tags for this resource.
List<Entity>	getEntities()	The entity types are validated against the dataset to ensure consistency.
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 annotation.
Annotation.LifecycleState	getLifecycleState()	The lifecycle state of an annotation.
String	getRecordId()	The OCID of the record annotated.
Date	getTimeCreated()	The date and time the annotation was created, in the timestamp format defined by RFC3339.
Date	getTimeUpdated()	The date and time the resource was updated, in the timestamp format defined by RFC3339.
String	getUpdatedBy()	The OCID of the principal which updated the annotation.
int	hashCode()
Annotation.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

Annotation

@Deprecated
@ConstructorProperties({"id","timeCreated","timeUpdated","createdBy","updatedBy","recordId","entities","compartmentId","lifecycleState","freeformTags","definedTags"})
public Annotation(String id,
                  Date timeCreated,
                  Date timeUpdated,
                  String createdBy,
                  String updatedBy,
                  String recordId,
                  List<Entity> entities,
                  String compartmentId,
                  Annotation.LifecycleState lifecycleState,
                  Map<String,String> freeformTags,
                  Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static Annotation.Builder builder()

Create a new builder.

toBuilder

public Annotation.Builder toBuilder()

getId

public String getId()

The OCID of the annotation.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

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

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

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

Returns:

the value

getCreatedBy

public String getCreatedBy()

The OCID of the principal which created the annotation.

Returns:

the value

getUpdatedBy

public String getUpdatedBy()

The OCID of the principal which updated the annotation.

Returns:

the value

getRecordId

public String getRecordId()

The OCID of the record annotated.

Returns:

the value

getEntities

public List<Entity> getEntities()

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

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for the annotation.

This is tied to the dataset. It is not changeable on the record itself.

Returns:

the value

getLifecycleState

public Annotation.LifecycleState getLifecycleState()

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.

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