com.ibm.watson.assistant.v2.model

Class ListReleasesOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.model.ListReleasesOptions

All Implemented Interfaces:

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

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

The listReleases options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListReleasesOptions.Builder Builder.
static interface	ListReleasesOptions.Sort The attribute by which returned workspaces will be sorted.

Method Summary

Modifier and Type	Method and Description
String	assistantId() Gets the assistantId.
String	cursor() Gets the cursor.
Boolean	includeAudit() Gets the includeAudit.
Boolean	includeCount() Gets the includeCount.
ListReleasesOptions.Builder	newBuilder() New builder.
Long	pageLimit() Gets the pageLimit.
String	sort() Gets the sort.

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

New builder.

Returns:

a ListReleasesOptions builder

assistantId

public String assistantId()

Gets the assistantId.

The assistant ID or the environment ID of the environment where the assistant is deployed, depending on the type of request: - For message, session, and log requests, specify the environment ID of the environment where the assistant is deployed. - For all other requests, specify the assistant ID of the assistant.

To find the environment ID or assistant ID in the watsonx Assistant user interface, open the assistant settings and scroll to the **Environments** section.

**Note:** If you are using the classic Watson Assistant experience, always use the assistant ID. To find the assistant ID in the user interface, open the assistant settings and click API Details.

Returns:

the assistantId

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 workspaces 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