Package com.mongodb.client.model

Class BucketAutoOptions

java.lang.Object

com.mongodb.client.model.BucketAutoOptions

public class BucketAutoOptions
extends Object

The options for a $bucketAuto aggregation pipeline stage

Since:

3.4

MongoDB documentation

$bucketAuto

Since server release

3.4

Constructor Summary

Constructors

Constructor	Description
BucketAutoOptions()

Method Summary

Modifier and Type	Method	Description
BucketGranularity	getGranularity()
List<BsonField>	getOutput()
BucketAutoOptions	granularity(BucketGranularity granularity)	Specifies the granularity of the bucket definitions.
BucketAutoOptions	output(BsonField... output)	The definition of the output document in each bucket
BucketAutoOptions	output(List<BsonField> output)	The definition of the output document in each bucket
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BucketAutoOptions

public BucketAutoOptions()

Method Detail

getGranularity

@Nullable
public BucketGranularity getGranularity()

Returns:

the granularity of the bucket definitions

getOutput

@Nullable
public List<BsonField> getOutput()

Returns:

the output document definition

granularity

public BucketAutoOptions granularity(@Nullable
                                     BucketGranularity granularity)

Specifies the granularity of the bucket definitions.

Parameters:

granularity - the granularity of the bucket definitions

Returns:

this

See Also:

Preferred numbers, BucketGranularity

output

public BucketAutoOptions output(BsonField... output)

The definition of the output document in each bucket

Parameters:

output - the output document definition

Returns:

this

output

public BucketAutoOptions output(@Nullable
                                List<BsonField> output)

The definition of the output document in each bucket

Parameters:

output - the output document definition

Returns:

this

toString

public String toString()

Overrides:

toString in class Object