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

Class DesignDocument

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.DesignDocument

All Implemented Interfaces:

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

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

Schema for a design document.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
DesignDocument()

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.
Map<String,String>	getFilters()	Gets the filters.
String	getId()	Gets the id.
Map<String,SearchIndexDefinition>	getIndexes()	Gets the indexes.
String	getLanguage()	Gets the language.
String	getLocalSeq()	Gets the localSeq.
DesignDocumentOptions	getOptions()	Gets the options.
String	getRev()	Gets the rev.
Revisions	getRevisions()	Gets the revisions.
List<DocumentRevisionStatus>	getRevsInfo()	Gets the revsInfo.
Map<String,GeoIndexDefinition>	getStIndexes()	Gets the stIndexes.
Map<String,String>	getUpdates()	Gets the updates.
Map<String,String>	getValidateDocUpdate()	Gets the validateDocUpdate.
Map<String,DesignDocumentViewsMapReduce>	getViews()	Gets the views.
Boolean	isAutoupdate()	Gets the autoupdate.
Boolean	isDeleted()	Gets the deleted.
DesignDocument.Builder	newBuilder()	New builder.
void	setAttachments(Map<String,Attachment> attachments)	Sets the attachments.
void	setAutoupdate(Boolean autoupdate)	Sets the autoupdate.
void	setConflicts(List<String> conflicts)	Sets the conflicts.
void	setDeleted(Boolean deleted)	Sets the deleted.
void	setDeletedConflicts(List<String> deletedConflicts)	Sets the deletedConflicts.
void	setFilters(Map<String,String> filters)	Sets the filters.
void	setId(String id)	Sets the id.
void	setIndexes(Map<String,SearchIndexDefinition> indexes)	Sets the indexes.
void	setLanguage(String language)	Sets the language.
void	setLocalSeq(String localSeq)	Sets the localSeq.
void	setOptions(DesignDocumentOptions options)	Sets the options.
void	setRev(String rev)	Sets the rev.
void	setRevisions(Revisions revisions)	Sets the revisions.
void	setRevsInfo(List<DocumentRevisionStatus> revsInfo)	Sets the revsInfo.
void	setStIndexes(Map<String,GeoIndexDefinition> stIndexes)	Sets the stIndexes.
void	setUpdates(Map<String,String> updates)	Sets the updates.
void	setValidateDocUpdate(Map<String,String> validateDocUpdate)	Sets the validateDocUpdate.
void	setViews(Map<String,DesignDocumentViewsMapReduce> views)	Sets the views.

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

DesignDocument

public DesignDocument()

Method Detail

newBuilder

public DesignDocument.Builder newBuilder()

New builder.

Returns:

a DesignDocument 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

isAutoupdate

public Boolean isAutoupdate()

Gets the autoupdate. Indicates whether to automatically build indexes defined in this design document.

Returns:

the autoupdate

setAutoupdate

public void setAutoupdate(Boolean autoupdate)

Sets the autoupdate.

Parameters:

autoupdate - the new autoupdate

getFilters

public Map<String,String> getFilters()

Gets the filters. Schema for filter functions definition. This schema is a map where keys are the names of the filter functions and values are the function definition in string format.

Returns:

the filters

setFilters

public void setFilters(Map<String,String> filters)

Sets the filters.

Parameters:

filters - the new filters

getIndexes

public Map<String,SearchIndexDefinition> getIndexes()

Gets the indexes. Search (text) index function definitions.

Returns:

the indexes

setIndexes

public void setIndexes(Map<String,SearchIndexDefinition> indexes)

Sets the indexes.

Parameters:

indexes - the new indexes

getLanguage

public String getLanguage()

Gets the language. Defines Query Server key to process design document functions.

Returns:

the language

setLanguage

public void setLanguage(String language)

Sets the language.

Parameters:

language - the new language

getOptions

public DesignDocumentOptions getOptions()

Gets the options. Schema for design document options.

Returns:

the options

setOptions

public void setOptions(DesignDocumentOptions options)

Sets the options.

Parameters:

options - the new options

getUpdates

public Map<String,String> getUpdates()

Gets the updates. Schema for update function definitions.

Returns:

the updates

setUpdates

public void setUpdates(Map<String,String> updates)

Sets the updates.

Parameters:

updates - the new updates

getValidateDocUpdate

public Map<String,String> getValidateDocUpdate()

Gets the validateDocUpdate. Schema for validate document update functions definition.

Returns:

the validateDocUpdate

setValidateDocUpdate

public void setValidateDocUpdate(Map<String,String> validateDocUpdate)

Sets the validateDocUpdate.

Parameters:

validateDocUpdate - the new validateDocUpdate

getViews

public Map<String,DesignDocumentViewsMapReduce> getViews()

Gets the views. Schema for design document views.

Returns:

the views

setViews

public void setViews(Map<String,DesignDocumentViewsMapReduce> views)

Sets the views.

Parameters:

views - the new views

getStIndexes

public Map<String,GeoIndexDefinition> getStIndexes()

Gets the stIndexes. Schema for geospatial index function definitions.

Returns:

the stIndexes

setStIndexes

public void setStIndexes(Map<String,GeoIndexDefinition> stIndexes)

Sets the stIndexes.

Parameters:

stIndexes - the new stIndexes