org.openmetadata.client.api.ReportsBetaApi 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.Report;
import org.openmetadata.client.model.ReportList;
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-07-03T19:44:33.436780642Z[Etc/UTC]")
public interface ReportsBetaApi extends ApiClient.Api {
/**
* Create or update a report
* Create a new report, it it does not exist or update an existing report.
* @param report (optional)
* @return Report
*/
@RequestLine("PUT /v1/reports")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Report createOrUpdateReport(Report report);
/**
* Create or update a report
* Similar to createOrUpdateReport but it also returns the http response headers .
* Create a new report, it it does not exist or update an existing report.
* @param report (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/reports")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateReportWithHttpInfo(Report report);
/**
* Create a report
* Create a new report.
* @param report (optional)
* @return Report
*/
@RequestLine("POST /v1/reports")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Report getReportByFQN(Report report);
/**
* Create a report
* Similar to getReportByFQN but it also returns the http response headers .
* Create a new report.
* @param report (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/reports")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse getReportByFQNWithHttpInfo(Report report);
/**
* Get a report by Id
* Get a report by `Id`.
* @param id Id of the report (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 Report
*/
@RequestLine("GET /v1/reports/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Report getReportByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a report by Id
* Similar to getReportByID but it also returns the http response headers .
* Get a report by `Id`.
* @param id Id of the report (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/reports/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getReportByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a report by Id
* Get a report by `Id`.
* Note, this is equivalent to the other getReportByID 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 GetReportByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the report (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 Report
*/
@RequestLine("GET /v1/reports/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Report getReportByID(@Param("id") UUID id, @QueryMap(encoded=true) GetReportByIDQueryParams queryParams);
/**
* Get a report by Id
* Get a report by `Id`.
* Note, this is equivalent to the other getReportByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the report (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 Report
*/
@RequestLine("GET /v1/reports/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getReportByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetReportByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getReportByID method in a fluent style.
*/
public static class GetReportByIDQueryParams extends HashMap {
public GetReportByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetReportByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List reports
* Get a list of reports. Use `fields` parameter to get only necessary fields.
* @param fields Fields requested in the returned resource (optional)
* @return ReportList
*/
@RequestLine("GET /v1/reports?fields={fields}")
@Headers({
"Accept: application/json",
})
ReportList listReports(@Param("fields") String fields);
/**
* List reports
* Similar to listReports but it also returns the http response headers .
* Get a list of reports. Use `fields` parameter to get only necessary fields.
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/reports?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse listReportsWithHttpInfo(@Param("fields") String fields);
/**
* List reports
* Get a list of reports. Use `fields` parameter to get only necessary fields.
* Note, this is equivalent to the other listReports 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 ListReportsQueryParams} 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)
*
* @return ReportList
*/
@RequestLine("GET /v1/reports?fields={fields}")
@Headers({
"Accept: application/json",
})
ReportList listReports(@QueryMap(encoded=true) ListReportsQueryParams queryParams);
/**
* List reports
* Get a list of reports. Use `fields` parameter to get only necessary fields.
* Note, this is equivalent to the other listReports 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)
*
* @return ReportList
*/
@RequestLine("GET /v1/reports?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse listReportsWithHttpInfo(@QueryMap(encoded=true) ListReportsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listReports method in a fluent style.
*/
public static class ListReportsQueryParams extends HashMap {
public ListReportsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* 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/reports/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent updateVoteForEntity13(@Param("id") UUID id, VoteRequest voteRequest);
/**
* Update Vote for a Entity
* Similar to updateVoteForEntity13 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/reports/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateVoteForEntity13WithHttpInfo(@Param("id") UUID id, VoteRequest voteRequest);
}