com.ibm.watson.compare_comply.v1.model

Class ListFeedbackOptions

java.lang.Object

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

com.ibm.watson.compare_comply.v1.model.ListFeedbackOptions

All Implemented Interfaces:

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

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

The listFeedback options.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	after
protected java.util.Date	before
protected java.lang.String	categoryAdded
protected java.lang.String	categoryNotChanged
protected java.lang.String	categoryRemoved
protected java.lang.String	cursor
protected java.lang.String	documentTitle
protected java.lang.String	feedbackType
protected java.lang.Boolean	includeTotal
protected java.lang.String	modelId
protected java.lang.String	modelVersion
protected java.lang.Long	pageLimit
protected java.lang.String	sort
protected java.lang.String	typeAdded
protected java.lang.String	typeNotChanged
protected java.lang.String	typeRemoved

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	after() Gets the after.
java.util.Date	before() Gets the before.
java.lang.String	categoryAdded() Gets the categoryAdded.
java.lang.String	categoryNotChanged() Gets the categoryNotChanged.
java.lang.String	categoryRemoved() Gets the categoryRemoved.
java.lang.String	cursor() Gets the cursor.
java.lang.String	documentTitle() Gets the documentTitle.
java.lang.String	feedbackType() Gets the feedbackType.
java.lang.Boolean	includeTotal() Gets the includeTotal.
java.lang.String	modelId() Gets the modelId.
java.lang.String	modelVersion() Gets the modelVersion.
ListFeedbackOptions.Builder	newBuilder() New builder.
java.lang.Long	pageLimit() Gets the pageLimit.
java.lang.String	sort() Gets the sort.
java.lang.String	typeAdded() Gets the typeAdded.
java.lang.String	typeNotChanged() Gets the typeNotChanged.
java.lang.String	typeRemoved() Gets the typeRemoved.

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

feedbackType

protected java.lang.String feedbackType

before

protected java.util.Date before

after

protected java.util.Date after

documentTitle

protected java.lang.String documentTitle

modelId

protected java.lang.String modelId

modelVersion

protected java.lang.String modelVersion

categoryRemoved

protected java.lang.String categoryRemoved

categoryAdded

protected java.lang.String categoryAdded

categoryNotChanged

protected java.lang.String categoryNotChanged

typeRemoved

protected java.lang.String typeRemoved

typeAdded

protected java.lang.String typeAdded

typeNotChanged

protected java.lang.String typeNotChanged

pageLimit

protected java.lang.Long pageLimit

cursor

protected java.lang.String cursor

sort

protected java.lang.String sort

includeTotal

protected java.lang.Boolean includeTotal

Constructor Detail

ListFeedbackOptions

protected ListFeedbackOptions(ListFeedbackOptions.Builder builder)

Method Detail

newBuilder

public ListFeedbackOptions.Builder newBuilder()

New builder.

Returns:

a ListFeedbackOptions builder

feedbackType

public java.lang.String feedbackType()

Gets the feedbackType.

An optional string that filters the output to include only feedback with the specified feedback type. The only permitted value is `element_classification`.

Returns:

the feedbackType

before

public java.util.Date before()

Gets the before.

An optional string in the format `YYYY-MM-DD` that filters the output to include only feedback that was added before the specified date.

Returns:

the before

after

public java.util.Date after()

Gets the after.

An optional string in the format `YYYY-MM-DD` that filters the output to include only feedback that was added after the specified date.

Returns:

the after

documentTitle

public java.lang.String documentTitle()

Gets the documentTitle.

An optional string that filters the output to include only feedback from the document with the specified `document_title`.

Returns:

the documentTitle

modelId

public java.lang.String modelId()

Gets the modelId.

An optional string that filters the output to include only feedback with the specified `model_id`. The only permitted value is `contracts`.

Returns:

the modelId

modelVersion

public java.lang.String modelVersion()

Gets the modelVersion.

An optional string that filters the output to include only feedback with the specified `model_version`.

Returns:

the modelVersion

categoryRemoved

public java.lang.String categoryRemoved()

Gets the categoryRemoved.

An optional string in the form of a comma-separated list of categories. If it is specified, the service filters the output to include only feedback that has at least one category from the list removed.

Returns:

the categoryRemoved

categoryAdded

public java.lang.String categoryAdded()

Gets the categoryAdded.

An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list added.

Returns:

the categoryAdded

categoryNotChanged

public java.lang.String categoryNotChanged()

Gets the categoryNotChanged.

An optional string in the form of a comma-separated list of categories. If this is specified, the service filters the output to include only feedback that has at least one category from the list unchanged.

Returns:

the categoryNotChanged

typeRemoved

public java.lang.String typeRemoved()

Gets the typeRemoved.

An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list removed.

Returns:

the typeRemoved

typeAdded

public java.lang.String typeAdded()

Gets the typeAdded.

An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list removed.

Returns:

the typeAdded

typeNotChanged

public java.lang.String typeNotChanged()

Gets the typeNotChanged.

An optional string of comma-separated `nature`:`party` pairs. If this is specified, the service filters the output to include only feedback that has at least one `nature`:`party` pair from the list unchanged.

Returns:

the typeNotChanged

pageLimit

public java.lang.Long pageLimit()

Gets the pageLimit.

An optional integer specifying the number of documents that you want the service to return.

Returns:

the pageLimit

cursor

public java.lang.String cursor()

Gets the cursor.

An optional string that returns the set of documents after the previous set. Use this parameter with the `page_limit` parameter.

Returns:

the cursor

sort

public java.lang.String sort()

Gets the sort.

An optional comma-separated list of fields in the document to sort on. You can optionally specify the sort direction by prefixing the value of the field with `-` for descending order or `+` for ascending order (the default). Currently permitted sorting fields are `created`, `user_id`, and `document_title`.

Returns:

the sort

includeTotal

public java.lang.Boolean includeTotal()

Gets the includeTotal.

An optional boolean value. If specified as `true`, the `pagination` object in the output includes a value called `total` that gives the total count of feedback created.

Returns:

the includeTotal