org.openmetadata.client.api.SearchIndexApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.ChangeEvent;
import org.openmetadata.client.model.CreateSearchIndex;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.SearchIndex;
import org.openmetadata.client.model.SearchIndexList;
import org.openmetadata.client.model.SearchIndexSampleData;
import java.util.UUID;
import org.openmetadata.client.model.VoteRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-25T06:10:38.496414726Z[Etc/UTC]")
public interface SearchIndexApi extends ApiClient.Api {
/**
* Add a follower
* Add a user identified by `userId` as followed of this SearchIndex
* @param id Id of the SearchIndex (required)
* @param body Id of the user to be added as follower (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/searchIndexes/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent addFollower5(@Param("id") UUID id, UUID body);
/**
* Add a follower
* Similar to addFollower5 but it also returns the http response headers .
* Add a user identified by `userId` as followed of this SearchIndex
* @param id Id of the SearchIndex (required)
* @param body Id of the user to be added as follower (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/searchIndexes/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addFollower5WithHttpInfo(@Param("id") UUID id, UUID body);
/**
* Add sample data
* Add sample data to the searchIndex.
* @param id Id of the SearchIndex (required)
* @param searchIndexSampleData (optional)
* @return SearchIndex
*/
@RequestLine("PUT /v1/searchIndexes/{id}/sampleData")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
SearchIndex addSampleData1(@Param("id") UUID id, SearchIndexSampleData searchIndexSampleData);
/**
* Add sample data
* Similar to addSampleData1 but it also returns the http response headers .
* Add sample data to the searchIndex.
* @param id Id of the SearchIndex (required)
* @param searchIndexSampleData (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/searchIndexes/{id}/sampleData")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addSampleData1WithHttpInfo(@Param("id") UUID id, SearchIndexSampleData searchIndexSampleData);
/**
* Update SearchIndex
* Create a SearchIndex, it it does not exist or update an existing SearchIndex.
* @param createSearchIndex (optional)
* @return SearchIndex
*/
@RequestLine("PUT /v1/searchIndexes")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
SearchIndex createOrUpdateSearchIndex(CreateSearchIndex createSearchIndex);
/**
* Update SearchIndex
* Similar to createOrUpdateSearchIndex but it also returns the http response headers .
* Create a SearchIndex, it it does not exist or update an existing SearchIndex.
* @param createSearchIndex (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/searchIndexes")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateSearchIndexWithHttpInfo(CreateSearchIndex createSearchIndex);
/**
* Create a SearchIndex
* Create a SearchIndex under an existing `service`.
* @param createSearchIndex (optional)
* @return SearchIndex
*/
@RequestLine("POST /v1/searchIndexes")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
SearchIndex createSearchIndex(CreateSearchIndex createSearchIndex);
/**
* Create a SearchIndex
* Similar to createSearchIndex but it also returns the http response headers .
* Create a SearchIndex under an existing `service`.
* @param createSearchIndex (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/searchIndexes")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createSearchIndexWithHttpInfo(CreateSearchIndex createSearchIndex);
/**
* Remove a follower
* Remove the user identified `userId` as a follower of the SearchIndex.
* @param id Id of the SearchIndex (required)
* @param userId Id of the user being removed as follower (required)
* @return ChangeEvent
*/
@RequestLine("DELETE /v1/searchIndexes/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
ChangeEvent deleteFollower6(@Param("id") UUID id, @Param("userId") String userId);
/**
* Remove a follower
* Similar to deleteFollower6 but it also returns the http response headers .
* Remove the user identified `userId` as a follower of the SearchIndex.
* @param id Id of the SearchIndex (required)
* @param userId Id of the user being removed as follower (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/searchIndexes/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteFollower6WithHttpInfo(@Param("id") UUID id, @Param("userId") String userId);
/**
* Delete a SearchIndex by id
* Delete a SearchIndex by `id`.
* @param id Id of the SearchIndex (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/searchIndexes/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteSearchIndex(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a SearchIndex by id
* Similar to deleteSearchIndex but it also returns the http response headers .
* Delete a SearchIndex by `id`.
* @param id Id of the SearchIndex (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/searchIndexes/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteSearchIndexWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a SearchIndex by id
* Delete a SearchIndex by `id`.
* Note, this is equivalent to the other deleteSearchIndex method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteSearchIndexQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/searchIndexes/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteSearchIndex(@Param("id") UUID id, @QueryMap(encoded=true) DeleteSearchIndexQueryParams queryParams);
/**
* Delete a SearchIndex by id
* Delete a SearchIndex by `id`.
* Note, this is equivalent to the other deleteSearchIndex that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/searchIndexes/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteSearchIndexWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteSearchIndexQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteSearchIndex method in a fluent style.
*/
public static class DeleteSearchIndexQueryParams extends HashMap {
public DeleteSearchIndexQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteSearchIndexQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a SearchIndex by fully qualified name
* Delete a SearchIndex by `fullyQualifiedName`.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/searchIndexes/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteSearchIndexByFQN(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a SearchIndex by fully qualified name
* Similar to deleteSearchIndexByFQN but it also returns the http response headers .
* Delete a SearchIndex by `fullyQualifiedName`.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/searchIndexes/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteSearchIndexByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a SearchIndex by fully qualified name
* Delete a SearchIndex by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteSearchIndexByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link DeleteSearchIndexByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/searchIndexes/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteSearchIndexByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteSearchIndexByFQNQueryParams queryParams);
/**
* Delete a SearchIndex by fully qualified name
* Delete a SearchIndex by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteSearchIndexByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/searchIndexes/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteSearchIndexByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteSearchIndexByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteSearchIndexByFQN method in a fluent style.
*/
public static class DeleteSearchIndexByFQNQueryParams extends HashMap {
public DeleteSearchIndexByFQNQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteSearchIndexByFQNQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a SearchIndex by id
* Get a SearchIndex by `id`.
* @param id Id of the SearchIndex (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndex get6(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a SearchIndex by id
* Similar to get6 but it also returns the http response headers .
* Get a SearchIndex by `id`.
* @param id Id of the SearchIndex (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get6WithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a SearchIndex by id
* Get a SearchIndex by `id`.
* Note, this is equivalent to the other get6 method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link Get6QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndex get6(@Param("id") UUID id, @QueryMap(encoded=true) Get6QueryParams queryParams);
/**
* Get a SearchIndex by id
* Get a SearchIndex by `id`.
* Note, this is equivalent to the other get6 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get6WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Get6QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get6 method in a fluent style.
*/
public static class Get6QueryParams extends HashMap {
public Get6QueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public Get6QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get sample data
* Get sample data from the SearchIndex.
* @param id Id of the SearchIndex (required)
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/{id}/sampleData")
@Headers({
"Accept: application/json",
})
SearchIndex getSampleData1(@Param("id") UUID id);
/**
* Get sample data
* Similar to getSampleData1 but it also returns the http response headers .
* Get sample data from the SearchIndex.
* @param id Id of the SearchIndex (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes/{id}/sampleData")
@Headers({
"Accept: application/json",
})
ApiResponse getSampleData1WithHttpInfo(@Param("id") UUID id);
/**
* Get a SearchIndex by fully qualified name
* Get a SearchIndex by fully qualified name.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndex getSearchIndexByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a SearchIndex by fully qualified name
* Similar to getSearchIndexByFQN but it also returns the http response headers .
* Get a SearchIndex by fully qualified name.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getSearchIndexByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a SearchIndex by fully qualified name
* Get a SearchIndex by fully qualified name.
* Note, this is equivalent to the other getSearchIndexByFQN method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetSearchIndexByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndex getSearchIndexByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetSearchIndexByFQNQueryParams queryParams);
/**
* Get a SearchIndex by fully qualified name
* Get a SearchIndex by fully qualified name.
* Note, this is equivalent to the other getSearchIndexByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the SearchIndex (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getSearchIndexByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetSearchIndexByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getSearchIndexByFQN method in a fluent style.
*/
public static class GetSearchIndexByFQNQueryParams extends HashMap {
public GetSearchIndexByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetSearchIndexByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the SearchIndex
* Get a version of the SearchIndex by given `id`
* @param id Id of the SearchIndex (required)
* @param version SearchIndex version number in the form `major`.`minor` (required)
* @return SearchIndex
*/
@RequestLine("GET /v1/searchIndexes/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
SearchIndex getSpecificSearchIndexVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the SearchIndex
* Similar to getSpecificSearchIndexVersion but it also returns the http response headers .
* Get a version of the SearchIndex by given `id`
* @param id Id of the SearchIndex (required)
* @param version SearchIndex version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificSearchIndexVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* List SearchIndex versions
* Get a list of all the versions of a SearchIndex identified by `id`
* @param id Id of the SearchIndex (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/searchIndexes/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllSearchIndexVersion(@Param("id") UUID id);
/**
* List SearchIndex versions
* Similar to listAllSearchIndexVersion but it also returns the http response headers .
* Get a list of all the versions of a SearchIndex identified by `id`
* @param id Id of the SearchIndex (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllSearchIndexVersionWithHttpInfo(@Param("id") UUID id);
/**
* List searchIndexes
* Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param service Filter SearchIndexes by service name (optional)
* @param limit Limit the number SearchIndexes returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of SearchIndexes before this cursor (optional)
* @param after Returns list of SearchIndexes after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return SearchIndexList
*/
@RequestLine("GET /v1/searchIndexes?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndexList listSearchIndexes(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List searchIndexes
* Similar to listSearchIndexes but it also returns the http response headers .
* Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param service Filter SearchIndexes by service name (optional)
* @param limit Limit the number SearchIndexes returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of SearchIndexes before this cursor (optional)
* @param after Returns list of SearchIndexes after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/searchIndexes?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listSearchIndexesWithHttpInfo(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List searchIndexes
* Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listSearchIndexes method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListSearchIndexesQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - service - Filter SearchIndexes by service name (optional)
* - limit - Limit the number SearchIndexes returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of SearchIndexes before this cursor (optional)
* - after - Returns list of SearchIndexes after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndexList
*/
@RequestLine("GET /v1/searchIndexes?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
SearchIndexList listSearchIndexes(@QueryMap(encoded=true) ListSearchIndexesQueryParams queryParams);
/**
* List searchIndexes
* Get a list of SearchIndexes, optionally filtered by `service` it belongs to. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listSearchIndexes that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - service - Filter SearchIndexes by service name (optional)
* - limit - Limit the number SearchIndexes returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of SearchIndexes before this cursor (optional)
* - after - Returns list of SearchIndexes after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return SearchIndexList
*/
@RequestLine("GET /v1/searchIndexes?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listSearchIndexesWithHttpInfo(@QueryMap(encoded=true) ListSearchIndexesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listSearchIndexes method in a fluent style.
*/
public static class ListSearchIndexesQueryParams extends HashMap {
public ListSearchIndexesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListSearchIndexesQueryParams service(final String value) {
put("service", EncodingUtils.encode(value));
return this;
}
public ListSearchIndexesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListSearchIndexesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListSearchIndexesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListSearchIndexesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a SearchIndex using name.
* Update an existing SearchIndex using JsonPatch.
* @param fqn Name of the SearchIndex (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a SearchIndex using name. Documentation
*/
@RequestLine("PATCH /v1/searchIndexes/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchSearchIndex(@Param("fqn") String fqn, Object body);
/**
* Update a SearchIndex using name.
* Similar to patchSearchIndex but it also returns the http response headers .
* Update an existing SearchIndex using JsonPatch.
* @param fqn Name of the SearchIndex (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a SearchIndex using name. Documentation
*/
@RequestLine("PATCH /v1/searchIndexes/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchSearchIndexWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a SearchIndex
* Update an existing SearchIndex using JsonPatch.
* @param id Id of the SearchIndex (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a SearchIndex Documentation
*/
@RequestLine("PATCH /v1/searchIndexes/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchSearchIndex1(@Param("id") UUID id, Object body);
/**
* Update a SearchIndex
* Similar to patchSearchIndex1 but it also returns the http response headers .
* Update an existing SearchIndex using JsonPatch.
* @param id Id of the SearchIndex (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a SearchIndex Documentation
*/
@RequestLine("PATCH /v1/searchIndexes/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchSearchIndex1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted SearchIndex
* Restore a soft deleted SearchIndex.
* @param restoreEntity (optional)
* @return SearchIndex
*/
@RequestLine("PUT /v1/searchIndexes/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
SearchIndex restore21(RestoreEntity restoreEntity);
/**
* Restore a soft deleted SearchIndex
* Similar to restore21 but it also returns the http response headers .
* Restore a soft deleted SearchIndex.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/searchIndexes/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore21WithHttpInfo(RestoreEntity restoreEntity);
/**
* Update Vote for a Entity
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/searchIndexes/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent updateVoteForEntity14(@Param("id") UUID id, VoteRequest voteRequest);
/**
* Update Vote for a Entity
* Similar to updateVoteForEntity14 but it also returns the http response headers .
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/searchIndexes/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateVoteForEntity14WithHttpInfo(@Param("id") UUID id, VoteRequest voteRequest);
}