mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-16 04:57:11 +00:00
Updated Client to use OpenApi , updated feign dependencies, added Ela… (#10069)
* Updated Client to use OpenApi , updated feign dependencies, added Elasticsearch Api Client * review comments * checkstyle
This commit is contained in:
Mohit Yadav
GitHub
parent
7b6771f1cf
commit
edd260ab66
@ -15,8 +15,11 @@
|
||||
<maven.compiler.source>${java.version}</maven.compiler.source>
|
||||
<maven.compiler.target>${java.version}</maven.compiler.target>
|
||||
<springfox-version>2.7.0</springfox-version>
|
||||
<!-- Upgrading this causes issues -->
|
||||
<feign-version>9.7.0</feign-version>
|
||||
<feign-version>12.1</feign-version>
|
||||
<jackson-databind-nullable-version>0.2.1</jackson-databind-nullable-version>
|
||||
<scribejava-apis-version>8.3.1</scribejava-apis-version>
|
||||
<swagger-parser-version>2.1.10</swagger-parser-version>
|
||||
<jakarta-annotation-version>1.3.5</jakarta-annotation-version>
|
||||
</properties>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
@ -24,47 +27,17 @@
|
||||
<artifactId>openmetadata-spec</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.swagger</groupId>
|
||||
<artifactId>swagger-codegen-maven-plugin</artifactId>
|
||||
<version>3.0.0-rc1</version>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-ext</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.slf4j</groupId>
|
||||
<artifactId>slf4j-ext</artifactId>
|
||||
<version>2.0.6</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.joschi.jackson</groupId>
|
||||
<artifactId>jackson-datatype-threetenbp</artifactId>
|
||||
<!-- Upgrading this causes failure-->
|
||||
<version>2.6.4</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.apache.oltu.oauth2</groupId>
|
||||
<artifactId>org.apache.oltu.oauth2.client</artifactId>
|
||||
<version>1.0.2</version>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>com.fasterxml.jackson.dataformat</groupId>
|
||||
<artifactId>jackson-dataformat-cbor</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
<!-- FEIGN DEPENDENCY-->
|
||||
<!-- Required dependency -->
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign</groupId>
|
||||
<artifactId>feign-core</artifactId>
|
||||
<version>${feign-version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign</groupId>
|
||||
<artifactId>feign-jackson</artifactId>
|
||||
<version>${feign-version}</version>
|
||||
</dependency>
|
||||
<!-- Required dependency -->
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign</groupId>
|
||||
<artifactId>feign-slf4j</artifactId>
|
||||
@ -72,15 +45,36 @@
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign</groupId>
|
||||
<artifactId>feign-core</artifactId>
|
||||
<artifactId>feign-okhttp</artifactId>
|
||||
<version>${feign-version}</version>
|
||||
</dependency>
|
||||
<!-- Required dependency -->
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign.form</groupId>
|
||||
<artifactId>feign-form</artifactId>
|
||||
<version>3.8.0</version>
|
||||
</dependency>
|
||||
<!-- FEIGN DEPENDENCY END -->
|
||||
<dependency>
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>jackson-databind-nullable</artifactId>
|
||||
<version>${jackson-databind-nullable-version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>jakarta.annotation</groupId>
|
||||
<artifactId>jakarta.annotation-api</artifactId>
|
||||
<version>${jakarta-annotation-version}</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.swagger.parser.v3</groupId>
|
||||
<artifactId>swagger-parser</artifactId>
|
||||
<version>${swagger-parser-version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.github.scribejava</groupId>
|
||||
<artifactId>scribejava-apis</artifactId>
|
||||
<version>${scribejava-apis-version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.google.auth</groupId>
|
||||
<artifactId>google-auth-library-oauth2-http</artifactId>
|
||||
@ -91,15 +85,14 @@
|
||||
<artifactId>msal4j</artifactId>
|
||||
<version>1.13.3</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>io.github.openfeign</groupId>
|
||||
<artifactId>feign-okhttp</artifactId>
|
||||
<version>12.1</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.projectlombok</groupId>
|
||||
<artifactId>lombok</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.elasticsearch.client</groupId>
|
||||
<artifactId>elasticsearch-rest-high-level-client</artifactId>
|
||||
</dependency>
|
||||
<!-- TEST -->
|
||||
<dependency>
|
||||
<groupId>junit</groupId>
|
||||
@ -107,14 +100,7 @@
|
||||
<version>4.13.2</version>
|
||||
</dependency>
|
||||
|
||||
<!-- Avoid security issue https://security.snyk.io/vuln/SNYK-JAVA-ORGJSON-2841369 -->
|
||||
<dependency>
|
||||
<groupId>org.json</groupId>
|
||||
<artifactId>json</artifactId>
|
||||
<version>20220924</version>
|
||||
</dependency>
|
||||
|
||||
<!-- avoid security issue https://security.snyk.io/vuln/SNYK-JAVA-ORGMOZILLA-1314295 -->
|
||||
<!--avoid security issue https://security.snyk.io/vuln/SNYK-JAVA-ORGMOZILLA-1314295-->
|
||||
<dependency>
|
||||
<groupId>org.mozilla</groupId>
|
||||
<artifactId>rhino</artifactId>
|
||||
@ -229,16 +215,9 @@
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>io.swagger.codegen.v3</groupId>
|
||||
<artifactId>swagger-codegen-maven-plugin</artifactId>
|
||||
<version>3.0.16</version>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.github.jknack</groupId>
|
||||
<artifactId>handlebars</artifactId>
|
||||
<version>4.3.1</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<groupId>org.openapitools</groupId>
|
||||
<artifactId>openapi-generator-maven-plugin</artifactId>
|
||||
<version>6.0.0</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<goals>
|
||||
@ -246,22 +225,33 @@
|
||||
</goals>
|
||||
<configuration>
|
||||
<inputSpec>${project.basedir}/../../openmetadata-service/target/classes/assets/swagger.yaml</inputSpec>
|
||||
<language>java</language>
|
||||
<generatorName>java</generatorName>
|
||||
<library>feign</library>
|
||||
<generateApiTests>true</generateApiTests>
|
||||
<generateModelTests>true</generateModelTests>
|
||||
<apiPackage>org.openmetadata.client.api</apiPackage>
|
||||
<modelPackage>org.openmetadata.client.model</modelPackage>
|
||||
<configOptions>
|
||||
<generateForOpenFeign>true</generateForOpenFeign>
|
||||
<sourceFolder>src/main/java/</sourceFolder>
|
||||
</configOptions>
|
||||
<output>${project.build.directory}/generated-sources/swagger
|
||||
<output>
|
||||
${project.build.directory}/generated-sources/swagger
|
||||
</output>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<artifactId>maven-assembly-plugin</artifactId>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>package</phase>
|
||||
<goals>
|
||||
<goal>single</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<descriptorRefs>
|
||||
<descriptorRef>jar-with-dependencies</descriptorRef>
|
||||
</descriptorRefs>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
|
||||
@ -0,0 +1,546 @@
|
||||
package org.openmetadata.client.api;
|
||||
|
||||
import feign.Headers;
|
||||
import feign.Param;
|
||||
import feign.QueryMap;
|
||||
import feign.RequestLine;
|
||||
import feign.Response;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import org.openmetadata.client.ApiClient;
|
||||
import org.openmetadata.client.EncodingUtils;
|
||||
|
||||
public interface ElasticSearchApi extends ApiClient.Api {
|
||||
|
||||
/**
|
||||
* Get Aggregated Fields Get Aggregated Fields from Entities.
|
||||
*
|
||||
* @param index (optional, default to table_search_index)
|
||||
* @param field Field in an entity. (optional)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param deleted (optional, default to false)
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine("GET /v1/search/aggregate?index={index}&field={field}&size={size}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getAggregateFields(
|
||||
@Param("index") String index,
|
||||
@Param("field") String field,
|
||||
@Param("size") Integer size,
|
||||
@Param("deleted") String deleted);
|
||||
|
||||
/**
|
||||
* Get Aggregated Fields Similar to <code>getAggregateFields</code> but it also returns the http response headers .
|
||||
* Get Aggregated Fields from Entities.
|
||||
*
|
||||
* @param index (optional, default to table_search_index)
|
||||
* @param field Field in an entity. (optional)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param deleted (optional, default to false)
|
||||
* @return A ApiResponse that wraps the response boyd and the http headers.
|
||||
*/
|
||||
@RequestLine("GET /v1/search/aggregate?index={index}&field={field}&size={size}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getAggregateFieldsWithHttpInfo(
|
||||
@Param("index") String index,
|
||||
@Param("field") String field,
|
||||
@Param("size") Integer size,
|
||||
@Param("deleted") String deleted);
|
||||
|
||||
/**
|
||||
* Get Aggregated Fields Get Aggregated Fields from Entities. Note, this is equivalent to the other <code>
|
||||
* getAggregateFields</code> 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
|
||||
* GetAggregateFieldsQueryParams} class that allows for building up this map in a fluent style.
|
||||
*
|
||||
* @param queryParams Map of query parameters as name-value pairs
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>index - (optional, default to table_search_index)
|
||||
* <li>field - Field in an entity. (optional)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>deleted - (optional, default to false)
|
||||
* </ul>
|
||||
*
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine("GET /v1/search/aggregate?index={index}&field={field}&size={size}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getAggregateFields(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* Get Aggregated Fields Get Aggregated Fields from Entities. Note, this is equivalent to the other <code>
|
||||
* getAggregateFields</code> 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
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>index - (optional, default to table_search_index)
|
||||
* <li>field - Field in an entity. (optional)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>deleted - (optional, default to false)
|
||||
* </ul>
|
||||
*
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine("GET /v1/search/aggregate?index={index}&field={field}&size={size}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getAggregateFieldsWithHttpInfo(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* A convenience class for generating query parameters for the <code>getAggregateFields</code> method in a fluent
|
||||
* style.
|
||||
*/
|
||||
class GetAggregateFieldsQueryParams extends HashMap<String, Object> {
|
||||
public GetAggregateFieldsQueryParams index(final String value) {
|
||||
put("index", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetAggregateFieldsQueryParams field(final String value) {
|
||||
put("field", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetAggregateFieldsQueryParams size(final Integer value) {
|
||||
put("size", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetAggregateFieldsQueryParams deleted(final String value) {
|
||||
put("deleted", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Suggest Entities Get suggested entities used for auto-completion.
|
||||
*
|
||||
* @param q Suggest API can be used to auto-fill the entities name while use is typing search text <br>
|
||||
* 1. To get suggest results pass q=us or q=user etc.. <br>
|
||||
* 2. Do not add any wild-cards such as * like in search api <br>
|
||||
* 3. suggest api is a prefix suggestion <br>
|
||||
* (required)
|
||||
* @param index (optional, default to table_search_index)
|
||||
* @param field Field in object containing valid suggestions. Defaults to `suggest`. All indices has a `suggest`
|
||||
* field, only some indices have other `suggest_*` fields. (optional, default to suggest)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param fetchSource Get document body for each hit (optional, default to true)
|
||||
* @param includeSourceFields Get only selected fields of the document body for each hit. Empty value will return all
|
||||
* fields (optional)
|
||||
* @param deleted (optional, default to false)
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/suggest?q={q}&index={index}&field={field}&size={size}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getSuggestedEntities(
|
||||
@Param("q") String q,
|
||||
@Param("index") String index,
|
||||
@Param("field") String field,
|
||||
@Param("size") Integer size,
|
||||
@Param("fetchSource") Boolean fetchSource,
|
||||
@Param("includeSourceFields") List<String> includeSourceFields,
|
||||
@Param("deleted") String deleted);
|
||||
|
||||
/**
|
||||
* Suggest Entities Similar to <code>getSuggestedEntities</code> but it also returns the http response headers . Get
|
||||
* suggested entities used for auto-completion.
|
||||
*
|
||||
* @param q Suggest API can be used to auto-fill the entities name while use is typing search text <br>
|
||||
* 1. To get suggest results pass q=us or q=user etc.. <br>
|
||||
* 2. Do not add any wild-cards such as * like in search api <br>
|
||||
* 3. suggest api is a prefix suggestion <br>
|
||||
* (required)
|
||||
* @param index (optional, default to table_search_index)
|
||||
* @param field Field in object containing valid suggestions. Defaults to `suggest`. All indices has a `suggest`
|
||||
* field, only some indices have other `suggest_*` fields. (optional, default to suggest)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param fetchSource Get document body for each hit (optional, default to true)
|
||||
* @param includeSourceFields Get only selected fields of the document body for each hit. Empty value will return all
|
||||
* fields (optional)
|
||||
* @param deleted (optional, default to false)
|
||||
* @return A ApiResponse that wraps the response boyd and the http headers.
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/suggest?q={q}&index={index}&field={field}&size={size}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getSuggestedEntitiesWithHttpInfo(
|
||||
@Param("q") String q,
|
||||
@Param("index") String index,
|
||||
@Param("field") String field,
|
||||
@Param("size") Integer size,
|
||||
@Param("fetchSource") Boolean fetchSource,
|
||||
@Param("includeSourceFields") List<String> includeSourceFields,
|
||||
@Param("deleted") String deleted);
|
||||
|
||||
/**
|
||||
* Suggest Entities Get suggested entities used for auto-completion. Note, this is equivalent to the other <code>
|
||||
* getSuggestedEntities</code> 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
|
||||
* GetSuggestedEntitiesQueryParams} class that allows for building up this map in a fluent style.
|
||||
*
|
||||
* @param queryParams Map of query parameters as name-value pairs
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>q - Suggest API can be used to auto-fill the entities name while use is typing search text <br>
|
||||
* 1. To get suggest results pass q=us or q=user etc.. <br>
|
||||
* 2. Do not add any wild-cards such as * like in search api <br>
|
||||
* 3. suggest api is a prefix suggestion <br>
|
||||
* (required)
|
||||
* <li>index - (optional, default to table_search_index)
|
||||
* <li>field - Field in object containing valid suggestions. Defaults to `suggest`. All indices has a `suggest`
|
||||
* field, only some indices have other `suggest_*` fields. (optional, default to suggest)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>fetchSource - Get document body for each hit (optional, default to true)
|
||||
* <li>includeSourceFields - Get only selected fields of the document body for each hit. Empty value will return
|
||||
* all fields (optional)
|
||||
* <li>deleted - (optional, default to false)
|
||||
* </ul>
|
||||
*
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/suggest?q={q}&index={index}&field={field}&size={size}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getSuggestedEntities(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* Suggest Entities Get suggested entities used for auto-completion. Note, this is equivalent to the other <code>
|
||||
* getSuggestedEntities</code> 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
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>q - Suggest API can be used to auto-fill the entities name while use is typing search text <br>
|
||||
* 1. To get suggest results pass q=us or q=user etc.. <br>
|
||||
* 2. Do not add any wild-cards such as * like in search api <br>
|
||||
* 3. suggest api is a prefix suggestion <br>
|
||||
* (required)
|
||||
* <li>index - (optional, default to table_search_index)
|
||||
* <li>field - Field in object containing valid suggestions. Defaults to `suggest`. All indices has a `suggest`
|
||||
* field, only some indices have other `suggest_*` fields. (optional, default to suggest)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>fetchSource - Get document body for each hit (optional, default to true)
|
||||
* <li>includeSourceFields - Get only selected fields of the document body for each hit. Empty value will return
|
||||
* all fields (optional)
|
||||
* <li>deleted - (optional, default to false)
|
||||
* </ul>
|
||||
*
|
||||
* @return Suggest
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/suggest?q={q}&index={index}&field={field}&size={size}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}&deleted={deleted}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response getSuggestedEntitiesWithHttpInfo(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* A convenience class for generating query parameters for the <code>getSuggestedEntities</code> method in a fluent
|
||||
* style.
|
||||
*/
|
||||
class GetSuggestedEntitiesQueryParams extends HashMap<String, Object> {
|
||||
public GetSuggestedEntitiesQueryParams q(final String value) {
|
||||
put("q", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams index(final String value) {
|
||||
put("index", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams field(final String value) {
|
||||
put("field", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams size(final Integer value) {
|
||||
put("size", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams fetchSource(final Boolean value) {
|
||||
put("fetch_source", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams includeSourceFields(final List<String> value) {
|
||||
put("include_source_fields", EncodingUtils.encodeCollection(value, "multi"));
|
||||
return this;
|
||||
}
|
||||
|
||||
public GetSuggestedEntitiesQueryParams deleted(final String value) {
|
||||
put("deleted", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search entities Search entities using query test. Use query params `from` and `size` for pagination. Use
|
||||
* `sort_field` to sort the results in `sort_order`.
|
||||
*
|
||||
* @param q Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br>
|
||||
* 1. For listing all tables or topics pass q=* <br>
|
||||
* 2. For search tables or topics pass q=*search_term* <br>
|
||||
* 3. For searching field names such as search by column_name pass q=column_names:address <br>
|
||||
* 4. For searching by tag names pass q=tags:user.email <br>
|
||||
* 5. When user selects a filter pass q=query_text AND tags:user.email AND platform:MYSQL <br>
|
||||
* 6. Search with multiple values of same filter q=tags:user.email AND tags:user.address <br>
|
||||
* logic operators such as AND and OR must be in uppercase (required)
|
||||
* @param index ElasticSearch Index name, defaults to table_search_index (optional, default to table_search_index)
|
||||
* @param deleted Filter documents by deleted param. By default deleted is false (optional, default to false)
|
||||
* @param from From field to paginate the results, defaults to 0 (optional, default to 0)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param sortField Sort the search results by field, available fields to sort weekly_stats , daily_stats,
|
||||
* monthly_stats, last_updated_timestamp (optional, default to _score)
|
||||
* @param sortOrder Sort order asc for ascending or desc for descending, defaults to desc (optional, default to desc)
|
||||
* @param trackTotalHits Track Total Hits (optional, default to false)
|
||||
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query`
|
||||
* argument (optional)
|
||||
* @param postFilter Elasticsearch query that will be used as a post_filter (optional)
|
||||
* @param fetchSource Get document body for each hit (optional, default to true)
|
||||
* @param includeSourceFields Get only selected fields of the document body for each hit. Empty value will return all
|
||||
* fields (optional)
|
||||
* @return SearchResponse
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/query?q={q}&index={index}&deleted={deleted}&from={from}&size={size}&sort_field={sortField}&sort_order={sortOrder}&track_total_hits={trackTotalHits}&query_filter={queryFilter}&post_filter={postFilter}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response searchEntitiesWithQuery(
|
||||
@Param("q") String q,
|
||||
@Param("index") String index,
|
||||
@Param("deleted") Boolean deleted,
|
||||
@Param("from") Integer from,
|
||||
@Param("size") Integer size,
|
||||
@Param("sortField") String sortField,
|
||||
@Param("sortOrder") String sortOrder,
|
||||
@Param("trackTotalHits") Boolean trackTotalHits,
|
||||
@Param("queryFilter") String queryFilter,
|
||||
@Param("postFilter") String postFilter,
|
||||
@Param("fetchSource") Boolean fetchSource,
|
||||
@Param("includeSourceFields") List<String> includeSourceFields);
|
||||
|
||||
/**
|
||||
* Search entities Similar to <code>searchEntitiesWithQuery</code> but it also returns the http response headers .
|
||||
* Search entities using query test. Use query params `from` and `size` for pagination. Use `sort_field` to sort the
|
||||
* results in `sort_order`.
|
||||
*
|
||||
* @param q Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br>
|
||||
* 1. For listing all tables or topics pass q=* <br>
|
||||
* 2. For search tables or topics pass q=*search_term* <br>
|
||||
* 3. For searching field names such as search by column_name pass q=column_names:address <br>
|
||||
* 4. For searching by tag names pass q=tags:user.email <br>
|
||||
* 5. When user selects a filter pass q=query_text AND tags:user.email AND platform:MYSQL <br>
|
||||
* 6. Search with multiple values of same filter q=tags:user.email AND tags:user.address <br>
|
||||
* logic operators such as AND and OR must be in uppercase (required)
|
||||
* @param index ElasticSearch Index name, defaults to table_search_index (optional, default to table_search_index)
|
||||
* @param deleted Filter documents by deleted param. By default deleted is false (optional, default to false)
|
||||
* @param from From field to paginate the results, defaults to 0 (optional, default to 0)
|
||||
* @param size Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* @param sortField Sort the search results by field, available fields to sort weekly_stats , daily_stats,
|
||||
* monthly_stats, last_updated_timestamp (optional, default to _score)
|
||||
* @param sortOrder Sort order asc for ascending or desc for descending, defaults to desc (optional, default to desc)
|
||||
* @param trackTotalHits Track Total Hits (optional, default to false)
|
||||
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query`
|
||||
* argument (optional)
|
||||
* @param postFilter Elasticsearch query that will be used as a post_filter (optional)
|
||||
* @param fetchSource Get document body for each hit (optional, default to true)
|
||||
* @param includeSourceFields Get only selected fields of the document body for each hit. Empty value will return all
|
||||
* fields (optional)
|
||||
* @return A ApiResponse that wraps the response boyd and the http headers.
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/query?q={q}&index={index}&deleted={deleted}&from={from}&size={size}&sort_field={sortField}&sort_order={sortOrder}&track_total_hits={trackTotalHits}&query_filter={queryFilter}&post_filter={postFilter}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response searchEntitiesWithQueryWithHttpInfo(
|
||||
@Param("q") String q,
|
||||
@Param("index") String index,
|
||||
@Param("deleted") Boolean deleted,
|
||||
@Param("from") Integer from,
|
||||
@Param("size") Integer size,
|
||||
@Param("sortField") String sortField,
|
||||
@Param("sortOrder") String sortOrder,
|
||||
@Param("trackTotalHits") Boolean trackTotalHits,
|
||||
@Param("queryFilter") String queryFilter,
|
||||
@Param("postFilter") String postFilter,
|
||||
@Param("fetchSource") Boolean fetchSource,
|
||||
@Param("includeSourceFields") List<String> includeSourceFields);
|
||||
|
||||
/**
|
||||
* Search entities Search entities using query test. Use query params `from` and `size` for pagination. Use
|
||||
* `sort_field` to sort the results in `sort_order`. Note, this is equivalent to the other <code>
|
||||
* searchEntitiesWithQuery</code> 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
|
||||
* SearchEntitiesWithQueryQueryParams} class that allows for building up this map in a fluent style.
|
||||
*
|
||||
* @param queryParams Map of query parameters as name-value pairs
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>q - Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br>
|
||||
* 1. For listing all tables or topics pass q=* <br>
|
||||
* 2. For search tables or topics pass q=*search_term* <br>
|
||||
* 3. For searching field names such as search by column_name pass q=column_names:address <br>
|
||||
* 4. For searching by tag names pass q=tags:user.email <br>
|
||||
* 5. When user selects a filter pass q=query_text AND tags:user.email AND platform:MYSQL <br>
|
||||
* 6. Search with multiple values of same filter q=tags:user.email AND tags:user.address <br>
|
||||
* logic operators such as AND and OR must be in uppercase (required)
|
||||
* <li>index - ElasticSearch Index name, defaults to table_search_index (optional, default to
|
||||
* table_search_index)
|
||||
* <li>deleted - Filter documents by deleted param. By default deleted is false (optional, default to false)
|
||||
* <li>from - From field to paginate the results, defaults to 0 (optional, default to 0)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>sortField - Sort the search results by field, available fields to sort weekly_stats , daily_stats,
|
||||
* monthly_stats, last_updated_timestamp (optional, default to _score)
|
||||
* <li>sortOrder - Sort order asc for ascending or desc for descending, defaults to desc (optional, default to
|
||||
* desc)
|
||||
* <li>trackTotalHits - Track Total Hits (optional, default to false)
|
||||
* <li>queryFilter - Elasticsearch query that will be combined with the query_string query generator from the
|
||||
* `query` argument (optional)
|
||||
* <li>postFilter - Elasticsearch query that will be used as a post_filter (optional)
|
||||
* <li>fetchSource - Get document body for each hit (optional, default to true)
|
||||
* <li>includeSourceFields - Get only selected fields of the document body for each hit. Empty value will return
|
||||
* all fields (optional)
|
||||
* </ul>
|
||||
*
|
||||
* @return SearchResponse
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/query?q={q}&index={index}&deleted={deleted}&from={from}&size={size}&sort_field={sortField}&sort_order={sortOrder}&track_total_hits={trackTotalHits}&query_filter={queryFilter}&post_filter={postFilter}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response searchEntitiesWithQuery(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* Search entities Search entities using query test. Use query params `from` and `size` for pagination. Use
|
||||
* `sort_field` to sort the results in `sort_order`. Note, this is equivalent to the other <code>
|
||||
* searchEntitiesWithQuery</code> 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
|
||||
* <p>The following elements may be specified in the query map:
|
||||
* <ul>
|
||||
* <li>q - Search Query Text, Pass *text* for substring match; Pass without wildcards for exact match. <br>
|
||||
* 1. For listing all tables or topics pass q=* <br>
|
||||
* 2. For search tables or topics pass q=*search_term* <br>
|
||||
* 3. For searching field names such as search by column_name pass q=column_names:address <br>
|
||||
* 4. For searching by tag names pass q=tags:user.email <br>
|
||||
* 5. When user selects a filter pass q=query_text AND tags:user.email AND platform:MYSQL <br>
|
||||
* 6. Search with multiple values of same filter q=tags:user.email AND tags:user.address <br>
|
||||
* logic operators such as AND and OR must be in uppercase (required)
|
||||
* <li>index - ElasticSearch Index name, defaults to table_search_index (optional, default to
|
||||
* table_search_index)
|
||||
* <li>deleted - Filter documents by deleted param. By default deleted is false (optional, default to false)
|
||||
* <li>from - From field to paginate the results, defaults to 0 (optional, default to 0)
|
||||
* <li>size - Size field to limit the no.of results returned, defaults to 10 (optional, default to 10)
|
||||
* <li>sortField - Sort the search results by field, available fields to sort weekly_stats , daily_stats,
|
||||
* monthly_stats, last_updated_timestamp (optional, default to _score)
|
||||
* <li>sortOrder - Sort order asc for ascending or desc for descending, defaults to desc (optional, default to
|
||||
* desc)
|
||||
* <li>trackTotalHits - Track Total Hits (optional, default to false)
|
||||
* <li>queryFilter - Elasticsearch query that will be combined with the query_string query generator from the
|
||||
* `query` argument (optional)
|
||||
* <li>postFilter - Elasticsearch query that will be used as a post_filter (optional)
|
||||
* <li>fetchSource - Get document body for each hit (optional, default to true)
|
||||
* <li>includeSourceFields - Get only selected fields of the document body for each hit. Empty value will return
|
||||
* all fields (optional)
|
||||
* </ul>
|
||||
*
|
||||
* @return SearchResponse
|
||||
*/
|
||||
@RequestLine(
|
||||
"GET /v1/search/query?q={q}&index={index}&deleted={deleted}&from={from}&size={size}&sort_field={sortField}&sort_order={sortOrder}&track_total_hits={trackTotalHits}&query_filter={queryFilter}&post_filter={postFilter}&fetch_source={fetchSource}&include_source_fields={includeSourceFields}")
|
||||
@Headers({
|
||||
"Accept: application/json",
|
||||
})
|
||||
Response searchEntitiesWithQueryWithHttpInfo(@QueryMap(encoded = true) Map<String, Object> queryParams);
|
||||
|
||||
/**
|
||||
* A convenience class for generating query parameters for the <code>searchEntitiesWithQuery</code> method in a fluent
|
||||
* style.
|
||||
*/
|
||||
class SearchEntitiesWithQueryQueryParams extends HashMap<String, Object> {
|
||||
public SearchEntitiesWithQueryQueryParams q(final String value) {
|
||||
put("q", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams index(final String value) {
|
||||
put("index", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams deleted(final Boolean value) {
|
||||
put("deleted", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams from(final Integer value) {
|
||||
put("from", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams size(final Integer value) {
|
||||
put("size", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams sortField(final String value) {
|
||||
put("sort_field", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams sortOrder(final String value) {
|
||||
put("sort_order", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams trackTotalHits(final Boolean value) {
|
||||
put("track_total_hits", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams queryFilter(final String value) {
|
||||
put("query_filter", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams postFilter(final String value) {
|
||||
put("post_filter", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams fetchSource(final Boolean value) {
|
||||
put("fetch_source", EncodingUtils.encode(value));
|
||||
return this;
|
||||
}
|
||||
|
||||
public SearchEntitiesWithQueryQueryParams includeSourceFields(final List<String> value) {
|
||||
put("include_source_fields", EncodingUtils.encodeCollection(value, "multi"));
|
||||
return this;
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user