public class LogQueryResponseResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel
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.
|
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.
|
public String getEnvironmentId()
The environment ID that is associated with this log entry.
public String getCustomerId()
The **customer_id** label that was specified in the header of the query or event API call that corresponds to this log entry.
public String getDocumentType()
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.
public String getNaturalLanguageQuery()
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.
public LogQueryResponseResultDocuments getDocumentResults()
Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type `query`.
public Date getCreatedTimestamp()
Date that the log result was created. Returned in `YYYY-MM-DDThh:mm:ssZ` format.
public Date getClientTimestamp()
Date specified by the user when recording an event. Returned in `YYYY-MM-DDThh:mm:ssZ` format. Only returned with logs of type **event**.
public String getQueryId()
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).
public String getSessionToken()
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.
public String getCollectionId()
The collection ID of the document associated with this event. Only returned with logs of type `event`.
public Long getDisplayRank()
The original display rank of the document associated with this event. Only returned with logs of type `event`.
public String getDocumentId()
The document ID of the document associated with this event. Only returned with logs of type `event`.
public String getEventType()
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.
public String getResultType()
The type of result that this **event** is associated with. Only returned with logs of type `event`.
Copyright © 2023 IBM Cloud. All rights reserved.