Package com.atlassian.confluence.api.model.search

Class SearchContext

java.lang.Object

com.atlassian.confluence.api.model.search.SearchContext

public class SearchContext
extends Object

JSON serializable search context object to allow a user to specify the context they want a search to execute in.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchContext.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final SearchContext	EMPTY

Method Summary

Modifier and Type	Method	Description
static SearchContext.Builder	builder()
Optional<ContentId>	contentId()
Optional<List<ContentStatus>>	contentStatuses()
static SearchContext	deserialize(String searchContextJson, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
static SearchContext	deserializeJackson2(String searchContextJson, com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Optional<String>	spaceKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EMPTY

public static final SearchContext EMPTY

Method Details

contentId

public Optional<ContentId> contentId()

Since:

7.0.1

spaceKey

public Optional<String> spaceKey()

Since:

7.0.1

contentStatuses

public Optional<List<ContentStatus>> contentStatuses()

Since:

7.0.1

builder

public static SearchContext.Builder builder()

deserialize

public static SearchContext deserialize(String searchContextJson,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)

deserializeJackson2

public static SearchContext deserializeJackson2(String searchContextJson,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper)