Package circuit implements the Circuit Breaker pattern for http client.

Creates a new Client, with reasonable defaults.

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.

NewCreateAnalyticsRuleRequest calls the generic CreateAnalyticsRule builder with application/json body.

NewCreateAnalyticsRuleRequestWithBody generates requests for CreateAnalyticsRule with any type of body.

NewCreateCollectionRequest calls the generic CreateCollection builder with application/json body.

NewCreateCollectionRequestWithBody generates requests for CreateCollection with any type of body.

NewCreateKeyRequest calls the generic CreateKey builder with application/json body.

NewCreateKeyRequestWithBody generates requests for CreateKey with any type of body.

NewDebugRequest generates requests for Debug.

NewDeleteAliasRequest generates requests for DeleteAlias.

NewDeleteAnalyticsRuleRequest generates requests for DeleteAnalyticsRule.

NewDeleteCollectionRequest generates requests for DeleteCollection.

NewDeleteDocumentRequest generates requests for DeleteDocument.

NewDeleteDocumentsRequest generates requests for DeleteDocuments.

NewDeleteKeyRequest generates requests for DeleteKey.

NewDeletePresetRequest generates requests for DeletePreset.

NewDeleteSearchOverrideRequest generates requests for DeleteSearchOverride.

NewDeleteSearchSynonymRequest generates requests for DeleteSearchSynonym.

NewDeleteStopwordsSetRequest generates requests for DeleteStopwordsSet.

NewExportDocumentsRequest generates requests for ExportDocuments.

NewGetAliasesRequest generates requests for GetAliases.

NewGetAliasRequest generates requests for GetAlias.

NewGetCollectionRequest generates requests for GetCollection.

NewGetCollectionsRequest generates requests for GetCollections.

NewGetDocumentRequest generates requests for GetDocument.

NewGetKeyRequest generates requests for GetKey.

NewGetKeysRequest generates requests for GetKeys.

NewGetSearchOverrideRequest generates requests for GetSearchOverride.

NewGetSearchOverridesRequest generates requests for GetSearchOverrides.

NewGetSearchSynonymRequest generates requests for GetSearchSynonym.

NewGetSearchSynonymsRequest generates requests for GetSearchSynonyms.

NewHealthRequest generates requests for Health.

NewImportDocumentsRequestWithBody generates requests for ImportDocuments with any type of body.

NewIndexDocumentRequest calls the generic IndexDocument builder with application/json body.

NewIndexDocumentRequestWithBody generates requests for IndexDocument with any type of body.

NewMultiSearchRequest calls the generic MultiSearch builder with application/json body.

NewMultiSearchRequestWithBody generates requests for MultiSearch with any type of body.

NewRetrieveAllPresetsRequest generates requests for RetrieveAllPresets.

NewRetrieveAnalyticsRuleRequest generates requests for RetrieveAnalyticsRule.

NewRetrieveAnalyticsRulesRequest generates requests for RetrieveAnalyticsRules.

NewRetrievePresetRequest generates requests for RetrievePreset.

NewRetrieveStopwordsSetRequest generates requests for RetrieveStopwordsSet.

NewRetrieveStopwordsSetsRequest generates requests for RetrieveStopwordsSets.

NewSearchCollectionRequest generates requests for SearchCollection.

NewTakeSnapshotRequest generates requests for TakeSnapshot.

NewUpdateCollectionRequest calls the generic UpdateCollection builder with application/json body.

NewUpdateCollectionRequestWithBody generates requests for UpdateCollection with any type of body.

NewUpdateDocumentRequest calls the generic UpdateDocument builder with application/json body.

NewUpdateDocumentRequestWithBody generates requests for UpdateDocument with any type of body.

NewUpdateDocumentsRequest calls the generic UpdateDocuments builder with application/json body.

NewUpdateDocumentsRequestWithBody generates requests for UpdateDocuments with any type of body.

NewUpsertAliasRequest calls the generic UpsertAlias builder with application/json body.

