org.openmetadata.client.api.DocumentStoreApi 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.CreateDocument;
import org.openmetadata.client.model.Document;
import org.openmetadata.client.model.DocumentList;
import org.openmetadata.client.model.EmailTemplate;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.TemplateValidationResponse;
import java.util.UUID;
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-13T20:15:57.513387948Z[Etc/UTC]")
public interface DocumentStoreApi extends ApiClient.Api {
/**
* Create a Document
* Create a new Document.
* @param createDocument (optional)
* @return Document
*/
@RequestLine("POST /v1/docStore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Document createDocument(CreateDocument createDocument);
/**
* Create a Document
* Similar to createDocument but it also returns the http response headers .
* Create a new Document.
* @param createDocument (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/docStore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDocumentWithHttpInfo(CreateDocument createDocument);
/**
* Update Document
* Create or Update a Document.
* @param createDocument (optional)
* @return Document
*/
@RequestLine("PUT /v1/docStore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Document createOrUpdateDocument(CreateDocument createDocument);
/**
* Update Document
* Similar to createOrUpdateDocument but it also returns the http response headers .
* Create or Update a Document.
* @param createDocument (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/docStore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDocumentWithHttpInfo(CreateDocument createDocument);
/**
* Delete a Document by id
* Delete a Document by given `id`.
* @param id Id of the Document (required)
*/
@RequestLine("DELETE /v1/docStore/{id}")
@Headers({
"Accept: application/json",
})
void deleteDocument(@Param("id") UUID id);
/**
* Delete a Document by id
* Similar to deleteDocument but it also returns the http response headers .
* Delete a Document by given `id`.
* @param id Id of the Document (required)
*/
@RequestLine("DELETE /v1/docStore/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDocumentWithHttpInfo(@Param("id") UUID id);
/**
* Delete a Document by name
* Delete a Document by given `name`.
* @param name Name of the Document (required)
*/
@RequestLine("DELETE /v1/docStore/name/{name}")
@Headers({
"Accept: application/json",
})
void deleteDocumentByName(@Param("name") String name);
/**
* Delete a Document by name
* Similar to deleteDocumentByName but it also returns the http response headers .
* Delete a Document by given `name`.
* @param name Name of the Document (required)
*/
@RequestLine("DELETE /v1/docStore/name/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDocumentByNameWithHttpInfo(@Param("name") String name);
/**
* Get a Document by id
* Get a Document by `id`.
* @param id Id of the Document (required)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return Document
*/
@RequestLine("GET /v1/docStore/{id}?include={include}")
@Headers({
"Accept: application/json",
})
Document get2(@Param("id") UUID id, @Param("include") String include);
/**
* Get a Document by id
* Similar to get2 but it also returns the http response headers .
* Get a Document by `id`.
* @param id Id of the Document (required)
* @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/docStore/{id}?include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get2WithHttpInfo(@Param("id") UUID id, @Param("include") String include);
/**
* Get a Document by id
* Get a Document by `id`.
* Note, this is equivalent to the other get2 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 Get2QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the Document (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Document
*/
@RequestLine("GET /v1/docStore/{id}?include={include}")
@Headers({
"Accept: application/json",
})
Document get2(@Param("id") UUID id, @QueryMap(encoded=true) Get2QueryParams queryParams);
/**
* Get a Document by id
* Get a Document by `id`.
* Note, this is equivalent to the other get2 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the Document (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Document
*/
@RequestLine("GET /v1/docStore/{id}?include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get2WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Get2QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get2 method in a fluent style.
*/
public static class Get2QueryParams extends HashMap {
public Get2QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a Document by name
* Get a Document by `name`.
* @param name Name of the Document (required)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return Document
*/
@RequestLine("GET /v1/docStore/name/{name}?include={include}")
@Headers({
"Accept: application/json",
})
Document getDocumentByFQN(@Param("name") String name, @Param("include") String include);
/**
* Get a Document by name
* Similar to getDocumentByFQN but it also returns the http response headers .
* Get a Document by `name`.
* @param name Name of the Document (required)
* @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/docStore/name/{name}?include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDocumentByFQNWithHttpInfo(@Param("name") String name, @Param("include") String include);
/**
* Get a Document by name
* Get a Document by `name`.
* Note, this is equivalent to the other getDocumentByFQN 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 GetDocumentByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the Document (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Document
*/
@RequestLine("GET /v1/docStore/name/{name}?include={include}")
@Headers({
"Accept: application/json",
})
Document getDocumentByFQN(@Param("name") String name, @QueryMap(encoded=true) GetDocumentByFQNQueryParams queryParams);
/**
* Get a Document by name
* Get a Document by `name`.
* Note, this is equivalent to the other getDocumentByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the Document (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return Document
*/
@RequestLine("GET /v1/docStore/name/{name}?include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDocumentByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetDocumentByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDocumentByFQN method in a fluent style.
*/
public static class GetDocumentByFQNQueryParams extends HashMap {
public GetDocumentByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the Document
* Get a version of the Document by given `id`
* @param id Id of the Document (required)
* @param version Document version number in the form `major`.`minor` (required)
* @return Document
*/
@RequestLine("GET /v1/docStore/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
Document getSpecificDocumentVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the Document
* Similar to getSpecificDocumentVersion but it also returns the http response headers .
* Get a version of the Document by given `id`
* @param id Id of the Document (required)
* @param version Document version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/docStore/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificDocumentVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* List Document versions
* Get a list of all the versions of a Document identified by `id`
* @param id Id of the Document (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/docStore/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDocumentVersion(@Param("id") UUID id);
/**
* List Document versions
* Similar to listAllDocumentVersion but it also returns the http response headers .
* Get a list of all the versions of a Document identified by `id`
* @param id Id of the Document (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/docStore/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDocumentVersionWithHttpInfo(@Param("id") UUID id);
/**
* List Documents
* Get a list of Documents. 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 limit Limit the number of personas returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param entityType Filter docs by entityType (optional)
* @param fqnPrefix Filter docs by fqnPrefix (optional)
* @param before Returns list of personas before this cursor (optional)
* @param after Returns list of personas after this cursor (optional)
* @return DocumentList
*/
@RequestLine("GET /v1/docStore?limit={limit}&entityType={entityType}&fqnPrefix={fqnPrefix}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DocumentList listDocuments(@Param("limit") Integer limit, @Param("entityType") String entityType, @Param("fqnPrefix") String fqnPrefix, @Param("before") String before, @Param("after") String after);
/**
* List Documents
* Similar to listDocuments but it also returns the http response headers .
* Get a list of Documents. 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 limit Limit the number of personas returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param entityType Filter docs by entityType (optional)
* @param fqnPrefix Filter docs by fqnPrefix (optional)
* @param before Returns list of personas before this cursor (optional)
* @param after Returns list of personas after this cursor (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/docStore?limit={limit}&entityType={entityType}&fqnPrefix={fqnPrefix}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDocumentsWithHttpInfo(@Param("limit") Integer limit, @Param("entityType") String entityType, @Param("fqnPrefix") String fqnPrefix, @Param("before") String before, @Param("after") String after);
/**
* List Documents
* Get a list of Documents. 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 listDocuments 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 ListDocumentsQueryParams} 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:
*
* - limit - Limit the number of personas returned. (1 to 1000000, default = 10) (optional, default to 10)
* - entityType - Filter docs by entityType (optional)
* - fqnPrefix - Filter docs by fqnPrefix (optional)
* - before - Returns list of personas before this cursor (optional)
* - after - Returns list of personas after this cursor (optional)
*
* @return DocumentList
*/
@RequestLine("GET /v1/docStore?limit={limit}&entityType={entityType}&fqnPrefix={fqnPrefix}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
DocumentList listDocuments(@QueryMap(encoded=true) ListDocumentsQueryParams queryParams);
/**
* List Documents
* Get a list of Documents. 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 listDocuments 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:
*
* - limit - Limit the number of personas returned. (1 to 1000000, default = 10) (optional, default to 10)
* - entityType - Filter docs by entityType (optional)
* - fqnPrefix - Filter docs by fqnPrefix (optional)
* - before - Returns list of personas before this cursor (optional)
* - after - Returns list of personas after this cursor (optional)
*
* @return DocumentList
*/
@RequestLine("GET /v1/docStore?limit={limit}&entityType={entityType}&fqnPrefix={fqnPrefix}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listDocumentsWithHttpInfo(@QueryMap(encoded=true) ListDocumentsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDocuments method in a fluent style.
*/
public static class ListDocumentsQueryParams extends HashMap {
public ListDocumentsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDocumentsQueryParams entityType(final String value) {
put("entityType", EncodingUtils.encode(value));
return this;
}
public ListDocumentsQueryParams fqnPrefix(final String value) {
put("fqnPrefix", EncodingUtils.encode(value));
return this;
}
public ListDocumentsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDocumentsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a Document by name.
* Update an existing Document with JsonPatch.
* @param fqn Name of the Document (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Document by name. Documentation
*/
@RequestLine("PATCH /v1/docStore/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDocument(@Param("fqn") String fqn, Object body);
/**
* Update a Document by name.
* Similar to patchDocument but it also returns the http response headers .
* Update an existing Document with JsonPatch.
* @param fqn Name of the Document (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Document by name. Documentation
*/
@RequestLine("PATCH /v1/docStore/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDocumentWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a Document.
* Update an existing Document with JsonPatch.
* @param id Id of the Document (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Document. Documentation
*/
@RequestLine("PATCH /v1/docStore/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDocument1(@Param("id") UUID id, Object body);
/**
* Update a Document.
* Similar to patchDocument1 but it also returns the http response headers .
* Update an existing Document with JsonPatch.
* @param id Id of the Document (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a Document. Documentation
*/
@RequestLine("PATCH /v1/docStore/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDocument1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Reset seed data of EmailTemplate type
* Deletes seed data of the EmailTemplate type from the document store and reinitializes it from resources.
* @return String
*/
@RequestLine("POST /v1/docStore/resetEmailTemplate")
@Headers({
"Accept: application/json",
})
String resetEmailTemplate();
/**
* Reset seed data of EmailTemplate type
* Similar to resetEmailTemplate but it also returns the http response headers .
* Deletes seed data of the EmailTemplate type from the document store and reinitializes it from resources.
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/docStore/resetEmailTemplate")
@Headers({
"Accept: application/json",
})
ApiResponse resetEmailTemplateWithHttpInfo();
/**
* Validate Email Template
* Validates is the give content is a valid Email Template.
* @param templateName Template name for the email template to be validated (required)
* @param emailTemplate (optional)
* @return TemplateValidationResponse
*/
@RequestLine("PUT /v1/docStore/validateTemplate/{templateName}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TemplateValidationResponse validateEmailTemplate(@Param("templateName") String templateName, EmailTemplate emailTemplate);
/**
* Validate Email Template
* Similar to validateEmailTemplate but it also returns the http response headers .
* Validates is the give content is a valid Email Template.
* @param templateName Template name for the email template to be validated (required)
* @param emailTemplate (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/docStore/validateTemplate/{templateName}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse validateEmailTemplateWithHttpInfo(@Param("templateName") String templateName, EmailTemplate emailTemplate);
}