Package io.camunda.client.protocol.rest

Class DocumentReference

java.lang.Object

io.camunda.client.protocol.rest.DocumentReference

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-10-08T19:37:20.302687113Z[GMT]",
           comments="Generator version: 7.12.0")
public class DocumentReference
extends Object

DocumentReference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocumentReference.CamundaDocumentTypeEnum	Document discriminator.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CAMUNDA_DOCUMENT_TYPE
static final String	JSON_PROPERTY_CONTENT_HASH
static final String	JSON_PROPERTY_DOCUMENT_ID
static final String	JSON_PROPERTY_METADATA
static final String	JSON_PROPERTY_STORE_ID

Constructor Summary

Constructors

Constructor	Description
DocumentReference()

Method Summary

Modifier and Type	Method	Description
DocumentReference	camundaDocumentType(DocumentReference.CamundaDocumentTypeEnum camundaDocumentType)
DocumentReference	contentHash(String contentHash)
DocumentReference	documentId(String documentId)
boolean	equals(Object o)
DocumentReference.CamundaDocumentTypeEnum	getCamundaDocumentType()	Document discriminator.
String	getContentHash()	The hash of the document.
String	getDocumentId()	The ID of the document.
DocumentMetadata	getMetadata()	Get metadata
String	getStoreId()	The ID of the document store.
int	hashCode()
DocumentReference	metadata(DocumentMetadata metadata)
void	setCamundaDocumentType(DocumentReference.CamundaDocumentTypeEnum camundaDocumentType)
void	setContentHash(String contentHash)
void	setDocumentId(String documentId)
void	setMetadata(DocumentMetadata metadata)
void	setStoreId(String storeId)
DocumentReference	storeId(String storeId)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_CAMUNDA_DOCUMENT_TYPE

public static final String JSON_PROPERTY_CAMUNDA_DOCUMENT_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_STORE_ID

public static final String JSON_PROPERTY_STORE_ID

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_ID

public static final String JSON_PROPERTY_DOCUMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CONTENT_HASH

public static final String JSON_PROPERTY_CONTENT_HASH

See Also:

• Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

• Constant Field Values

Constructor Details

DocumentReference

public DocumentReference()

Method Details

camundaDocumentType

public DocumentReference camundaDocumentType(@Nullable
 DocumentReference.CamundaDocumentTypeEnum camundaDocumentType)

getCamundaDocumentType

@Nullable
public DocumentReference.CamundaDocumentTypeEnum getCamundaDocumentType()

Document discriminator. Always set to \"camunda\".

Returns:

camundaDocumentType

setCamundaDocumentType

public void setCamundaDocumentType(@Nullable
 DocumentReference.CamundaDocumentTypeEnum camundaDocumentType)

storeId

public DocumentReference storeId(@Nullable
 String storeId)

getStoreId

@Nullable
public String getStoreId()

The ID of the document store.

Returns:

storeId

setStoreId

public void setStoreId(@Nullable
 String storeId)

documentId

public DocumentReference documentId(@Nullable
 String documentId)

getDocumentId

@Nullable
public String getDocumentId()

The ID of the document.

Returns:

documentId

setDocumentId

public void setDocumentId(@Nullable
 String documentId)

contentHash

public DocumentReference contentHash(@Nullable
 String contentHash)

getContentHash

@Nullable
public String getContentHash()

The hash of the document.

Returns:

contentHash

setContentHash

public void setContentHash(@Nullable
 String contentHash)

metadata

public DocumentReference metadata(@Nullable
 DocumentMetadata metadata)

getMetadata

@Nullable
public DocumentMetadata getMetadata()

Get metadata

Returns:

metadata

setMetadata

public void setMetadata(@Nullable
 DocumentMetadata metadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string