Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentGuestSearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentGuestSearchRequest

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentGuestSearchRequest
extends Object
implements Serializable

KnowledgeDocumentGuestSearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentGuestSearchRequest.QueryTypeEnum	The type of the query that initiates the search.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentGuestSearchRequest()
KnowledgeDocumentGuestSearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentGuestSearchRequest	answerHighlightTopResults(Integer answerHighlightTopResults)	The number of articles to be sent for answer-highlighting.
boolean	equals(Object o)
Integer	getAnswerHighlightTopResults()
Boolean	getIncludeDraftDocuments()
Integer	getPageCount()
Integer	getPageNumber()
Integer	getPageSize()
String	getQuery()
KnowledgeDocumentGuestSearchRequest.QueryTypeEnum	getQueryType()
String	getSearchId()
String	getSessionId()
Integer	getTotal()
int	hashCode()
KnowledgeDocumentGuestSearchRequest	includeDraftDocuments(Boolean includeDraftDocuments)	Indicates whether the search results would also include draft documents.
KnowledgeDocumentGuestSearchRequest	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentGuestSearchRequest	pageSize(Integer pageSize)	Page size of the returned results.
KnowledgeDocumentGuestSearchRequest	query(String query)	Query to search content in the knowledge base.
KnowledgeDocumentGuestSearchRequest	queryType(KnowledgeDocumentGuestSearchRequest.QueryTypeEnum queryType)	The type of the query that initiates the search.
void	setAnswerHighlightTopResults(Integer answerHighlightTopResults)
void	setIncludeDraftDocuments(Boolean includeDraftDocuments)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQuery(String query)
void	setQueryType(KnowledgeDocumentGuestSearchRequest.QueryTypeEnum queryType)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentGuestSearchRequest

public KnowledgeDocumentGuestSearchRequest()

KnowledgeDocumentGuestSearchRequest

public KnowledgeDocumentGuestSearchRequest(Boolean initWithEmptyList)

Method Details

query

public KnowledgeDocumentGuestSearchRequest query(String query)

Query to search content in the knowledge base. Maximum of 30 records per query can be fetched.

getQuery

public String getQuery()

setQuery

public void setQuery(String query)

pageSize

public KnowledgeDocumentGuestSearchRequest pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public KnowledgeDocumentGuestSearchRequest pageNumber(Integer pageNumber)

Page number of the returned results.

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

getSearchId

public String getSearchId()

getTotal

public Integer getTotal()

getPageCount

public Integer getPageCount()

queryType

public KnowledgeDocumentGuestSearchRequest queryType(KnowledgeDocumentGuestSearchRequest.QueryTypeEnum queryType)

The type of the query that initiates the search.

getQueryType

public KnowledgeDocumentGuestSearchRequest.QueryTypeEnum getQueryType()

setQueryType

public void setQueryType(KnowledgeDocumentGuestSearchRequest.QueryTypeEnum queryType)

getSessionId

public String getSessionId()

answerHighlightTopResults

public KnowledgeDocumentGuestSearchRequest answerHighlightTopResults(Integer answerHighlightTopResults)

The number of articles to be sent for answer-highlighting. Can range from 1-5. minimum: 1 maximum: 5

getAnswerHighlightTopResults

public Integer getAnswerHighlightTopResults()

setAnswerHighlightTopResults

public void setAnswerHighlightTopResults(Integer answerHighlightTopResults)

includeDraftDocuments

public KnowledgeDocumentGuestSearchRequest includeDraftDocuments(Boolean includeDraftDocuments)

Indicates whether the search results would also include draft documents.

getIncludeDraftDocuments

public Boolean getIncludeDraftDocuments()

setIncludeDraftDocuments

public void setIncludeDraftDocuments(Boolean includeDraftDocuments)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object