Package io.camunda.client.api.response

Interface DocumentReferenceResponse

All Known Implementing Classes:

DocumentReferenceResponseImpl

@ExperimentalApi("https://github.com/camunda/issues/issues/841")
public interface DocumentReferenceResponse

Method Summary

Modifier and Type	Method	Description
String	getContentHash()	The hash of the associated document
String	getDocumentId()	The ID of the document.
default String	getDocumentType()
DocumentMetadata	getMetadata()
String	getStoreId()	The ID of the document store where the document is located.

Method Details

getDocumentType

default String getDocumentType()

getDocumentId

String getDocumentId()

The ID of the document. In combination with the store ID, the document ID uniquely identifies a document.

Returns:

the ID of the document

getStoreId

String getStoreId()

The ID of the document store where the document is located. Document IDs are unique within a document store.

Returns:

the ID of the document store

getContentHash

String getContentHash()

The hash of the associated document

Returns:

the hash value of the document

getMetadata

DocumentMetadata getMetadata()

Returns:

the metadata of the document reference