ImmutableMongoDumpArguments (Flapdoodle Embedded MongoDB 4.11.1 API)

java.lang.Object
- de.flapdoodle.embed.mongo.commands.MongoDumpArguments
- - de.flapdoodle.embed.mongo.commands.ImmutableMongoDumpArguments

All Implemented Interfaces:

MongoToolsArguments
```
public final class ImmutableMongoDumpArguments
extends MongoDumpArguments
```
Immutable implementation of MongoDumpArguments.
Use the builder to create immutable instances: ImmutableMongoDumpArguments.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongoDumpArguments.Builder
Builds instances of type ImmutableMongoDumpArguments.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableMongoDumpArguments.Builder` Builds instances of type `ImmutableMongoDumpArguments`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<String>`	`archive()`
`static ImmutableMongoDumpArguments.Builder`	`builder()` Creates a builder for `ImmutableMongoDumpArguments`.
`Optional<String>`	`collectionName()`
`static ImmutableMongoDumpArguments`	`copyOf(MongoDumpArguments instance)` Creates an immutable copy of a `MongoDumpArguments` value.
`Optional<String>`	`databaseName()`
`Optional<String>`	`dir()`
`boolean`	`dumpDbUsersAndRoles()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongoDumpArguments` that have equal attribute values.
`Optional<String>`	`excludeCollection()`
`Optional<String>`	`excludeCollectionWithPrefix()`
`boolean`	`forceTableScan()`
`boolean`	`gzip()`
`int`	`hashCode()` Computes a hash code from attributes: `verbose`, `databaseName`, `collectionName`, `query`, `queryFile`, `readPreference`, `forceTableScan`, `archive`, `dumpDbUsersAndRoles`, `gzip`, `repair`, `dir`, `isOplog`, `excludeCollection`, `excludeCollectionWithPrefix`, `numberOfParallelCollections`.
`boolean`	`isOplog()`
`OptionalInt`	`numberOfParallelCollections()`
`Optional<String>`	`query()`
`Optional<String>`	`queryFile()`
`Optional<String>`	`readPreference()`
`boolean`	`repair()`
`String`	`toString()` Prints the immutable value `MongoDumpArguments` with attribute values.
`boolean`	`verbose()`
`ImmutableMongoDumpArguments`	`withArchive(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `archive` attribute.
`ImmutableMongoDumpArguments`	`withArchive(String value)` Copy the current immutable object by setting a present value for the optional `archive` attribute.
`ImmutableMongoDumpArguments`	`withCollectionName(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `collectionName` attribute.
`ImmutableMongoDumpArguments`	`withCollectionName(String value)` Copy the current immutable object by setting a present value for the optional `collectionName` attribute.
`ImmutableMongoDumpArguments`	`withDatabaseName(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `databaseName` attribute.
`ImmutableMongoDumpArguments`	`withDatabaseName(String value)` Copy the current immutable object by setting a present value for the optional `databaseName` attribute.
`ImmutableMongoDumpArguments`	`withDir(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `dir` attribute.
`ImmutableMongoDumpArguments`	`withDir(String value)` Copy the current immutable object by setting a present value for the optional `dir` attribute.
`ImmutableMongoDumpArguments`	`withDumpDbUsersAndRoles(boolean value)` Copy the current immutable object by setting a value for the `dumpDbUsersAndRoles` attribute.
`ImmutableMongoDumpArguments`	`withExcludeCollection(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `excludeCollection` attribute.
`ImmutableMongoDumpArguments`	`withExcludeCollection(String value)` Copy the current immutable object by setting a present value for the optional `excludeCollection` attribute.
`ImmutableMongoDumpArguments`	`withExcludeCollectionWithPrefix(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `excludeCollectionWithPrefix` attribute.
`ImmutableMongoDumpArguments`	`withExcludeCollectionWithPrefix(String value)` Copy the current immutable object by setting a present value for the optional `excludeCollectionWithPrefix` attribute.
`ImmutableMongoDumpArguments`	`withForceTableScan(boolean value)` Copy the current immutable object by setting a value for the `forceTableScan` attribute.
`ImmutableMongoDumpArguments`	`withGzip(boolean value)` Copy the current immutable object by setting a value for the `gzip` attribute.
`ImmutableMongoDumpArguments`	`withIsOplog(boolean value)` Copy the current immutable object by setting a value for the `isOplog` attribute.
`ImmutableMongoDumpArguments`	`withNumberOfParallelCollections(int value)` Copy the current immutable object by setting a present value for the optional `numberOfParallelCollections` attribute.
`ImmutableMongoDumpArguments`	`withNumberOfParallelCollections(OptionalInt optional)` Copy the current immutable object by setting an optional value for the `numberOfParallelCollections` attribute.
`ImmutableMongoDumpArguments`	`withQuery(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `query` attribute.
`ImmutableMongoDumpArguments`	`withQuery(String value)` Copy the current immutable object by setting a present value for the optional `query` attribute.
`ImmutableMongoDumpArguments`	`withQueryFile(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `queryFile` attribute.
`ImmutableMongoDumpArguments`	`withQueryFile(String value)` Copy the current immutable object by setting a present value for the optional `queryFile` attribute.
`ImmutableMongoDumpArguments`	`withReadPreference(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `readPreference` attribute.
`ImmutableMongoDumpArguments`	`withReadPreference(String value)` Copy the current immutable object by setting a present value for the optional `readPreference` attribute.
`ImmutableMongoDumpArguments`	`withRepair(boolean value)` Copy the current immutable object by setting a value for the `repair` attribute.
`ImmutableMongoDumpArguments`	`withVerbose(boolean value)` Copy the current immutable object by setting a value for the `verbose` attribute.

Methods inherited from class de.flapdoodle.embed.mongo.commands.MongoDumpArguments
asArguments, defaults

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

- Method Detail
  - verbose
```
public boolean verbose()
```
    Overrides:
    
    verbose in class MongoDumpArguments
    
    Returns:
    
    The value of the verbose attribute
  - databaseName
```
public Optional<String> databaseName()
```
    Specified by:
    
    databaseName in class MongoDumpArguments
    
    Returns:
    
    The value of the databaseName attribute
  - collectionName
```
public Optional<String> collectionName()
```
    Specified by:
    
    collectionName in class MongoDumpArguments
    
    Returns:
    
    The value of the collectionName attribute
  - query
```
public Optional<String> query()
```
    Specified by:
    
    query in class MongoDumpArguments
    
    Returns:
    
    The value of the query attribute
  - queryFile
```
public Optional<String> queryFile()
```
    Specified by:
    
    queryFile in class MongoDumpArguments
    
    Returns:
    
    The value of the queryFile attribute
  - readPreference
```
public Optional<String> readPreference()
```
    Specified by:
    
    readPreference in class MongoDumpArguments
    
    Returns:
    
    The value of the readPreference attribute
  - forceTableScan
```
public boolean forceTableScan()
```
    Overrides:
    
    forceTableScan in class MongoDumpArguments
    
    Returns:
    
    The value of the forceTableScan attribute
  - archive
```
public Optional<String> archive()
```
    Specified by:
    
    archive in class MongoDumpArguments
    
    Returns:
    
    The value of the archive attribute
  - dumpDbUsersAndRoles
```
public boolean dumpDbUsersAndRoles()
```
    Overrides:
    
    dumpDbUsersAndRoles in class MongoDumpArguments
    
    Returns:
    
    The value of the dumpDbUsersAndRoles attribute
  - gzip
```
public boolean gzip()
```
    Overrides:
    
    gzip in class MongoDumpArguments
    
    Returns:
    
    The value of the gzip attribute
  - repair
```
public boolean repair()
```
    Overrides:
    
    repair in class MongoDumpArguments
    
    Returns:
    
    The value of the repair attribute
  - dir
```
public Optional<String> dir()
```
    Specified by:
    
    dir in class MongoDumpArguments
    
    Returns:
    
    The value of the dir attribute
  - isOplog
```
public boolean isOplog()
```
    Overrides:
    
    isOplog in class MongoDumpArguments
    
    Returns:
    
    The value of the isOplog attribute
  - excludeCollection
```
public Optional<String> excludeCollection()
```
    Specified by:
    
    excludeCollection in class MongoDumpArguments
    
    Returns:
    
    The value of the excludeCollection attribute
  - excludeCollectionWithPrefix
```
public Optional<String> excludeCollectionWithPrefix()
```
    Specified by:
    
    excludeCollectionWithPrefix in class MongoDumpArguments
    
    Returns:
    
    The value of the excludeCollectionWithPrefix attribute
  - numberOfParallelCollections
```
public OptionalInt numberOfParallelCollections()
```
    Specified by:
    
    numberOfParallelCollections in class MongoDumpArguments
    
    Returns:
    
    The value of the numberOfParallelCollections attribute
  - withVerbose
```
public final ImmutableMongoDumpArguments withVerbose(boolean value)
```
    Copy the current immutable object by setting a value for the verbose attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for verbose
    
    Returns:
    
    A modified copy of the this object
  - withDatabaseName
```
public final ImmutableMongoDumpArguments withDatabaseName(String value)
```
    Copy the current immutable object by setting a present value for the optional databaseName attribute.
    
    Parameters:
    
    value - The value for databaseName
    
    Returns:
    
    A modified copy of this object
  - withDatabaseName
```
public final ImmutableMongoDumpArguments withDatabaseName(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the databaseName attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for databaseName
    
    Returns:
    
    A modified copy of this object
  - withCollectionName
```
public final ImmutableMongoDumpArguments withCollectionName(String value)
```
    Copy the current immutable object by setting a present value for the optional collectionName attribute.
    
    Parameters:
    
    value - The value for collectionName
    
    Returns:
    
    A modified copy of this object
  - withCollectionName
```
public final ImmutableMongoDumpArguments withCollectionName(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the collectionName attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for collectionName
    
    Returns:
    
    A modified copy of this object
  - withQuery
```
public final ImmutableMongoDumpArguments withQuery(String value)
```
    Copy the current immutable object by setting a present value for the optional query attribute.
    
    Parameters:
    
    value - The value for query
    
    Returns:
    
    A modified copy of this object
  - withQuery
```
public final ImmutableMongoDumpArguments withQuery(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the query attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for query
    
    Returns:
    
    A modified copy of this object
  - withQueryFile
```
public final ImmutableMongoDumpArguments withQueryFile(String value)
```
    Copy the current immutable object by setting a present value for the optional queryFile attribute.
    
    Parameters:
    
    value - The value for queryFile
    
    Returns:
    
    A modified copy of this object
  - withQueryFile
```
public final ImmutableMongoDumpArguments withQueryFile(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the queryFile attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for queryFile
    
    Returns:
    
    A modified copy of this object
  - withReadPreference
```
public final ImmutableMongoDumpArguments withReadPreference(String value)
```
    Copy the current immutable object by setting a present value for the optional readPreference attribute.
    
    Parameters:
    
    value - The value for readPreference
    
    Returns:
    
    A modified copy of this object
  - withReadPreference
```
public final ImmutableMongoDumpArguments withReadPreference(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the readPreference attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for readPreference
    
    Returns:
    
    A modified copy of this object
  - withForceTableScan
```
public final ImmutableMongoDumpArguments withForceTableScan(boolean value)
```
    Copy the current immutable object by setting a value for the forceTableScan attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for forceTableScan
    
    Returns:
    
    A modified copy of the this object
  - withArchive
```
public final ImmutableMongoDumpArguments withArchive(String value)
```
    Copy the current immutable object by setting a present value for the optional archive attribute.
    
    Parameters:
    
    value - The value for archive
    
    Returns:
    
    A modified copy of this object
  - withArchive
```
public final ImmutableMongoDumpArguments withArchive(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the archive attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for archive
    
    Returns:
    
    A modified copy of this object
  - withDumpDbUsersAndRoles
```
public final ImmutableMongoDumpArguments withDumpDbUsersAndRoles(boolean value)
```
    Copy the current immutable object by setting a value for the dumpDbUsersAndRoles attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for dumpDbUsersAndRoles
    
    Returns:
    
    A modified copy of the this object
  - withGzip
```
public final ImmutableMongoDumpArguments withGzip(boolean value)
```
    Copy the current immutable object by setting a value for the gzip attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for gzip
    
    Returns:
    
    A modified copy of the this object
  - withRepair
```
public final ImmutableMongoDumpArguments withRepair(boolean value)
```
    Copy the current immutable object by setting a value for the repair attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for repair
    
    Returns:
    
    A modified copy of the this object
  - withDir
```
public final ImmutableMongoDumpArguments withDir(String value)
```
    Copy the current immutable object by setting a present value for the optional dir attribute.
    
    Parameters:
    
    value - The value for dir
    
    Returns:
    
    A modified copy of this object
  - withDir
```
public final ImmutableMongoDumpArguments withDir(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the dir attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for dir
    
    Returns:
    
    A modified copy of this object
  - withIsOplog
```
public final ImmutableMongoDumpArguments withIsOplog(boolean value)
```
    Copy the current immutable object by setting a value for the isOplog attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isOplog
    
    Returns:
    
    A modified copy of the this object
  - withExcludeCollection
```
public final ImmutableMongoDumpArguments withExcludeCollection(String value)
```
    Copy the current immutable object by setting a present value for the optional excludeCollection attribute.
    
    Parameters:
    
    value - The value for excludeCollection
    
    Returns:
    
    A modified copy of this object
  - withExcludeCollection
```
public final ImmutableMongoDumpArguments withExcludeCollection(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the excludeCollection attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for excludeCollection
    
    Returns:
    
    A modified copy of this object
  - withExcludeCollectionWithPrefix
```
public final ImmutableMongoDumpArguments withExcludeCollectionWithPrefix(String value)
```
    Copy the current immutable object by setting a present value for the optional excludeCollectionWithPrefix attribute.
    
    Parameters:
    
    value - The value for excludeCollectionWithPrefix
    
    Returns:
    
    A modified copy of this object
  - withExcludeCollectionWithPrefix
```
public final ImmutableMongoDumpArguments withExcludeCollectionWithPrefix(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the excludeCollectionWithPrefix attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for excludeCollectionWithPrefix
    
    Returns:
    
    A modified copy of this object
  - withNumberOfParallelCollections
```
public final ImmutableMongoDumpArguments withNumberOfParallelCollections(int value)
```
    Copy the current immutable object by setting a present value for the optional numberOfParallelCollections attribute.
    
    Parameters:
    
    value - The value for numberOfParallelCollections
    
    Returns:
    
    A modified copy of this object
  - withNumberOfParallelCollections
```
public final ImmutableMongoDumpArguments withNumberOfParallelCollections(OptionalInt optional)
```
    Copy the current immutable object by setting an optional value for the numberOfParallelCollections attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for numberOfParallelCollections
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableMongoDumpArguments that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: verbose, databaseName, collectionName, query, queryFile, readPreference, forceTableScan, archive, dumpDbUsersAndRoles, gzip, repair, dir, isOplog, excludeCollection, excludeCollectionWithPrefix, numberOfParallelCollections.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongoDumpArguments with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongoDumpArguments copyOf(MongoDumpArguments instance)
```
    Creates an immutable copy of a MongoDumpArguments value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable MongoDumpArguments instance
  - builder
```
public static ImmutableMongoDumpArguments.Builder builder()
```
    Creates a builder for ImmutableMongoDumpArguments.
```
 ImmutableMongoDumpArguments.builder()
    .verbose(boolean) // optional verbose
    .databaseName(String) // optional databaseName
    .collectionName(String) // optional collectionName
    .query(String) // optional query
    .queryFile(String) // optional queryFile
    .readPreference(String) // optional readPreference
    .forceTableScan(boolean) // optional forceTableScan
    .archive(String) // optional archive
    .dumpDbUsersAndRoles(boolean) // optional dumpDbUsersAndRoles
    .gzip(boolean) // optional gzip
    .repair(boolean) // optional repair
    .dir(String) // optional dir
    .isOplog(boolean) // optional isOplog
    .excludeCollection(String) // optional excludeCollection
    .excludeCollectionWithPrefix(String) // optional excludeCollectionWithPrefix
    .numberOfParallelCollections(int) // optional numberOfParallelCollections
    .build();
 
```
    Returns:
    
    A new ImmutableMongoDumpArguments builder

Class ImmutableMongoDumpArguments

Nested Class Summary

Method Summary

Methods inherited from class de.flapdoodle.embed.mongo.commands.MongoDumpArguments

Methods inherited from class java.lang.Object

Method Detail

verbose

databaseName

collectionName

query

queryFile

readPreference

forceTableScan

archive

dumpDbUsersAndRoles

gzip

repair

dir

isOplog

excludeCollection

excludeCollectionWithPrefix

numberOfParallelCollections

withVerbose

withDatabaseName

withDatabaseName

withCollectionName

withCollectionName

withQuery

withQuery

withQueryFile

withQueryFile

withReadPreference

withReadPreference

withForceTableScan

withArchive

withArchive

withDumpDbUsersAndRoles

withGzip

withRepair

withDir

withDir

withIsOplog

withExcludeCollection

withExcludeCollection

withExcludeCollectionWithPrefix

withExcludeCollectionWithPrefix

withNumberOfParallelCollections

withNumberOfParallelCollections

equals

hashCode

toString

copyOf

builder