Package com.ibm.cloud.cloudant.v1.model

Class Document

java.lang.Object

com.ibm.cloud.sdk.core.service.model.DynamicModel<Object>

com.ibm.cloud.cloudant.v1.model.Document

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class Document
extends com.ibm.cloud.sdk.core.service.model.DynamicModel<Object>

Schema for a document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Builder	Builder.

Constructor Summary

Constructors

Constructor	Description
Document()

Method Summary

Modifier and Type	Method	Description
Map<String,Attachment>	getAttachments()	Gets the attachments.
List<String>	getConflicts()	Gets the conflicts.
List<String>	getDeletedConflicts()	Gets the deletedConflicts.
String	getId()	Gets the id.
String	getLocalSeq()	Gets the localSeq.
String	getRev()	Gets the rev.
Revisions	getRevisions()	Gets the revisions.
List<DocumentRevisionStatus>	getRevsInfo()	Gets the revsInfo.
Boolean	isDeleted()	Gets the deleted.
Document.Builder	newBuilder()	New builder.
void	setAttachments(Map<String,Attachment> attachments)	Sets the attachments.
void	setConflicts(List<String> conflicts)	Sets the conflicts.
void	setDeleted(Boolean deleted)	Sets the deleted.
void	setDeletedConflicts(List<String> deletedConflicts)	Sets the deletedConflicts.
void	setId(String id)	Sets the id.
void	setLocalSeq(String localSeq)	Sets the localSeq.
void	setRev(String rev)	Sets the rev.
void	setRevisions(Revisions revisions)	Sets the revisions.
void	setRevsInfo(List<DocumentRevisionStatus> revsInfo)	Sets the revsInfo.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.DynamicModel

equals, get, getAdditionalPropertyTypeToken, getProperties, getPropertyNames, hashCode, put, removeProperties, removeProperty, setProperties, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document()

Method Detail

newBuilder

public Document.Builder newBuilder()

New builder.

Returns:

a Document builder

getAttachments

public Map<String,Attachment> getAttachments()

Gets the attachments. Schema for a map of attachment name to attachment metadata.

Returns:

the attachments

setAttachments

public void setAttachments(Map<String,Attachment> attachments)

Sets the attachments.

Parameters:

attachments - the new attachments

getConflicts

public List<String> getConflicts()

Gets the conflicts. Schema for a list of document revision identifiers.

Returns:

the conflicts

setConflicts

public void setConflicts(List<String> conflicts)

Sets the conflicts.

Parameters:

conflicts - the new conflicts

isDeleted

public Boolean isDeleted()

Gets the deleted. Deletion flag. Available if document was removed.

Returns:

the deleted

setDeleted

public void setDeleted(Boolean deleted)

Sets the deleted.

Parameters:

deleted - the new deleted

getDeletedConflicts

public List<String> getDeletedConflicts()

Gets the deletedConflicts. Schema for a list of document revision identifiers.

Returns:

the deletedConflicts

setDeletedConflicts

public void setDeletedConflicts(List<String> deletedConflicts)

Sets the deletedConflicts.

Parameters:

deletedConflicts - the new deletedConflicts

getId

public String getId()

Gets the id. Document ID.

Returns:

the id

setId

public void setId(String id)

Sets the id.

Parameters:

id - the new id

getLocalSeq

public String getLocalSeq()

Gets the localSeq. Document's update sequence in current database. Available if requested with local_seq=true query parameter.

Returns:

the localSeq

setLocalSeq

public void setLocalSeq(String localSeq)

Sets the localSeq.

Parameters:

localSeq - the new localSeq

getRev

public String getRev()

Gets the rev. Schema for a document revision identifier.

Returns:

the rev

setRev

public void setRev(String rev)

Sets the rev.

Parameters:

rev - the new rev

getRevisions

public Revisions getRevisions()

Gets the revisions. Schema for list of revision information.

Returns:

the revisions

setRevisions

public void setRevisions(Revisions revisions)

Sets the revisions.

Parameters:

revisions - the new revisions

getRevsInfo

public List<DocumentRevisionStatus> getRevsInfo()

Gets the revsInfo. Schema for a list of objects with information about local revisions and their status.

Returns:

the revsInfo

setRevsInfo

public void setRevsInfo(List<DocumentRevisionStatus> revsInfo)

Sets the revsInfo.

Parameters:

revsInfo - the new revsInfo