org.openmetadata.client.api.LineageApi 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.AddLineage;
import org.openmetadata.client.model.EntityLineage;
import org.openmetadata.client.model.SearchResponse;
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 LineageApi extends ApiClient.Api {
/**
* Add a lineage edge
* Add a lineage edge with from entity as upstream node and to entity as downstream node.
* @param addLineage (optional)
*/
@RequestLine("PUT /v1/lineage")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void addLineageEdge(AddLineage addLineage);
/**
* Add a lineage edge
* Similar to addLineageEdge but it also returns the http response headers .
* Add a lineage edge with from entity as upstream node and to entity as downstream node.
* @param addLineage (optional)
*/
@RequestLine("PUT /v1/lineage")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addLineageEdgeWithHttpInfo(AddLineage addLineage);
/**
* Delete a lineage edge
* Delete a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromId Entity id (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toId Entity id (required)
*/
@RequestLine("DELETE /v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Headers({
"Accept: application/json",
})
void deleteLineageEdge(@Param("fromEntity") String fromEntity, @Param("fromId") String fromId, @Param("toEntity") String toEntity, @Param("toId") String toId);
/**
* Delete a lineage edge
* Similar to deleteLineageEdge but it also returns the http response headers .
* Delete a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromId Entity id (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toId Entity id (required)
*/
@RequestLine("DELETE /v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLineageEdgeWithHttpInfo(@Param("fromEntity") String fromEntity, @Param("fromId") String fromId, @Param("toEntity") String toEntity, @Param("toId") String toId);
/**
* Delete a lineage edge by FQNs
* Delete a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromFQN Entity FQN (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toFQN Entity FQN (required)
*/
@RequestLine("DELETE /v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}")
@Headers({
"Accept: application/json",
})
void deleteLineageEdgeByName(@Param("fromEntity") String fromEntity, @Param("fromFQN") String fromFQN, @Param("toEntity") String toEntity, @Param("toFQN") String toFQN);
/**
* Delete a lineage edge by FQNs
* Similar to deleteLineageEdgeByName but it also returns the http response headers .
* Delete a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromFQN Entity FQN (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toFQN Entity FQN (required)
*/
@RequestLine("DELETE /v1/lineage/{fromEntity}/name/{fromFQN}/{toEntity}/name/{toFQN}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLineageEdgeByNameWithHttpInfo(@Param("fromEntity") String fromEntity, @Param("fromFQN") String fromFQN, @Param("toEntity") String toEntity, @Param("toFQN") String toFQN);
/**
* Delete a lineage edge by Type
* Delete a lineage edge with from entity as upstream node and to entity as downstream node by source of lineage
* @param entityType Entity type of upstream entity of the edge (required)
* @param entityId Entity ID (required)
* @param lineageSource Lineage Type (required)
*/
@RequestLine("DELETE /v1/lineage/{entityType}/{entityId}/type/{lineageSource}")
@Headers({
"Accept: application/json",
})
void deleteLineageEdgeByType(@Param("entityType") String entityType, @Param("entityId") String entityId, @Param("lineageSource") String lineageSource);
/**
* Delete a lineage edge by Type
* Similar to deleteLineageEdgeByType but it also returns the http response headers .
* Delete a lineage edge with from entity as upstream node and to entity as downstream node by source of lineage
* @param entityType Entity type of upstream entity of the edge (required)
* @param entityId Entity ID (required)
* @param lineageSource Lineage Type (required)
*/
@RequestLine("DELETE /v1/lineage/{entityType}/{entityId}/type/{lineageSource}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLineageEdgeByTypeWithHttpInfo(@Param("entityType") String entityType, @Param("entityId") String entityId, @Param("lineageSource") String lineageSource);
/**
* Export lineage
*
* @param fqn fqn (optional)
* @param upstreamDepth upstreamDepth (optional)
* @param downstreamDepth downstreamDepth (optional)
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* @param includeDeleted Filter documents by deleted param. By default deleted is false (optional)
* @param type entity type (optional)
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/export?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
SearchResponse exportLineage(@Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth, @Param("queryFilter") String queryFilter, @Param("includeDeleted") Boolean includeDeleted, @Param("type") String type);
/**
* Export lineage
* Similar to exportLineage but it also returns the http response headers .
*
* @param fqn fqn (optional)
* @param upstreamDepth upstreamDepth (optional)
* @param downstreamDepth downstreamDepth (optional)
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* @param includeDeleted Filter documents by deleted param. By default deleted is false (optional)
* @param type entity type (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/lineage/export?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
ApiResponse exportLineageWithHttpInfo(@Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth, @Param("queryFilter") String queryFilter, @Param("includeDeleted") Boolean includeDeleted, @Param("type") String type);
/**
* Export lineage
*
* Note, this is equivalent to the other exportLineage 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 ExportLineageQueryParams} 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:
*
* - fqn - fqn (optional)
* - upstreamDepth - upstreamDepth (optional)
* - downstreamDepth - downstreamDepth (optional)
* - queryFilter - Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* - includeDeleted - Filter documents by deleted param. By default deleted is false (optional)
* - type - entity type (optional)
*
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/export?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
SearchResponse exportLineage(@QueryMap(encoded=true) ExportLineageQueryParams queryParams);
/**
* Export lineage
*
* Note, this is equivalent to the other exportLineage 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:
*
* - fqn - fqn (optional)
* - upstreamDepth - upstreamDepth (optional)
* - downstreamDepth - downstreamDepth (optional)
* - queryFilter - Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* - includeDeleted - Filter documents by deleted param. By default deleted is false (optional)
* - type - entity type (optional)
*
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/export?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
ApiResponse exportLineageWithHttpInfo(@QueryMap(encoded=true) ExportLineageQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* exportLineage method in a fluent style.
*/
public static class ExportLineageQueryParams extends HashMap {
public ExportLineageQueryParams fqn(final String value) {
put("fqn", EncodingUtils.encode(value));
return this;
}
public ExportLineageQueryParams upstreamDepth(final Integer value) {
put("upstreamDepth", EncodingUtils.encode(value));
return this;
}
public ExportLineageQueryParams downstreamDepth(final Integer value) {
put("downstreamDepth", EncodingUtils.encode(value));
return this;
}
public ExportLineageQueryParams queryFilter(final String value) {
put("query_filter", EncodingUtils.encode(value));
return this;
}
public ExportLineageQueryParams includeDeleted(final Boolean value) {
put("includeDeleted", EncodingUtils.encode(value));
return this;
}
public ExportLineageQueryParams type(final String value) {
put("type", EncodingUtils.encode(value));
return this;
}
}
/**
* Get lineage by Id
* Get lineage details for an entity identified by `Id`.
* @param entity Entity type for which lineage is requested (required)
* @param id Id of the entity (required)
* @param upstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @param downstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/{id}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
EntityLineage getLineage(@Param("entity") String entity, @Param("id") String id, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth);
/**
* Get lineage by Id
* Similar to getLineage but it also returns the http response headers .
* Get lineage details for an entity identified by `Id`.
* @param entity Entity type for which lineage is requested (required)
* @param id Id of the entity (required)
* @param upstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @param downstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/lineage/{entity}/{id}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
ApiResponse getLineageWithHttpInfo(@Param("entity") String entity, @Param("id") String id, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth);
/**
* Get lineage by Id
* Get lineage details for an entity identified by `Id`.
* Note, this is equivalent to the other getLineage 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 GetLineageQueryParams} class that allows for
* building up this map in a fluent style.
* @param entity Entity type for which lineage is requested (required)
* @param id Id of the entity (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - upstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* - downstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
*
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/{id}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
EntityLineage getLineage(@Param("entity") String entity, @Param("id") String id, @QueryMap(encoded=true) GetLineageQueryParams queryParams);
/**
* Get lineage by Id
* Get lineage details for an entity identified by `Id`.
* Note, this is equivalent to the other getLineage that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param entity Entity type for which lineage is requested (required)
* @param id Id of the entity (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - upstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* - downstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
*
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/{id}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
ApiResponse getLineageWithHttpInfo(@Param("entity") String entity, @Param("id") String id, @QueryMap(encoded=true) GetLineageQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getLineage method in a fluent style.
*/
public static class GetLineageQueryParams extends HashMap {
public GetLineageQueryParams upstreamDepth(final Integer value) {
put("upstreamDepth", EncodingUtils.encode(value));
return this;
}
public GetLineageQueryParams downstreamDepth(final Integer value) {
put("downstreamDepth", EncodingUtils.encode(value));
return this;
}
}
/**
* Get lineage by fully qualified name
* Get lineage details for an entity identified by fully qualified name.
* @param entity Entity type for which lineage is requested (required)
* @param fqn Fully qualified name of the entity that uniquely identifies an entity (required)
* @param upstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @param downstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/name/{fqn}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
EntityLineage getLineageByFQN(@Param("entity") String entity, @Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth);
/**
* Get lineage by fully qualified name
* Similar to getLineageByFQN but it also returns the http response headers .
* Get lineage details for an entity identified by fully qualified name.
* @param entity Entity type for which lineage is requested (required)
* @param fqn Fully qualified name of the entity that uniquely identifies an entity (required)
* @param upstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @param downstreamDepth Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/lineage/{entity}/name/{fqn}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
ApiResponse getLineageByFQNWithHttpInfo(@Param("entity") String entity, @Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth);
/**
* Get lineage by fully qualified name
* Get lineage details for an entity identified by fully qualified name.
* Note, this is equivalent to the other getLineageByFQN 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 GetLineageByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param entity Entity type for which lineage is requested (required)
* @param fqn Fully qualified name of the entity that uniquely identifies an entity (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - upstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* - downstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
*
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/name/{fqn}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
EntityLineage getLineageByFQN(@Param("entity") String entity, @Param("fqn") String fqn, @QueryMap(encoded=true) GetLineageByFQNQueryParams queryParams);
/**
* Get lineage by fully qualified name
* Get lineage details for an entity identified by fully qualified name.
* Note, this is equivalent to the other getLineageByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param entity Entity type for which lineage is requested (required)
* @param fqn Fully qualified name of the entity that uniquely identifies an entity (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - upstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
* - downstreamDepth - Upstream depth of lineage (default=1, min=0, max=3) (optional, default to 1)
*
* @return EntityLineage
*/
@RequestLine("GET /v1/lineage/{entity}/name/{fqn}?upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}")
@Headers({
"Accept: application/json",
})
ApiResponse getLineageByFQNWithHttpInfo(@Param("entity") String entity, @Param("fqn") String fqn, @QueryMap(encoded=true) GetLineageByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getLineageByFQN method in a fluent style.
*/
public static class GetLineageByFQNQueryParams extends HashMap {
public GetLineageByFQNQueryParams upstreamDepth(final Integer value) {
put("upstreamDepth", EncodingUtils.encode(value));
return this;
}
public GetLineageByFQNQueryParams downstreamDepth(final Integer value) {
put("downstreamDepth", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a lineage edge
* Get a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromId Entity FQN (required)
* @param toId Entity FQN (required)
*/
@RequestLine("GET /v1/lineage/getLineageEdge/{fromId}/{toId}")
@Headers({
"Accept: application/json",
})
void getLineageEdge(@Param("fromId") String fromId, @Param("toId") String toId);
/**
* Get a lineage edge
* Similar to getLineageEdge but it also returns the http response headers .
* Get a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromId Entity FQN (required)
* @param toId Entity FQN (required)
*/
@RequestLine("GET /v1/lineage/getLineageEdge/{fromId}/{toId}")
@Headers({
"Accept: application/json",
})
ApiResponse getLineageEdgeWithHttpInfo(@Param("fromId") String fromId, @Param("toId") String toId);
/**
* Patch a lineage edge
* Patch a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromId Entity id (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toId Entity id (required)
* @param body JsonPatch with array of operations (optional)
*/
@RequestLine("PATCH /v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchLineageEdge(@Param("fromEntity") String fromEntity, @Param("fromId") String fromId, @Param("toEntity") String toEntity, @Param("toId") String toId, Object body);
/**
* Patch a lineage edge
* Similar to patchLineageEdge but it also returns the http response headers .
* Patch a lineage edge with from entity as upstream node and to entity as downstream node.
* @param fromEntity Entity type of upstream entity of the edge (required)
* @param fromId Entity id (required)
* @param toEntity Entity type for downstream entity of the edge (required)
* @param toId Entity id (required)
* @param body JsonPatch with array of operations (optional)
*/
@RequestLine("PATCH /v1/lineage/{fromEntity}/{fromId}/{toEntity}/{toId}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchLineageEdgeWithHttpInfo(@Param("fromEntity") String fromEntity, @Param("fromId") String fromId, @Param("toEntity") String toEntity, @Param("toId") String toId, Object body);
/**
* Search lineage
*
* @param fqn fqn (optional)
* @param upstreamDepth upstreamDepth (optional)
* @param downstreamDepth downstreamDepth (optional)
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* @param includeDeleted Filter documents by deleted param. By default deleted is false (optional)
* @param type entity type (optional)
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/getLineage?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
SearchResponse searchLineage(@Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth, @Param("queryFilter") String queryFilter, @Param("includeDeleted") Boolean includeDeleted, @Param("type") String type);
/**
* Search lineage
* Similar to searchLineage but it also returns the http response headers .
*
* @param fqn fqn (optional)
* @param upstreamDepth upstreamDepth (optional)
* @param downstreamDepth downstreamDepth (optional)
* @param queryFilter Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* @param includeDeleted Filter documents by deleted param. By default deleted is false (optional)
* @param type entity type (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/lineage/getLineage?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
ApiResponse searchLineageWithHttpInfo(@Param("fqn") String fqn, @Param("upstreamDepth") Integer upstreamDepth, @Param("downstreamDepth") Integer downstreamDepth, @Param("queryFilter") String queryFilter, @Param("includeDeleted") Boolean includeDeleted, @Param("type") String type);
/**
* Search lineage
*
* Note, this is equivalent to the other searchLineage 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 SearchLineageQueryParams} 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:
*
* - fqn - fqn (optional)
* - upstreamDepth - upstreamDepth (optional)
* - downstreamDepth - downstreamDepth (optional)
* - queryFilter - Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* - includeDeleted - Filter documents by deleted param. By default deleted is false (optional)
* - type - entity type (optional)
*
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/getLineage?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
SearchResponse searchLineage(@QueryMap(encoded=true) SearchLineageQueryParams queryParams);
/**
* Search lineage
*
* Note, this is equivalent to the other searchLineage 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:
*
* - fqn - fqn (optional)
* - upstreamDepth - upstreamDepth (optional)
* - downstreamDepth - downstreamDepth (optional)
* - queryFilter - Elasticsearch query that will be combined with the query_string query generator from the `query` argument (optional)
* - includeDeleted - Filter documents by deleted param. By default deleted is false (optional)
* - type - entity type (optional)
*
* @return SearchResponse
*/
@RequestLine("GET /v1/lineage/getLineage?fqn={fqn}&upstreamDepth={upstreamDepth}&downstreamDepth={downstreamDepth}&query_filter={queryFilter}&includeDeleted={includeDeleted}&type={type}")
@Headers({
"Accept: application/json",
})
ApiResponse searchLineageWithHttpInfo(@QueryMap(encoded=true) SearchLineageQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchLineage method in a fluent style.
*/
public static class SearchLineageQueryParams extends HashMap {
public SearchLineageQueryParams fqn(final String value) {
put("fqn", EncodingUtils.encode(value));
return this;
}
public SearchLineageQueryParams upstreamDepth(final Integer value) {
put("upstreamDepth", EncodingUtils.encode(value));
return this;
}
public SearchLineageQueryParams downstreamDepth(final Integer value) {
put("downstreamDepth", EncodingUtils.encode(value));
return this;
}
public SearchLineageQueryParams queryFilter(final String value) {
put("query_filter", EncodingUtils.encode(value));
return this;
}
public SearchLineageQueryParams includeDeleted(final Boolean value) {
put("includeDeleted", EncodingUtils.encode(value));
return this;
}
public SearchLineageQueryParams type(final String value) {
put("type", EncodingUtils.encode(value));
return this;
}
}
}