com.ibm.watson.assistant.v1.model

Class ListValuesOptions

java.lang.Object

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

com.ibm.watson.assistant.v1.model.ListValuesOptions

All Implemented Interfaces:

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

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

The listValues options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListValuesOptions.Builder Builder.
static interface	ListValuesOptions.Sort The attribute by which returned entity values will be sorted.

Method Summary

Modifier and Type	Method and Description
String	cursor() Gets the cursor.
String	entity() Gets the entity.
Boolean	export() Gets the export.
Boolean	includeAudit() Gets the includeAudit.
Boolean	includeCount() Gets the includeCount.
ListValuesOptions.Builder	newBuilder() New builder.
Long	pageLimit() Gets the pageLimit.
String	sort() Gets the sort.
String	workspaceId() Gets the workspaceId.

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

New builder.

Returns:

a ListValuesOptions builder

workspaceId

public String workspaceId()

Gets the workspaceId.

Unique identifier of the workspace.

Returns:

the workspaceId

entity

public String entity()

Gets the entity.

The name of the entity.

Returns:

the entity

export

public Boolean export()

Gets the export.

Whether to include all element content in the returned data. If **export**=`false`, the returned data includes only information about the element itself. If **export**=`true`, all content, including subelements, is included.

Returns:

the export

pageLimit

public Long pageLimit()

Gets the pageLimit.

The number of records to return in each page of results.

Returns:

the pageLimit

includeCount

public Boolean includeCount()

Gets the includeCount.

Whether to include information about the number of records that satisfy the request, regardless of the page limit. If this parameter is `true`, the `pagination` object in the response includes the `total` property.

Returns:

the includeCount

sort

public String sort()

Gets the sort.

The attribute by which returned entity values will be sorted. To reverse the sort order, prefix the value with a minus sign (`-`).

Returns:

the sort

cursor

public String cursor()

Gets the cursor.

A token identifying the page of results to retrieve.

Returns:

the cursor

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

Whether to include the audit properties (`created` and `updated` timestamps) in the response.

Returns:

the includeAudit