firesearch_sdk library
Classes
- AccessKeyService
- AccessKeyService provides keys needed to perform searches.
- AutocompleteDoc
- AutocompleteDoc describes a document that can be searched.
- AutocompleteIndex
- AutocompleteIndex describes a search index.
- AutocompleteService
- AutocompleteService provides the ability to create and manage autocomplete indexes, as well as populate them with data, and perform lookups.
- CheckIndexNameRequest
- CheckIndexNameRequest is the input for CheckIndexPath.
- CheckIndexNameResponse
- CheckIndexNameResponse is the output for CheckIndexName.
- CheckIndexPathRequest
- CheckIndexPathRequest is the input object for CheckIndexPath.
- CheckIndexPathResult
- CheckIndexPathResponse is the output for CheckIndexPath.
- Client
- Firesearch Client
- CompleteQuery
- CompleteQuery describes a search query.
- CompleteRequest
- CompleteRequest is the input object for Search.
- CompleteResponse
- CompleteResponse is the output object for Search.
- CreateAutocompleteIndexRequest
- CreateAutocompleteIndexRequest is the input object for CreateAutocompleteIndex.
- CreateAutocompleteIndexResponse
- CreateAutocompleteIndexResponse is the output object for CreateAutocompleteIndex.
- CreateIndexRequest
- CreateIndexRequest is the input object for CreateIndex.
- CreateIndexResponse
- CreateIndexResponse is the output object for CreateIndex.
- DeleteAutocompleteDocRequest
- DeleteAutocompleteDocRequest is the input object for DeleteAutocompleteDoc.
- DeleteAutocompleteDocResponse
- DeleteAutocompleteDocResponse is the output object for DeleteAutocompleteDoc.
- DeleteAutocompleteIndexRequest
- DeleteAutocompleteIndexRequest is the input object for DeleteAutocompleteIndex.
- DeleteAutocompleteIndexResponse
- DeleteAutocompleteIndexResponse is the output object for DeleteAutocompleteIndex.
- DeleteDocRequest
- DeleteDocRequest is the input object for DeleteDoc.
- DeleteDocResponse
- DeleteDocResponse is the output object for DeleteDoc.
- DeleteIndexRequest
- DeleteIndexRequest is the input object for DeleteIndex.
- DeleteIndexResponse
- DeleteIndexResponse is the output object for DeleteIndex.
- Doc
- Doc describes a document that can be searched.
- Field
- Field is a non-searchable key/value pair that can be filtered at query time.
- FiresearchHttpClient
- The implementation of a Firesearch Http Client
- GenerateKeyRequest
- GenerateKeyRequest is the input object for GenerateKey.
- GenerateKeyResponse
- GenerateKeyResponse is the output object for GenerateKey
- GetAutocompleteIndexesResponse
- GetAutocompleteIndexesResponse is the output object for GetAutocompleteIndexes.
- GetAutocompleteIndexRequest
- GetAutocompleteIndexRequest is the input object for GetAutocompleteIndex.
- GetAutocompleteIndexResponse
- GetAutocompleteIndexResponse is the output object for GetAutocompleteIndex.
- GetIndexesResponse
- GetIndexesResponse is the output object for GetIndexes.
- GetIndexRequest
- GetIndexRequest is the input object for GetIndex.
- GetIndexResponse
- GetIndexResponse is the output object for GetIndex.
- Highlight
- Highlight describes an area that specifically matches a search query.
- HttpClient
- The Http Client that is used to communicate with Firesearch
- HttpResponse
- The response from Firesearch
- Index
- Index describes a search index.
- IndexService
- IndexService provides the ability to create and manage full-text indexes, as well as populate them with data, and perform searches.
- MetaService
- MetaService provides convenience methods to check or validate indexes. Most people will not need to use this service.
- PutAutocompleteDocRequest
- PutAutocompleteDocRequest is the input object for PutAutocompleteDoc.
- PutAutocompleteDocResponse
- PutAutocompleteDocResponse is the output object for PutAutocompleteDoc.
- PutDocRequest
- PutDocRequest is the input object for PutDoc.
- PutDocResponse
- PutDocResponse is the output object for PutDoc.
- SearchField
- SearchField is a text field that can be searched.
- SearchQuery
- SearchQuery describes a search query.
- SearchRequest
- SearchRequest is the input object for Search.
- SearchResponse
- SearchResponse is the output object for Search.
- SearchResult
- SearchResult is a document that matches a search query.
- ValidationResult
- ValidationResult describes the result of a validation check.
Exceptions / Errors
- BadRequestException
- A bad request was sent to Firesearch. This is an error in the client request that is within the client's purview to fix.
- FetchDataException
- An exception related to fetching data from Firesearch. It is normally network related.
- FiresearchException
- Exceptions related to Firesearch.
- The request was unauthorised.