case class SearchRequest(baseObject: LdapDN, scope: SearchRequest.SearchScope.Value, deferAliases: SearchRequest.Aliases.Value, sizeLimit: Int, timeLimit: Int, typesOnly: Boolean, filter: Filter, attributes: Vector[AttributeSelector]) extends ProtocolOp with Product with Serializable
Request to perform a LDAP search.
- baseObject
The name of the base object entry.
- scope
The scope of the search.
- deferAliases
An indicator as to whether or not alias entries are to be dereferenced during stages of the Search operation.
- sizeLimit
The number of entries to be returned
- timeLimit
The time limit for the search in seconds
- typesOnly
Whether the result should include only the attribute descriptions (false) or if we want to return the values to the descriptions as well (true).
- filter
A filter that defines the conditions that must be fulfilled in order for the search to be matched.
- attributes
A selection of attributes to be returned for search entries that match this search.
- Source
- SearchRequest.scala
- Alphabetic
- By Inheritance
- SearchRequest
- Serializable
- Product
- Equals
- ProtocolOp
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SearchRequest(baseObject: LdapDN, scope: SearchRequest.SearchScope.Value, deferAliases: SearchRequest.Aliases.Value, sizeLimit: Int, timeLimit: Int, typesOnly: Boolean, filter: Filter, attributes: Vector[AttributeSelector])
- baseObject
The name of the base object entry.
- scope
The scope of the search.
- deferAliases
An indicator as to whether or not alias entries are to be dereferenced during stages of the Search operation.
- sizeLimit
The number of entries to be returned
- timeLimit
The time limit for the search in seconds
- typesOnly
Whether the result should include only the attribute descriptions (false) or if we want to return the values to the descriptions as well (true).
- filter
A filter that defines the conditions that must be fulfilled in order for the search to be matched.
- attributes
A selection of attributes to be returned for search entries that match this search.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from SearchRequest toany2stringadd[SearchRequest] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (SearchRequest, B)
- Implicit
- This member is added by an implicit conversion from SearchRequest toArrowAssoc[SearchRequest] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val attributes: Vector[AttributeSelector]
- val baseObject: LdapDN
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val deferAliases: SearchRequest.Aliases.Value
- def ensuring(cond: (SearchRequest) => Boolean, msg: => Any): SearchRequest
- Implicit
- This member is added by an implicit conversion from SearchRequest toEnsuring[SearchRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (SearchRequest) => Boolean): SearchRequest
- Implicit
- This member is added by an implicit conversion from SearchRequest toEnsuring[SearchRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): SearchRequest
- Implicit
- This member is added by an implicit conversion from SearchRequest toEnsuring[SearchRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): SearchRequest
- Implicit
- This member is added by an implicit conversion from SearchRequest toEnsuring[SearchRequest] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val filter: Filter
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from SearchRequest toStringFormat[SearchRequest] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val scope: SearchRequest.SearchScope.Value
- val sizeLimit: Int
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeLimit: Int
- val typesOnly: Boolean
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (SearchRequest, B)
- Implicit
- This member is added by an implicit conversion from SearchRequest toArrowAssoc[SearchRequest] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.