com.ibm.watson.discovery.v2.model

Class DefaultQueryParamsPassages

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.DefaultQueryParamsPassages

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class DefaultQueryParamsPassages
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Default settings configuration for passage search options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultQueryParamsPassages.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	characters
protected java.lang.Long	count
protected java.lang.Boolean	enabled
protected java.util.List<java.lang.String>	fields
protected java.lang.Long	maxPerDocument
protected java.lang.Boolean	perDocument

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultQueryParamsPassages(DefaultQueryParamsPassages.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	characters() Gets the characters.
java.lang.Long	count() Gets the count.
java.lang.Boolean	enabled() Gets the enabled.
java.util.List<java.lang.String>	fields() Gets the fields.
java.lang.Long	maxPerDocument() Gets the maxPerDocument.
DefaultQueryParamsPassages.Builder	newBuilder() New builder.
java.lang.Boolean	perDocument() Gets the perDocument.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

enabled

protected java.lang.Boolean enabled

count

protected java.lang.Long count

fields

protected java.util.List<java.lang.String> fields

characters

protected java.lang.Long characters

perDocument

@SerializedName(value="per_document")
protected java.lang.Boolean perDocument

maxPerDocument

@SerializedName(value="max_per_document")
protected java.lang.Long maxPerDocument

Constructor Detail

DefaultQueryParamsPassages

protected DefaultQueryParamsPassages(DefaultQueryParamsPassages.Builder builder)

Method Detail

newBuilder

public DefaultQueryParamsPassages.Builder newBuilder()

New builder.

Returns:

a DefaultQueryParamsPassages builder

enabled

public java.lang.Boolean enabled()

Gets the enabled.

When `true`, a passage search is performed by default.

Returns:

the enabled

count

public java.lang.Long count()

Gets the count.

The number of passages to return.

Returns:

the count

fields

public java.util.List<java.lang.String> fields()

Gets the fields.

An array of field names to perfom the passage search on.

Returns:

the fields

characters

public java.lang.Long characters()

Gets the characters.

The approximate number of characters that each returned passage will contain.

Returns:

the characters

perDocument

public java.lang.Boolean perDocument()

Gets the perDocument.

When `true` the number of passages that can be returned from a single document is restricted to the *max_per_document* value.

Returns:

the perDocument

maxPerDocument

public java.lang.Long maxPerDocument()

Gets the maxPerDocument.

The default maximum number of passages that can be taken from a single document as the result of a passage query.

Returns:

the maxPerDocument