com.ibm.analytics.mdm.v0.model

Class DataSearchOptions

java.lang.Object

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

com.ibm.analytics.mdm.v0.model.DataSearchOptions

All Implemented Interfaces:

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

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

The dataSearch options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSearchOptions.Builder Builder.
static interface	DataSearchOptions.ReturnType The type of results to return from the search.

Method Summary

Modifier and Type	Method and Description
String	accept() Gets the accept.
InputStream	body() Gets the body.
String	contentType() Gets the contentType.
List<String>	exclude() Gets the exclude.
List<String>	include() Gets the include.
CriteriaRequest	incomingCriteria() Gets the incomingCriteria.
Long	limit() Gets the limit.
DataSearchOptions.Builder	newBuilder() New builder.
Long	offset() Gets the offset.
String	returnType() Gets the returnType.

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 DataSearchOptions.Builder newBuilder()

New builder.

Returns:

a DataSearchOptions builder

accept

public String accept()

Gets the accept. The type of the response: application/json, application/xml, or text/plain. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'.

Returns:

the accept

incomingCriteria

public CriteriaRequest incomingCriteria()

Gets the incomingCriteria. Valid input defining the search criteria.

Returns:

the incomingCriteria

body

public InputStream body()

Gets the body. Valid input defining the search criteria.

Returns:

the body

contentType

public String contentType()

Gets the contentType. The type of the input. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'.

Returns:

the contentType

returnType

public String returnType()

Gets the returnType. The type of results to return from the search.

Returns:

the returnType

limit

public Long limit()

Gets the limit. The maximum number of elements to return in each page of results. The maximum limit is 50.

Returns:

the limit

offset

public Long offset()

Gets the offset. The number of elements to skip before returning a page of results.

Returns:

the offset

include

public List<String> include()

Gets the include. Record attributes from the data model to include in the results.

Returns:

the include

exclude

public List<String> exclude()

Gets the exclude. Record attributes from the data model to exclude from the results.

Returns:

the exclude