org.everit.atlassian.restclient.jiracloud.v3.api

Class SearchAutoCompleteApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.SearchAutoCompleteApi

public class SearchAutoCompleteApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchAutoCompleteApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<JQLReferenceData>	getAutoComplete(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field reference data Returns reference data for JQL searches.
io.reactivex.Single<AutoCompleteSuggestions>	getFieldAutoCompleteForQueryString(Optional<String> fieldName, Optional<String> fieldValue, Optional<String> predicateName, Optional<String> predicateValue, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get field auto complete suggestions Returns the JQL search auto complete suggestions for a field.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAutoCompleteApi

public SearchAutoCompleteApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getAutoComplete

public io.reactivex.Single<JQLReferenceData> getAutoComplete(Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get field reference data

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<JQLReferenceData>

getFieldAutoCompleteForQueryString

public io.reactivex.Single<AutoCompleteSuggestions> getFieldAutoCompleteForQueryString(Optional<String> fieldName,
                                                                                       Optional<String> fieldValue,
                                                                                       Optional<String> predicateName,
                                                                                       Optional<String> predicateValue,
                                                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get field auto complete suggestions

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

• fieldName to get a list of all values for the field.
• fieldName and fieldValue to get a list of values containing the text in fieldValue.
• fieldName and predicateName to get a list of all predicate values for the field.
• fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

fieldName -

The name of the field.

(optional)

fieldValue -

The partial field item name entered by the user.

(optional)

predicateName -

The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.

(optional)

predicateValue -

The partial predicate item name entered by the user.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<AutoCompleteSuggestions>