Package io.camunda.client.protocol.rest

Class DocumentMetadata

java.lang.Object

io.camunda.client.protocol.rest.DocumentMetadata

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

Information about the document.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CONTENT_TYPE
static final String	JSON_PROPERTY_CUSTOM_PROPERTIES
static final String	JSON_PROPERTY_EXPIRES_AT
static final String	JSON_PROPERTY_FILE_NAME
static final String	JSON_PROPERTY_PROCESS_DEFINITION_ID
static final String	JSON_PROPERTY_PROCESS_INSTANCE_KEY
static final String	JSON_PROPERTY_SIZE

Constructor Summary

Constructors

Constructor	Description
DocumentMetadata()

Method Summary

Modifier and Type	Method	Description
DocumentMetadata	contentType(String contentType)
DocumentMetadata	customProperties(Map<String,Object> customProperties)
boolean	equals(Object o)
DocumentMetadata	expiresAt(String expiresAt)
DocumentMetadata	fileName(String fileName)
String	getContentType()	The content type of the document.
Map<String,Object>	getCustomProperties()	Custom properties of the document.
String	getExpiresAt()	The date and time when the document expires.
String	getFileName()	The name of the file.
String	getProcessDefinitionId()	The ID of the process definition that created the document.
String	getProcessInstanceKey()	The key of the process instance that created the document.
Long	getSize()	The size of the document in bytes.
int	hashCode()
DocumentMetadata	processDefinitionId(String processDefinitionId)
DocumentMetadata	processInstanceKey(String processInstanceKey)
DocumentMetadata	putCustomPropertiesItem(String key, Object customPropertiesItem)
void	setContentType(String contentType)
void	setCustomProperties(Map<String,Object> customProperties)
void	setExpiresAt(String expiresAt)
void	setFileName(String fileName)
void	setProcessDefinitionId(String processDefinitionId)
void	setProcessInstanceKey(String processInstanceKey)
void	setSize(Long size)
DocumentMetadata	size(Long size)
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_CONTENT_TYPE

public static final String JSON_PROPERTY_CONTENT_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_FILE_NAME

public static final String JSON_PROPERTY_FILE_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_EXPIRES_AT

public static final String JSON_PROPERTY_EXPIRES_AT

See Also:

• Constant Field Values

JSON_PROPERTY_SIZE

public static final String JSON_PROPERTY_SIZE

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_DEFINITION_ID

public static final String JSON_PROPERTY_PROCESS_DEFINITION_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PROCESS_INSTANCE_KEY

public static final String JSON_PROPERTY_PROCESS_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_PROPERTIES

public static final String JSON_PROPERTY_CUSTOM_PROPERTIES

See Also:

• Constant Field Values

Constructor Details

DocumentMetadata

public DocumentMetadata()

Method Details

contentType

public DocumentMetadata contentType(@Nullable
 String contentType)

getContentType

@Nullable
public String getContentType()

The content type of the document.

Returns:

contentType

setContentType

public void setContentType(@Nullable
 String contentType)

fileName

public DocumentMetadata fileName(@Nullable
 String fileName)

getFileName

@Nullable
public String getFileName()

The name of the file.

Returns:

fileName

setFileName

public void setFileName(@Nullable
 String fileName)

expiresAt

public DocumentMetadata expiresAt(@Nullable
 String expiresAt)

getExpiresAt

@Nullable
public String getExpiresAt()

The date and time when the document expires.

Returns:

expiresAt

setExpiresAt

public void setExpiresAt(@Nullable
 String expiresAt)

size

public DocumentMetadata size(@Nullable
 Long size)

getSize

@Nullable
public Long getSize()

The size of the document in bytes.

Returns:

size

setSize

public void setSize(@Nullable
 Long size)

processDefinitionId

public DocumentMetadata processDefinitionId(@Nullable
 String processDefinitionId)

getProcessDefinitionId

@Nullable
public String getProcessDefinitionId()

The ID of the process definition that created the document.

Returns:

processDefinitionId

setProcessDefinitionId

public void setProcessDefinitionId(@Nullable
 String processDefinitionId)

processInstanceKey

public DocumentMetadata processInstanceKey(@Nullable
 String processInstanceKey)

getProcessInstanceKey

@Nullable
public String getProcessInstanceKey()

The key of the process instance that created the document.

Returns:

processInstanceKey

setProcessInstanceKey

public void setProcessInstanceKey(@Nullable
 String processInstanceKey)

customProperties

public DocumentMetadata customProperties(@Nullable
 Map<String,Object> customProperties)

putCustomPropertiesItem

public DocumentMetadata putCustomPropertiesItem(String key,
 Object customPropertiesItem)

getCustomProperties

@Nullable
public Map<String,Object> getCustomProperties()

Custom properties of the document.

Returns:

customProperties

setCustomProperties

public void setCustomProperties(@Nullable
 Map<String,Object> customProperties)

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