java.lang.Object
- com.mongodb.client.model.CreateCollectionOptions

```
public class CreateCollectionOptions
extends Object
```
Options for creating a collection

Since:

3.0

MongoDB documentation
Create Collection
Time-series collections

Constructor Summary

Constructors
Constructor Description

CreateCollectionOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CreateCollectionOptions`	`capped(boolean capped)`	sets whether the collection is capped.
`CreateCollectionOptions`	`collation(Collation collation)`	Sets the collation options
`CreateCollectionOptions`	`expireAfter(long expireAfter, TimeUnit timeUnit)`	Sets the expire-after option.
`Collation`	`getCollation()`	Returns the collation options
`long`	`getExpireAfter(TimeUnit timeUnit)`	Returns the expire-after option.
`IndexOptionDefaults`	`getIndexOptionDefaults()`	Gets the index option defaults for the collection.
`long`	`getMaxDocuments()`	Gets the maximum number of documents allowed in a capped collection.
`long`	`getSizeInBytes()`	Gets the maximum size in bytes of a capped collection.
`Bson`	`getStorageEngineOptions()`	Gets the storage engine options document for the collection.
`TimeSeriesOptions`	`getTimeSeriesOptions()`	Gets the time series collection options.
`ValidationOptions`	`getValidationOptions()`	Gets the validation options for documents being inserted or updated in a collection
`CreateCollectionOptions`	`indexOptionDefaults(IndexOptionDefaults indexOptionDefaults)`	Sets the index option defaults for the collection.
`boolean`	`isCapped()`	Gets whether the collection is capped.
`CreateCollectionOptions`	`maxDocuments(long maxDocuments)`	Sets the maximum number of documents allowed in a capped collection.
`CreateCollectionOptions`	`sizeInBytes(long sizeInBytes)`	Gets the maximum size of in bytes of a capped collection.
`CreateCollectionOptions`	`storageEngineOptions(Bson storageEngineOptions)`	Sets the storage engine options document defaults for the collection
`CreateCollectionOptions`	`timeSeriesOptions(TimeSeriesOptions timeSeriesOptions)`	Sets the time-series collection options.
`String`	`toString()`
`CreateCollectionOptions`	`validationOptions(ValidationOptions validationOptions)`	Sets the validation options for documents being inserted or updated in a collection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateCollectionOptions
```
public CreateCollectionOptions()
```
- Method Detail
  - getMaxDocuments
```
public long getMaxDocuments()
```
    Gets the maximum number of documents allowed in a capped collection.
    
    Returns:
    
    max number of documents in a capped collection
  - maxDocuments
```
public CreateCollectionOptions maxDocuments(long maxDocuments)
```
    Sets the maximum number of documents allowed in a capped collection.
    
    Parameters:
    
    maxDocuments - the maximum number of documents allowed in capped collection
    
    Returns:
    
    this
  - isCapped
```
public boolean isCapped()
```
    Gets whether the collection is capped.
    
    Returns:
    
    whether the collection is capped
  - capped
```
public CreateCollectionOptions capped(boolean capped)
```
    sets whether the collection is capped.
    
    Parameters:
    
    capped - whether the collection is capped
    
    Returns:
    
    this
  - getSizeInBytes
```
public long getSizeInBytes()
```
    Gets the maximum size in bytes of a capped collection.
    
    Returns:
    
    the maximum size of a capped collection.
  - sizeInBytes
```
public CreateCollectionOptions sizeInBytes(long sizeInBytes)
```
    Gets the maximum size of in bytes of a capped collection.
    
    Parameters:
    
    sizeInBytes - the maximum size of a capped collection.
    
    Returns:
    
    this
  - getStorageEngineOptions
```
@Nullable
public Bson getStorageEngineOptions()
```
    Gets the storage engine options document for the collection.
    
    Returns:
    
    the storage engine options
    
    Since server release
    3.0
  - storageEngineOptions
```
public CreateCollectionOptions storageEngineOptions(@Nullable
                                                    Bson storageEngineOptions)
