com.arangodb.entity

Class CollectionPropertiesEntity

java.lang.Object

com.arangodb.entity.CollectionEntity

com.arangodb.entity.CollectionPropertiesEntity

All Implemented Interfaces:

Entity

public class CollectionPropertiesEntity
extends CollectionEntity

Author:

Mark Vollmary

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
CollectionPropertiesEntity()

Method Summary

Modifier and Type	Method and Description
Long	getCount()
Boolean	getDoCompact()
Integer	getIndexBuckets()
Long	getJournalSize()
KeyOptions	getKeyOptions()
Integer	getMinReplicationFactor() Deprecated. use getWriteConcern() instead
Integer	getNumberOfShards()
Integer	getReplicationFactor()
Boolean	getSatellite()
String	getShardingStrategy()
Collection<String>	getShardKeys()
String	getSmartJoinAttribute()
Integer	getWriteConcern()
void	setCount(Long count)
void	setDoCompact(Boolean doCompact)
void	setIndexBuckets(Integer indexBuckets)
void	setJournalSize(Long journalSize)
void	setKeyOptions(KeyOptions keyOptions)
void	setMinReplicationFactor(Integer minReplicationFactor) Deprecated. use setWriteConcern(Integer) instead
void	setNumberOfShards(Integer numberOfShards)
void	setReplicationFactor(Integer replicationFactor)
void	setSatellite(Boolean satellite)
void	setShardingStrategy(String shardingStrategy)
void	setShardKeys(Collection<String> shardKeys)
void	setSmartJoinAttribute(String smartJoinAttribute)
void	setWriteConcern(Integer writeConcern)

Methods inherited from class com.arangodb.entity.CollectionEntity

getId, getIsSystem, getIsVolatile, getName, getSchema, getStatus, getType, getWaitForSync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionPropertiesEntity

public CollectionPropertiesEntity()

Method Detail

getDoCompact

public Boolean getDoCompact()

setDoCompact

public void setDoCompact(Boolean doCompact)

getJournalSize

public Long getJournalSize()

setJournalSize

public void setJournalSize(Long journalSize)

getIndexBuckets

public Integer getIndexBuckets()

setIndexBuckets

public void setIndexBuckets(Integer indexBuckets)

getKeyOptions

public KeyOptions getKeyOptions()

setKeyOptions

public void setKeyOptions(KeyOptions keyOptions)

getCount

public Long getCount()

setCount

public void setCount(Long count)

getNumberOfShards

public Integer getNumberOfShards()

Returns:

the number of shards of the collection. Only in a cluster setup (else returning null).

setNumberOfShards

public void setNumberOfShards(Integer numberOfShards)

getShardKeys

public Collection<String> getShardKeys()

Returns:

the names of document attributes that are used to determine the target shard for documents. Only in a cluster setup (else returning null).

setShardKeys

public void setShardKeys(Collection<String> shardKeys)

getReplicationFactor

public Integer getReplicationFactor()

setReplicationFactor

public void setReplicationFactor(Integer replicationFactor)

getMinReplicationFactor

@Deprecated
public Integer getMinReplicationFactor()

Deprecated. use getWriteConcern() instead

setMinReplicationFactor

@Deprecated
public void setMinReplicationFactor(Integer minReplicationFactor)

Deprecated. use setWriteConcern(Integer) instead

getWriteConcern

public Integer getWriteConcern()

setWriteConcern

public void setWriteConcern(Integer writeConcern)

getSatellite

public Boolean getSatellite()

Returns:

whether the collection is a satellite collection. Only in an enterprise cluster setup (else returning null).

setSatellite

public void setSatellite(Boolean satellite)

getShardingStrategy

public String getShardingStrategy()

setShardingStrategy

public void setShardingStrategy(String shardingStrategy)

getSmartJoinAttribute

public String getSmartJoinAttribute()

setSmartJoinAttribute

public void setSmartJoinAttribute(String smartJoinAttribute)