com.mongodb.client.model

Class BucketAutoOptions

java.lang.Object

com.mongodb.client.model.BucketAutoOptions

public class BucketAutoOptions
extends java.lang.Object

The options for a $bucketAuto aggregation pipeline stage

Since:

3.4

Constructor Summary

Constructors

Constructor and Description
BucketAutoOptions()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
BucketGranularity	getGranularity()
java.util.List<BsonField>	getOutput()
BucketAutoOptions	granularity(BucketGranularity granularity) Specifies the granularity of the bucket definitions.
int	hashCode()
BucketAutoOptions	output(BsonField... output) The definition of the output document in each bucket
BucketAutoOptions	output(java.util.List<BsonField> output) The definition of the output document in each bucket
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, 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 java.util.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
                                java.util.List<BsonField> output)

The definition of the output document in each bucket

Parameters:

output - the output document definition

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object