```
    Sets the storage engine options document defaults for the collection
    
    Parameters:
    
    storageEngineOptions - the storage engine options
    
    Returns:
    
    this
    
    Since server release
    3.0
  - getIndexOptionDefaults
```
public IndexOptionDefaults getIndexOptionDefaults()
```
    Gets the index option defaults for the collection.
    
    Returns:
    
    the index option defaults
    
    Since:
    
    3.2
    
    Since server release
    3.2
  - indexOptionDefaults
```
public CreateCollectionOptions indexOptionDefaults(IndexOptionDefaults indexOptionDefaults)
```
    Sets the index option defaults for the collection.
    
    Parameters:
    
    indexOptionDefaults - the index option defaults
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    Since server release
    3.2
  - getValidationOptions
```
public ValidationOptions getValidationOptions()
```
    Gets the validation options for documents being inserted or updated in a collection
    
    Returns:
    
    the validation options
    
    Since:
    
    3.2
    
    Since server release
    3.2
  - validationOptions
```
public CreateCollectionOptions validationOptions(ValidationOptions validationOptions)
```
    Sets the validation options for documents being inserted or updated in a collection
    
    Parameters:
    
    validationOptions - the validation options
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    Since server release
    3.2
  - getCollation
```
@Nullable
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    Since:
    
    3.4
    
    Since server release
    3.4
  - collation
```
public CreateCollectionOptions collation(@Nullable
                                         Collation collation)
```
    Sets the collation options
    A null value represents the server default.
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
    
    Since:
    
    3.4
    
    Since server release
    3.4
  - getExpireAfter
```
public long getExpireAfter(TimeUnit timeUnit)
```
    Returns the expire-after option. The default value is 0, which indicates no expiration.
    
    Parameters:
    
    timeUnit - the time unit
    
    Returns:
    
    the expire-after option, which may be null.
    
    Since:
    
    4.3
    
    MongoDB documentation
    Time-series collections
  - expireAfter
```
public CreateCollectionOptions expireAfter(long expireAfter,
                                           TimeUnit timeUnit)
```
    Sets the expire-after option.
    A duration indicating after how long old time-series data should be deleted. Partial seconds are ignored.
    
    Currently applies only to time-series collections, so if this value is set then so must the time-series options
    
    Parameters:
    
    expireAfter - the expire-after duration. After conversion to seconds using TimeUnit.convert(long, java.util.concurrent.TimeUnit), the value must be >= 0. A value of 0 indicates no expiration.
    
    timeUnit - the time unit
    
    Returns:
    
    this
    
    Since:
    
    4.3
    
    See Also:
    
    timeSeriesOptions(TimeSeriesOptions)
    
    MongoDB documentation
    Time-series collections
  - getTimeSeriesOptions
```
@Nullable
public TimeSeriesOptions getTimeSeriesOptions()
```
    Gets the time series collection options.
    
    Returns:
    
    the options for a time-series collection
    
    Since:
    
    4.3
    
    MongoDB documentation
    Time-series collections
  - timeSeriesOptions
```
public CreateCollectionOptions timeSeriesOptions(TimeSeriesOptions timeSeriesOptions)
```
    Sets the time-series collection options.
    
    Parameters:
    
    timeSeriesOptions - the time-series options
    
    Returns:
    
    this
    
    Since:
    
    4.3
    
    MongoDB documentation
    Time-series collections
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreateCollectionOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateCollectionOptions

Method Detail

getMaxDocuments

maxDocuments

isCapped

capped

getSizeInBytes

sizeInBytes

getStorageEngineOptions

storageEngineOptions

getIndexOptionDefaults

indexOptionDefaults

getValidationOptions

validationOptions

getCollation

collation

getExpireAfter

expireAfter

getTimeSeriesOptions

timeSeriesOptions

toString