Package io.github.primelib.webmethodsapigateway4j.model

Klasse SearchContext.SearchContextBuilder

java.lang.Object

io.github.primelib.webmethodsapigateway4j.model.SearchContext.SearchContextBuilder

Umschließende Klasse:

SearchContext

public static class SearchContext.SearchContextBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
SearchContext.SearchContextBuilder	aggregations(IAggregation aggregations)
SearchContext	build()
SearchContext.SearchContextBuilder	condition(SearchContext.ConditionEnum condition)	Condition between scope specified.
SearchContext.SearchContextBuilder	deploymentFilter(String deploymentFilter)	This filter is used for deployment types.
SearchContext.SearchContextBuilder	from(Integer from)	The starting index of the record to be fetched.
SearchContext.SearchContextBuilder	responseFields(List<String> responseFields)	List of fields to be fetched for the specified types.
SearchContext.SearchContextBuilder	scope(SearchField scope)
SearchContext.SearchContextBuilder	size(Integer size)	Number of records to be fetched.
SearchContext.SearchContextBuilder	sortByField(String sortByField)	Field name on which the sorting needs to be applied.
SearchContext.SearchContextBuilder	sortOrder(SearchContext.SortOrderEnum sortOrder)	Sort order for the records
SearchContext.SearchContextBuilder	teamFilter(List<String> teamFilter)	This filter is used to specify list teams to apply on the search results.
String	toString()
SearchContext.SearchContextBuilder	types(SearchContext.TypesEnum types)	List of allowed types that can be searched across API Gateway.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

aggregations

public SearchContext.SearchContextBuilder aggregations(IAggregation aggregations)

Gibt zurück:

this.

condition

public SearchContext.SearchContextBuilder condition(SearchContext.ConditionEnum condition)

Condition between scope specified. The value can be either 'and' or 'or'

Gibt zurück:

this.

deploymentFilter

public SearchContext.SearchContextBuilder deploymentFilter(String deploymentFilter)

This filter is used for deployment types.

Gibt zurück:

this.

from

public SearchContext.SearchContextBuilder from(Integer from)

The starting index of the record to be fetched. Default value is 0 which fetches from the start. The index is applied to each type separately. For each type the first n records are skipped as specified in from field. If the value specified is less than zero then the default value is taken for fetching records

Gibt zurück:

this.

responseFields

public SearchContext.SearchContextBuilder responseFields(List<String> responseFields)

List of fields to be fetched for the specified types.

Gibt zurück:

this.

scope

public SearchContext.SearchContextBuilder scope(SearchField scope)

Gibt zurück:

this.

size

public SearchContext.SearchContextBuilder size(Integer size)

Number of records to be fetched. Default value is -1, which fetches all the records. The size is applied to each type separately. Each type has the records less than or equal to the size specified. If the value specified is less than zero then the default value is taken for fetching records

Gibt zurück:

this.

sortByField

public SearchContext.SearchContextBuilder sortByField(String sortByField)

Field name on which the sorting needs to be applied.

Gibt zurück:

this.

sortOrder

public SearchContext.SearchContextBuilder sortOrder(SearchContext.SortOrderEnum sortOrder)

Sort order for the records

Gibt zurück:

this.

teamFilter

public SearchContext.SearchContextBuilder teamFilter(List<String> teamFilter)

This filter is used to specify list teams to apply on the search results.

Gibt zurück:

this.

types

public SearchContext.SearchContextBuilder types(SearchContext.TypesEnum types)

List of allowed types that can be searched across API Gateway.

Gibt zurück:

this.

build

public SearchContext build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object