com.ibm.watson.discovery.v1.model

Class EventData

java.lang.Object

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

com.ibm.watson.discovery.v1.model.EventData

All Implemented Interfaces:

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

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

Query event data object.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	clientTimestamp
protected java.lang.String	collectionId
protected java.lang.Long	displayRank
protected java.lang.String	documentId
protected java.lang.String	environmentId
protected java.lang.String	queryId
protected java.lang.String	sessionToken

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EventData(EventData.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	clientTimestamp() Gets the clientTimestamp.
java.lang.String	collectionId() Gets the collectionId.
java.lang.Long	displayRank() Gets the displayRank.
java.lang.String	documentId() Gets the documentId.
java.lang.String	environmentId() Gets the environmentId.
EventData.Builder	newBuilder() New builder.
java.lang.String	queryId() Gets the queryId.
java.lang.String	sessionToken() 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

environmentId

@SerializedName(value="environment_id")
protected java.lang.String environmentId

sessionToken

@SerializedName(value="session_token")
protected java.lang.String sessionToken

clientTimestamp

@SerializedName(value="client_timestamp")
protected java.util.Date clientTimestamp

displayRank

@SerializedName(value="display_rank")
protected java.lang.Long displayRank

collectionId

@SerializedName(value="collection_id")
protected java.lang.String collectionId

documentId

@SerializedName(value="document_id")
protected java.lang.String documentId

queryId

@SerializedName(value="query_id")
protected java.lang.String queryId

Constructor Detail

EventData

protected EventData(EventData.Builder builder)

Method Detail

newBuilder

public EventData.Builder newBuilder()

New builder.

Returns:

a EventData builder

environmentId

public java.lang.String environmentId()

Gets the environmentId.

The **environment_id** associated with the query that the event is associated with.

Returns:

the environmentId

sessionToken

public java.lang.String sessionToken()

Gets the sessionToken.

The session token that was returned as part of the query results that this event is associated with.

Returns:

the sessionToken

clientTimestamp

public java.util.Date clientTimestamp()

Gets the clientTimestamp.

The optional timestamp for the event that was created. If not provided, the time that the event was created in the log was used.

Returns:

the clientTimestamp

displayRank

public java.lang.Long displayRank()

Gets the displayRank.

The rank of the result item which the event is associated with.

Returns:

the displayRank

collectionId

public java.lang.String collectionId()

Gets the collectionId.

The **collection_id** of the document that this event is associated with.

Returns:

the collectionId

documentId

public java.lang.String documentId()

Gets the documentId.

The **document_id** of the document that this event is associated with.

Returns:

the documentId

queryId

public java.lang.String queryId()

Gets the queryId.

The query identifier stored in the log. The query and any events associated with that query are stored with the same **query_id**.

Returns:

the queryId