Package com.oracle.bmc.datalabelingservicedataplane.model

Class CreateAnnotationDetails

java.lang.Object

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

com.oracle.bmc.datalabelingservicedataplane.model.CreateAnnotationDetails

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

This is the payload sent in the CreateAnnotation operation.

It contains all the information required for a user to create an annotation for a record.
Note: Objects should always be created or deserialized using the CreateAnnotationDetails.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 CreateAnnotationDetails.Builder, which maintain a set of all explicitly set fields called CreateAnnotationDetails.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	CreateAnnotationDetails.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
CreateAnnotationDetails(String recordId, String compartmentId, List<Entity> entities, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateAnnotationDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment for 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	getRecordId()	The OCID of the record annotated.
int	hashCode()
CreateAnnotationDetails.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

CreateAnnotationDetails

@Deprecated
@ConstructorProperties({"recordId","compartmentId","entities","freeformTags","definedTags"})
public CreateAnnotationDetails(String recordId,
                               String compartmentId,
                               List<Entity> entities,
                               Map<String,String> freeformTags,
                               Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateAnnotationDetails.Builder builder()

Create a new builder.

toBuilder

public CreateAnnotationDetails.Builder toBuilder()

getRecordId

public String getRecordId()

The OCID of the record annotated.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for the annotation.

Returns:

the value

getEntities

public List<Entity> getEntities()

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

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