NewUpsertAliasRequestWithBody generates requests for UpsertAlias with any type of body.

NewUpsertAnalyticsRuleRequest calls the generic UpsertAnalyticsRule builder with application/json body.

NewUpsertAnalyticsRuleRequestWithBody generates requests for UpsertAnalyticsRule with any type of body.

NewUpsertPresetRequest calls the generic UpsertPreset builder with application/json body.

NewUpsertPresetRequestWithBody generates requests for UpsertPreset with any type of body.

NewUpsertSearchOverrideRequest calls the generic UpsertSearchOverride builder with application/json body.

NewUpsertSearchOverrideRequestWithBody generates requests for UpsertSearchOverride with any type of body.

NewUpsertSearchSynonymRequest calls the generic UpsertSearchSynonym builder with application/json body.

NewUpsertSearchSynonymRequestWithBody generates requests for UpsertSearchSynonym with any type of body.

NewUpsertStopwordsSetRequest calls the generic UpsertStopwordsSet builder with application/json body.

NewUpsertStopwordsSetRequestWithBody generates requests for UpsertStopwordsSet with any type of body.

NewVoteRequest generates requests for Vote.

ParseCreateAnalyticsRuleResponse parses an HTTP response from a CreateAnalyticsRuleWithResponse call.

ParseCreateCollectionResponse parses an HTTP response from a CreateCollectionWithResponse call.

ParseCreateKeyResponse parses an HTTP response from a CreateKeyWithResponse call.

ParseDebugResponse parses an HTTP response from a DebugWithResponse call.

ParseDeleteAliasResponse parses an HTTP response from a DeleteAliasWithResponse call.

ParseDeleteAnalyticsRuleResponse parses an HTTP response from a DeleteAnalyticsRuleWithResponse call.

ParseDeleteCollectionResponse parses an HTTP response from a DeleteCollectionWithResponse call.

ParseDeleteDocumentResponse parses an HTTP response from a DeleteDocumentWithResponse call.

ParseDeleteDocumentsResponse parses an HTTP response from a DeleteDocumentsWithResponse call.

ParseDeleteKeyResponse parses an HTTP response from a DeleteKeyWithResponse call.

ParseDeletePresetResponse parses an HTTP response from a DeletePresetWithResponse call.

ParseDeleteSearchOverrideResponse parses an HTTP response from a DeleteSearchOverrideWithResponse call.

ParseDeleteSearchSynonymResponse parses an HTTP response from a DeleteSearchSynonymWithResponse call.

ParseDeleteStopwordsSetResponse parses an HTTP response from a DeleteStopwordsSetWithResponse call.

ParseExportDocumentsResponse parses an HTTP response from a ExportDocumentsWithResponse call.

ParseGetAliasesResponse parses an HTTP response from a GetAliasesWithResponse call.

ParseGetAliasResponse parses an HTTP response from a GetAliasWithResponse call.

ParseGetCollectionResponse parses an HTTP response from a GetCollectionWithResponse call.

ParseGetCollectionsResponse parses an HTTP response from a GetCollectionsWithResponse call.

ParseGetDocumentResponse parses an HTTP response from a GetDocumentWithResponse call.

ParseGetKeyResponse parses an HTTP response from a GetKeyWithResponse call.

ParseGetKeysResponse parses an HTTP response from a GetKeysWithResponse call.

ParseGetSearchOverrideResponse parses an HTTP response from a GetSearchOverrideWithResponse call.

ParseGetSearchOverridesResponse parses an HTTP response from a GetSearchOverridesWithResponse call.

ParseGetSearchSynonymResponse parses an HTTP response from a GetSearchSynonymWithResponse call.

ParseGetSearchSynonymsResponse parses an HTTP response from a GetSearchSynonymsWithResponse call.

ParseHealthResponse parses an HTTP response from a HealthWithResponse call.

ParseImportDocumentsResponse parses an HTTP response from a ImportDocumentsWithResponse call.

