com.ibm.analytics.mdm.v0.model

Class SearchIndexOptions

java.lang.Object

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

com.ibm.analytics.mdm.v0.model.SearchIndexOptions

All Implemented Interfaces:

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

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

The searchIndex options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
CompareRecordsRequestAttributes	attributes() Gets the attributes.
String	crn() Gets the crn.
String	details() Gets the details.
String	entityType() Gets the entityType.
String	limit() Gets the limit.
String	maxScore() Gets the maxScore.
String	minScore() Gets the minScore.
SearchIndexOptions.Builder	newBuilder() New builder.
String	offset() Gets the offset.
String	recordType() Gets the recordType.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public SearchIndexOptions.Builder newBuilder()

New builder.

Returns:

a SearchIndexOptions builder

crn

public String crn()

Gets the crn. The Cloud Resource Name (CRN) that uniquely identifies your dedicated resource on the cloud.

Returns:

the crn

recordType

public String recordType()

Gets the recordType. The data type identifier of the record, ie. person, organization.

Returns:

the recordType

attributes

public CompareRecordsRequestAttributes attributes()

Gets the attributes. Details of a single record including external record reference and record attributes.

Returns:

the attributes

details

public String details()

Gets the details. The level of information detail in response, ie. low, high, debug.

Returns:

the details

minScore

public String minScore()

Gets the minScore. The minimum score to filter the matching records in the results. The default min_score is 0.

Returns:

the minScore

maxScore

public String maxScore()

Gets the maxScore. The maximum score to filter the matching records in the results. The default max_score is 32767.

Returns:

the maxScore

offset

public String offset()

Gets the offset. The number of entries to skip before returning a page of results. The default offset is 0.

Returns:

the offset

entityType

public String entityType()

Gets the entityType. The data type identifier of entity, ie. person_entity, organization_entity, household_entity.

Returns:

the entityType

limit

public String limit()

Gets the limit. The maximum expected number of entries in each page of results. The default limit is 20.

Returns:

the limit