InnerHits

zio.elasticsearch.query.InnerHits
See theInnerHits companion object
final case class InnerHits

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Value members

Concrete methods

def excludes[S](field: Field[S, _], fields: Field[S, _]*): InnerHits

Specifies one or more type-safe fields to be excluded in the response of a zio.elasticsearch.query.InnerHits.

Specifies one or more type-safe fields to be excluded in the response of a zio.elasticsearch.query.InnerHits.

Type parameters

S

document which fields are excluded

Value parameters

field

a type-safe field to be excluded

fields

type-safe fields to be excluded

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with specified fields to be excluded.

def excludes(field: String, fields: String*): InnerHits

Specifies one or more fields to be excluded in the response of a zio.elasticsearch.query.InnerHits.

Specifies one or more fields to be excluded in the response of a zio.elasticsearch.query.InnerHits.

Value parameters

field

a field to be excluded

fields

fields to be excluded

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with specified fields to be excluded.

def from(value: Int): InnerHits

Specifies the starting offset of the zio.elasticsearch.query.InnerHits to be returned.

Specifies the starting offset of the zio.elasticsearch.query.InnerHits to be returned.

Value parameters

value

the starting offset value

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with the specified starting offset.

def highlights(value: Highlights): InnerHits

Specifies the highlighting configuration for the zio.elasticsearch.query.InnerHits.

Specifies the highlighting configuration for the zio.elasticsearch.query.InnerHits.

Value parameters

value

the zio.elasticsearch.highlights.Highlights configuration

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with the specified highlighting configuration.

def includes[S](field: Field[S, _], fields: Field[S, _]*): InnerHits

Specifies one or more type-safe fields to be included in the response of a zio.elasticsearch.query.InnerHits.

Specifies one or more type-safe fields to be included in the response of a zio.elasticsearch.query.InnerHits.

Type parameters

S

document which fields are included

Value parameters

field

a type-safe field to be included

fields

type-safe fields to be included

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with specified fields to be included.

def includes(field: String, fields: String*): InnerHits

Specifies one or more fields to be included in the response of a zio.elasticsearch.query.InnerHits.

Specifies one or more fields to be included in the response of a zio.elasticsearch.query.InnerHits.

Value parameters

field

a field to be included

fields

fields to be included

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with specified fields to be included.

def name(value: String): InnerHits

Specifies the name of the zio.elasticsearch.query.InnerHits.

Specifies the name of the zio.elasticsearch.query.InnerHits.

Value parameters

value

the name of the zio.elasticsearch.query.InnerHits

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with the specified name.

def size(value: Int): InnerHits

Specifies the maximum number of zio.elasticsearch.query.InnerHits to be returned.

Specifies the maximum number of zio.elasticsearch.query.InnerHits to be returned.

Value parameters

value

the maximum number of zio.elasticsearch.query.InnerHits

Attributes

Returns

an instance of a zio.elasticsearch.query.InnerHits with the specified size.

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product