Class/Object

com.mongodb.spark.config

ReadPreferenceConfig

Related Docs: object ReadPreferenceConfig | package config

Permalink

case class ReadPreferenceConfig(name: String = "primary", tagSets: Option[String] = None) extends MongoClassConfig with Product with Serializable

The ReadPreference configuration used by the ReadConfig

name

the read preference name

tagSets

optional string of tagSets

Since

1.0

Linear Supertypes
Product, Equals, MongoClassConfig, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ReadPreferenceConfig
  2. Product
  3. Equals
  4. MongoClassConfig
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReadPreferenceConfig(name: String = "primary", tagSets: Option[String] = None)

    Permalink

    name

    the read preference name

    tagSets

    optional string of tagSets

Type Members

  1. type Self = ReadPreferenceConfig

    Permalink

    Defines Self as a type that can be used to return a copy of the object i.e.

    Defines Self as a type that can be used to return a copy of the object i.e. a different instance of the same type

    Definition Classes
    ReadPreferenceConfigMongoClassConfig

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def asJavaOptions: Map[String, String]

    Permalink

    Creates a map of options representing the configuration

    Creates a map of options representing the configuration

    returns

    the map representing the configuration values

    Definition Classes
    ReadPreferenceConfigMongoClassConfig
  6. def asOptions: Map[String, String]

    Permalink

    Creates a map of options representing this config.

    Creates a map of options representing this config.

    returns

    the map representing the config

    Definition Classes
    ReadPreferenceConfigMongoClassConfig
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. def readPreference: ReadPreference

    Permalink

    The ReadPreference that this configuration represents

    The ReadPreference that this configuration represents

    returns

    the ReadPreference

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def withJavaOptions(options: Map[String, String]): ReadPreferenceConfig

    Permalink

    Creates a new config with the options applied

    Creates a new config with the options applied

    options

    a map of options to be applied to the config

    returns

    an updated config

    Definition Classes
    ReadPreferenceConfigMongoClassConfig
  21. def withOptions(options: Map[String, String]): Self

    Permalink

    Creates a new config with the options applied

    Creates a new config with the options applied

    options

    a map of options to be applied to the config

    returns

    an updated config

    Definition Classes
    ReadPreferenceConfigMongoClassConfig

Inherited from Product

Inherited from Equals

Inherited from MongoClassConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped