com.ibm.watson.discovery.v1.model

Class LogQueryResponseResult

java.lang.Object

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

com.ibm.watson.discovery.v1.model.LogQueryResponseResult

All Implemented Interfaces:

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

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

Individual result object for a **logs** query. Each object represents either a query to a Discovery collection or an event that is associated with a query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LogQueryResponseResult.DocumentType The type of log entry returned.
static interface	LogQueryResponseResult.EventType The type of event that this object respresents.
static interface	LogQueryResponseResult.ResultType The type of result that this **event** is associated with.

Method Summary

Modifier and Type	Method and Description
Date	getClientTimestamp() Gets the clientTimestamp.
String	getCollectionId() Gets the collectionId.
Date	getCreatedTimestamp() Gets the createdTimestamp.
String	getCustomerId() Gets the customerId.
Long	getDisplayRank() Gets the displayRank.
String	getDocumentId() Gets the documentId.
LogQueryResponseResultDocuments	getDocumentResults() Gets the documentResults.
String	getDocumentType() Gets the documentType.
String	getEnvironmentId() Gets the environmentId.
String	getEventType() Gets the eventType.
String	getNaturalLanguageQuery() Gets the naturalLanguageQuery.
String	getQueryId() Gets the queryId.
String	getResultType() Gets the resultType.
String	getSessionToken() Gets the sessionToken.

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

getEnvironmentId

public String getEnvironmentId()

Gets the environmentId.

The environment ID that is associated with this log entry.

Returns:

the environmentId

getCustomerId

public String getCustomerId()

Gets the customerId.

The **customer_id** label that was specified in the header of the query or event API call that corresponds to this log entry.

Returns:

the customerId

getDocumentType

public String getDocumentType()

Gets the documentType.

The type of log entry returned.

**query** indicates that the log represents the results of a call to the single collection **query** method.

**event** indicates that the log represents a call to the **events** API.

Returns:

the documentType

getNaturalLanguageQuery

public String getNaturalLanguageQuery()

Gets the naturalLanguageQuery.

The value of the **natural_language_query** query parameter that was used to create these results. Only returned with logs of type **query**.

**Note:** Other query parameters (such as **filter** or **deduplicate**) might have been used with this query, but are not recorded.

Returns:

the naturalLanguageQuery

getDocumentResults

public LogQueryResponseResultDocuments getDocumentResults()

Gets the documentResults.

Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type `query`.

Returns:

the documentResults

getCreatedTimestamp

public Date getCreatedTimestamp()

Gets the createdTimestamp.

Date that the log result was created. Returned in `YYYY-MM-DDThh:mm:ssZ` format.

Returns:

the createdTimestamp

getClientTimestamp

public Date getClientTimestamp()

Gets the clientTimestamp.

Date specified by the user when recording an event. Returned in `YYYY-MM-DDThh:mm:ssZ` format. Only returned with logs of type **event**.

Returns:

the clientTimestamp

getQueryId

public String getQueryId()

Gets the queryId.

Identifier that corresponds to the **natural_language_query** string used in the original or associated query. All **event** and **query** log entries that have the same original **natural_language_query** string also have them same **query_id**. This field can be used to recall all **event** and **query** log results that have the same original query (**event** logs do not contain the original **natural_language_query** field).

Returns:

the queryId

getSessionToken

public String getSessionToken()

Gets the sessionToken.

Unique identifier (within a 24-hour period) that identifies a single `query` log and any `event` logs that were created for it.

**Note:** If the exact same query is run at the exact same time on different days, the **session_token** for those queries might be identical. However, the **created_timestamp** differs.

**Note:** Session tokens are case sensitive. To avoid matching on session tokens that are identical except for case, use the exact match operator (`::`) when you query for a specific session token.

Returns:

the sessionToken

getCollectionId

public String getCollectionId()

Gets the collectionId.

The collection ID of the document associated with this event. Only returned with logs of type `event`.

Returns:

the collectionId

getDisplayRank

public Long getDisplayRank()

Gets the displayRank.

The original display rank of the document associated with this event. Only returned with logs of type `event`.

Returns:

the displayRank

getDocumentId

public String getDocumentId()

Gets the documentId.

The document ID of the document associated with this event. Only returned with logs of type `event`.

Returns:

the documentId

getEventType

public String getEventType()

Gets the eventType.

The type of event that this object respresents. Possible values are

- `query` the log of a query to a collection

- `click` the result of a call to the **events** endpoint.

Returns:

the eventType

getResultType

public String getResultType()

Gets the resultType.

The type of result that this **event** is associated with. Only returned with logs of type `event`.

Returns:

the resultType