ParseIndexDocumentResponse parses an HTTP response from a IndexDocumentWithResponse call.

ParseMultiSearchResponse parses an HTTP response from a MultiSearchWithResponse call.

ParseRetrieveAllPresetsResponse parses an HTTP response from a RetrieveAllPresetsWithResponse call.

ParseRetrieveAnalyticsRuleResponse parses an HTTP response from a RetrieveAnalyticsRuleWithResponse call.

ParseRetrieveAnalyticsRulesResponse parses an HTTP response from a RetrieveAnalyticsRulesWithResponse call.

ParseRetrievePresetResponse parses an HTTP response from a RetrievePresetWithResponse call.

ParseRetrieveStopwordsSetResponse parses an HTTP response from a RetrieveStopwordsSetWithResponse call.

ParseRetrieveStopwordsSetsResponse parses an HTTP response from a RetrieveStopwordsSetsWithResponse call.

ParseSearchCollectionResponse parses an HTTP response from a SearchCollectionWithResponse call.

ParseTakeSnapshotResponse parses an HTTP response from a TakeSnapshotWithResponse call.

ParseUpdateCollectionResponse parses an HTTP response from a UpdateCollectionWithResponse call.

ParseUpdateDocumentResponse parses an HTTP response from a UpdateDocumentWithResponse call.

ParseUpdateDocumentsResponse parses an HTTP response from a UpdateDocumentsWithResponse call.

ParseUpsertAliasResponse parses an HTTP response from a UpsertAliasWithResponse call.

ParseUpsertAnalyticsRuleResponse parses an HTTP response from a UpsertAnalyticsRuleWithResponse call.

ParseUpsertPresetResponse parses an HTTP response from a UpsertPresetWithResponse call.

ParseUpsertSearchOverrideResponse parses an HTTP response from a UpsertSearchOverrideWithResponse call.

ParseUpsertSearchSynonymResponse parses an HTTP response from a UpsertSearchSynonymWithResponse call.

ParseUpsertStopwordsSetResponse parses an HTTP response from a UpsertStopwordsSetWithResponse call.

ParseVoteResponse parses an HTTP response from a VoteWithResponse call.

WithBaseURL overrides the baseURL.

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

Defines values for ImportDocumentsParamsDirtyValues.

Defines values for ImportDocumentsParamsDirtyValues.

Defines values for SearchOverrideRuleMatch.

Defines values for ImportDocumentsParamsDirtyValues.

Defines values for SearchOverrideRuleMatch.

Defines values for ImportDocumentsParamsDirtyValues.

Defines values for IndexDocumentParamsAction.

AnalyticsRuleParameters defines model for AnalyticsRuleParameters.

AnalyticsRuleSchema defines model for AnalyticsRuleSchema.

AnalyticsRulesRetrieveSchema defines model for AnalyticsRulesRetrieveSchema.

ApiKey defines model for ApiKey.

ApiKeySchema defines model for ApiKeySchema.

ApiKeysResponse defines model for ApiKeysResponse.

ApiResponse defines model for ApiResponse.

Client which conforms to the OpenAPI3 specification for this service.

ClientWithResponses builds on ClientInterface to offer response payloads.

CollectionAlias defines model for CollectionAlias.

CollectionAliasesResponse defines model for CollectionAliasesResponse.

CollectionAliasSchema defines model for CollectionAliasSchema.

CollectionResponse defines model for CollectionResponse.

CollectionSchema defines model for CollectionSchema.

CollectionUpdateSchema defines model for CollectionUpdateSchema.

DeleteDocumentsParams defines parameters for DeleteDocuments.

ExportDocumentsParams defines parameters for ExportDocuments.

FacetCounts defines model for FacetCounts.

Field defines model for Field.

HealthStatus defines model for HealthStatus.

ImportDocumentsParams defines parameters for ImportDocuments.

IndexDocumentParams defines parameters for IndexDocument.

MultiSearchCollectionParameters defines model for MultiSearchCollectionParameters.

