Share via

DocumentHyperlink 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.DocumentHyperlink

Implements

JsonSerializable<DocumentHyperlink>

public final class DocumentHyperlink
implements JsonSerializable<DocumentHyperlink>

Hyperlink in a document, such as a link to a web page or an email address.

Method Summary

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

Reads an instance of DocumentHyperlink from the JsonReader.
String getContent()

Get the content property: Hyperlinked content.
String getSource()

Get the source property: Position of the hyperlink.
ContentSpan getSpan()

Get the span property: Span of the hyperlink in the markdown content.
String getUrl()

Get the url property: URL of the hyperlink.
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 DocumentHyperlink fromJson(JsonReader jsonReader)

Reads an instance of DocumentHyperlink from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentHyperlink 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.

getContent

public String getContent()

Get the content property: Hyperlinked content.

Returns:

the content value.

getSource

public String getSource()

Get the source property: Position of the hyperlink.

Returns:

the source value.

getSpan

public ContentSpan getSpan()

Get the span property: Span of the hyperlink in the markdown content.

Returns:

the span value.

getUrl

public String getUrl()

Get the url property: URL of the hyperlink.

Returns:

the url value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to