com.ibm.watson.assistant.v2.model

Class ListLogsOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.model.ListLogsOptions

All Implemented Interfaces:

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

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

The listLogs options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	assistantId() Gets the assistantId.
String	cursor() Gets the cursor.
String	filter() Gets the filter.
ListLogsOptions.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 ListLogsOptions.Builder newBuilder()

New builder.

Returns:

a ListLogsOptions 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 Watson 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

sort

public String sort()

Gets the sort.

How to sort the returned log events. You can sort by **request_timestamp**. To reverse the sort order, prefix the parameter value with a minus sign (`-`).

Returns:

the sort

filter

public String filter()

Gets the filter.

A cacheable parameter that limits the results to those matching the specified filter. For more information, see the [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference).

Returns:

the filter

pageLimit

public Long pageLimit()

Gets the pageLimit.

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

Returns:

the pageLimit

cursor

public String cursor()

Gets the cursor.

A token identifying the page of results to retrieve.

Returns:

the cursor