MultiSearchParameters Parameters for the multi search API.

MultiSearchParams defines parameters for MultiSearch.

MultiSearchResult defines model for MultiSearchResult.

MultiSearchSearchesParameter defines model for MultiSearchSearchesParameter.

PresetDeleteSchema defines model for PresetDeleteSchema.

PresetSchema defines model for PresetSchema.

PresetSchema_Value defines model for PresetSchema.Value.

PresetsRetrieveSchema defines model for PresetsRetrieveSchema.

PresetUpsertSchema defines model for PresetUpsertSchema.

PresetUpsertSchema_Value defines model for PresetUpsertSchema.Value.

SearchCollectionParams defines parameters for SearchCollection.

SearchGroupedHit defines model for SearchGroupedHit.

SearchHighlight defines model for SearchHighlight.

SearchOverride defines model for SearchOverride.

SearchOverrideExclude defines model for SearchOverrideExclude.

SearchOverrideInclude defines model for SearchOverrideInclude.

SearchOverrideRule defines model for SearchOverrideRule.

SearchOverrideSchema defines model for SearchOverrideSchema.

SearchOverridesResponse defines model for SearchOverridesResponse.

SearchParameters defines model for SearchParameters.

SearchResult defines model for SearchResult.

SearchResultHit defines model for SearchResultHit.

SearchSynonym defines model for SearchSynonym.

SearchSynonymSchema defines model for SearchSynonymSchema.

SearchSynonymsResponse defines model for SearchSynonymsResponse.

StopwordsSetRetrieveSchema defines model for StopwordsSetRetrieveSchema.

StopwordsSetSchema defines model for StopwordsSetSchema.

StopwordsSetUpsertSchema defines model for StopwordsSetUpsertSchema.

SuccessStatus defines model for SuccessStatus.

TakeSnapshotParams defines parameters for TakeSnapshot.

UpdateDocumentsParams defines parameters for UpdateDocuments.

The interface specification for the client above.

ClientWithResponsesInterface is the interface specification for the client with responses above.

Doer performs HTTP requests.

IndexDocumentJSONBody defines parameters for IndexDocument.

UpdateDocumentJSONBody defines parameters for UpdateDocument.

UpdateDocumentsJSONBody defines parameters for UpdateDocuments.

ClientOption allows setting custom parameters during construction.

CreateAnalyticsRuleJSONRequestBody defines body for CreateAnalyticsRule for application/json ContentType.

CreateCollectionJSONRequestBody defines body for CreateCollection for application/json ContentType.

CreateKeyJSONRequestBody defines body for CreateKey for application/json ContentType.

ImportDocumentsParamsDirtyValues defines parameters for ImportDocuments.

IndexDocumentJSONRequestBody defines body for IndexDocument for application/json ContentType.

IndexDocumentParamsAction defines parameters for IndexDocument.

MultiSearchJSONRequestBody defines body for MultiSearch for application/json ContentType.

RequestEditorFn is the function signature for the RequestEditor callback function.

SearchOverrideRuleMatch Indicates whether the match on the query term should be `exact` or `contains`.

UpdateCollectionJSONRequestBody defines body for UpdateCollection for application/json ContentType.

UpdateDocumentJSONRequestBody defines body for UpdateDocument for application/json ContentType.

UpdateDocumentsJSONRequestBody defines body for UpdateDocuments for application/json ContentType.

UpsertAliasJSONRequestBody defines body for UpsertAlias for application/json ContentType.

UpsertAnalyticsRuleJSONRequestBody defines body for UpsertAnalyticsRule for application/json ContentType.

UpsertPresetJSONRequestBody defines body for UpsertPreset for application/json ContentType.

UpsertSearchOverrideJSONRequestBody defines body for UpsertSearchOverride for application/json ContentType.

UpsertSearchSynonymJSONRequestBody defines body for UpsertSearchSynonym for application/json ContentType.

UpsertStopwordsSetJSONRequestBody defines body for UpsertStopwordsSet for application/json ContentType.