Share via

DocumentAnnotationComment Class

Package:
com.azure.ai.contentunderstanding.models
Maven Artifact:
com.azure:azure-ai-contentunderstanding:1.0.0
  • java.lang.Object
    • com.azure.ai.contentunderstanding.models.DocumentAnnotationComment

Implements

JsonSerializable<DocumentAnnotationComment>

public final class DocumentAnnotationComment
implements JsonSerializable<DocumentAnnotationComment>

Comment associated with a document annotation.

Method Summary

Modifier and Type Method and Description
static DocumentAnnotationComment fromJson(JsonReader jsonReader)

Reads an instance of DocumentAnnotationComment from the JsonReader.
String getAuthor()

Get the author property: Author of the comment.
OffsetDateTime getCreatedAt()

Get the createdAt property: Date and time when the comment was created.
OffsetDateTime getLastModifiedAt()

Get the lastModifiedAt property: Date and time when the comment was last modified.
String getMessage()

Get the message property: Comment message in Markdown.
List<String> getTags()

Get the tags property: Tags associated with the comment.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static DocumentAnnotationComment fromJson(JsonReader jsonReader)

Reads an instance of DocumentAnnotationComment from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentAnnotationComment if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getAuthor

public String getAuthor()

Get the author property: Author of the comment.

Returns:

the author value.

getCreatedAt

public OffsetDateTime getCreatedAt()

Get the createdAt property: Date and time when the comment was created.

Returns:

the createdAt value.

getLastModifiedAt

public OffsetDateTime getLastModifiedAt()

Get the lastModifiedAt property: Date and time when the comment was last modified.

Returns:

the lastModifiedAt value.

getMessage

public String getMessage()

Get the message property: Comment message in Markdown.

Returns:

the message value.

getTags

public List<String> getTags()

Get the tags property: Tags associated with the comment.

Returns:

the tags value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to