MongoJsonSchema.MongoJsonSchemaBuilder (Spring Data MongoDB

java.lang.Object
- org.springframework.data.mongodb.core.schema.MongoJsonSchema.MongoJsonSchemaBuilder

Enclosing interface:

MongoJsonSchema
```
public static class MongoJsonSchema.MongoJsonSchemaBuilder
extends Object
```
MongoJsonSchema.MongoJsonSchemaBuilder provides a fluent API for defining a MongoJsonSchema.

Author:

Christoph Strobl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MongoJsonSchema.MongoJsonSchemaBuilder`	`additionalProperties(boolean additionalPropertiesAllowed)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`additionalProperties(TypedJsonSchemaObject.ObjectJsonSchemaObject schema)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`allOf(Set<JsonSchemaObject> allOf)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`anyOf(Set<JsonSchemaObject> anyOf)`
`MongoJsonSchema`	`build()` Obtain the `MongoJsonSchema`.
`MongoJsonSchema.MongoJsonSchemaBuilder`	`description(String description)`
`void`	`encryptionMetadata(org.bson.Document encryptionMetadata)` Define the encryptMetadata element of the schema.
`MongoJsonSchema.MongoJsonSchemaBuilder`	`maxProperties(int count)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`minProperties(int count)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`notMatch(JsonSchemaObject notMatch)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`oneOf(Set<JsonSchemaObject> oneOf)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`patternProperties(JsonSchemaProperty... properties)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`possibleValues(Set<Object> possibleValues)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`properties(JsonSchemaProperty... properties)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`property(JsonSchemaProperty property)`
`MongoJsonSchema.MongoJsonSchemaBuilder`	`required(String... properties)`

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

- Method Detail
  - minProperties
```
public MongoJsonSchema.MongoJsonSchemaBuilder minProperties(int count)
```
    Parameters:
    
    count -
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.minProperties(int)
  - maxProperties
```
public MongoJsonSchema.MongoJsonSchemaBuilder maxProperties(int count)
```
    Parameters:
    
    count -
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.maxProperties(int)
  - required
```
public MongoJsonSchema.MongoJsonSchemaBuilder required(String... properties)
```
    Parameters:
    
    properties - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.required(String...)
  - additionalProperties
```
public MongoJsonSchema.MongoJsonSchemaBuilder additionalProperties(boolean additionalPropertiesAllowed)
```
    Parameters:
    
    additionalPropertiesAllowed -
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.additionalProperties(boolean)
  - additionalProperties
```
public MongoJsonSchema.MongoJsonSchemaBuilder additionalProperties(TypedJsonSchemaObject.ObjectJsonSchemaObject schema)
```
    Parameters:
    
    schema - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    ObjectJsonSchemaObject#additionalProperties(ObjectJsonSchemaObject)
  - properties
```
public MongoJsonSchema.MongoJsonSchemaBuilder properties(JsonSchemaProperty... properties)
```
    Parameters:
    
    properties - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.properties(JsonSchemaProperty...)
  - patternProperties
```
public MongoJsonSchema.MongoJsonSchemaBuilder patternProperties(JsonSchemaProperty... properties)
```
    Parameters:
    
    properties - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...)
  - property
```
public MongoJsonSchema.MongoJsonSchemaBuilder property(JsonSchemaProperty property)
```
    Parameters:
    
    property - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.property(JsonSchemaProperty)
  - possibleValues
```
public MongoJsonSchema.MongoJsonSchemaBuilder possibleValues(Set<Object> possibleValues)
```
    Parameters:
    
    possibleValues - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    TypedJsonSchemaObject.ObjectJsonSchemaObject.possibleValues(Collection)
  - allOf
```
public MongoJsonSchema.MongoJsonSchemaBuilder allOf(Set<JsonSchemaObject> allOf)
```
    Parameters:
    
    allOf - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    UntypedJsonSchemaObject.allOf(Collection)
  - anyOf
```
public MongoJsonSchema.MongoJsonSchemaBuilder anyOf(Set<JsonSchemaObject> anyOf)
```
    Parameters:
    
    anyOf - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    UntypedJsonSchemaObject.anyOf(Collection)
  - oneOf
```
public MongoJsonSchema.MongoJsonSchemaBuilder oneOf(Set<JsonSchemaObject> oneOf)
```
    Parameters:
    
    oneOf - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    UntypedJsonSchemaObject.oneOf(Collection)
  - notMatch
```
public MongoJsonSchema.MongoJsonSchemaBuilder notMatch(JsonSchemaObject notMatch)
```
    Parameters:
    
    notMatch - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    UntypedJsonSchemaObject.notMatch(JsonSchemaObject)
  - description
```
public MongoJsonSchema.MongoJsonSchemaBuilder description(String description)
```
    Parameters:
    
    description - must not be null.
    
    Returns:
    
    this MongoJsonSchema.MongoJsonSchemaBuilder.
    
    See Also:
    
    UntypedJsonSchemaObject.description(String)
  - encryptionMetadata
```
public void encryptionMetadata(@Nullable
                               org.bson.Document encryptionMetadata)
```
    Define the encryptMetadata element of the schema.
    
    Parameters:
    
    encryptionMetadata - can be null.
    
    Since:
    
    3.3
  - build
```
public MongoJsonSchema build()
```
    Obtain the MongoJsonSchema.
    
    Returns:
    
    new instance of MongoJsonSchema.

Class MongoJsonSchema.MongoJsonSchemaBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

minProperties

maxProperties

required

additionalProperties

additionalProperties

properties

patternProperties

property

possibleValues

allOf

anyOf

oneOf

notMatch

description

encryptionMetadata

build