@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Annotation.Builder |
static class |
Annotation.LifecycleState
The lifecycle state of an annotation.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and 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.
|
| Modifier and Type | Method and 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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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)
public static Annotation.Builder builder()
Create a new builder.
public Annotation.Builder toBuilder()
public String getId()
The OCID of the annotation.
public Date getTimeCreated()
The date and time the annotation was created, in the timestamp format defined by RFC3339.
public Date getTimeUpdated()
The date and time the resource was updated, in the timestamp format defined by RFC3339.
public String getCreatedBy()
The OCID of the principal which created the annotation.
public String getUpdatedBy()
The OCID of the principal which updated the annotation.
public String getRecordId()
The OCID of the record annotated.
public List<Entity> getEntities()
The entity types are validated against the dataset to ensure consistency.
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.
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.
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"}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.