org.openmetadata.client.api.DashboardServicesApi 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.CreateDashboardService;
import org.openmetadata.client.model.DashboardService;
import org.openmetadata.client.model.DashboardServiceList;
import org.openmetadata.client.model.DatabaseService;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TestConnectionResult;
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-07-03T19:44:33.436780642Z[Etc/UTC]")
public interface DashboardServicesApi extends ApiClient.Api {
/**
* Add test connection result
* Add test connection result to the service.
* @param id Id of the service (required)
* @param testConnectionResult (optional)
* @return DatabaseService
*/
@RequestLine("PUT /v1/services/dashboardServices/{id}/testConnectionResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DatabaseService addTestConnectionResult(@Param("id") UUID id, TestConnectionResult testConnectionResult);
/**
* Add test connection result
* Similar to addTestConnectionResult but it also returns the http response headers .
* Add test connection result to the service.
* @param id Id of the service (required)
* @param testConnectionResult (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/dashboardServices/{id}/testConnectionResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addTestConnectionResultWithHttpInfo(@Param("id") UUID id, TestConnectionResult testConnectionResult);
/**
* Create a dashboard service
* Create a new dashboard service.
* @param createDashboardService (optional)
* @return DashboardService
*/
@RequestLine("POST /v1/services/dashboardServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DashboardService createDashboardService(CreateDashboardService createDashboardService);
/**
* Create a dashboard service
* Similar to createDashboardService but it also returns the http response headers .
* Create a new dashboard service.
* @param createDashboardService (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/dashboardServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createDashboardServiceWithHttpInfo(CreateDashboardService createDashboardService);
/**
* Update a dashboard service
* Update an existing dashboard service identified by `Id`.
* @param createDashboardService (optional)
* @return DashboardService
*/
@RequestLine("PUT /v1/services/dashboardServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DashboardService createOrUpdateDashboardService(CreateDashboardService createDashboardService);
/**
* Update a dashboard service
* Similar to createOrUpdateDashboardService but it also returns the http response headers .
* Update an existing dashboard service identified by `Id`.
* @param createDashboardService (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/dashboardServices")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateDashboardServiceWithHttpInfo(CreateDashboardService createDashboardService);
/**
* Delete a dashboard service by Id
* Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be deleted.
* @param id Id of the dashboard service (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/dashboardServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDashboardService(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a dashboard service by Id
* Similar to deleteDashboardService but it also returns the http response headers .
* Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be deleted.
* @param id Id of the dashboard service (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/dashboardServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardServiceWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a dashboard service by Id
* Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be deleted.
* Note, this is equivalent to the other deleteDashboardService 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 DeleteDashboardServiceQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the dashboard service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/dashboardServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteDashboardService(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDashboardServiceQueryParams queryParams);
/**
* Delete a dashboard service by Id
* Delete a Dashboard services. If dashboard (and charts) belong to the service, it can't be deleted.
* Note, this is equivalent to the other deleteDashboardService that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the dashboard service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/dashboardServices/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardServiceWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteDashboardServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDashboardService method in a fluent style.
*/
public static class DeleteDashboardServiceQueryParams extends HashMap {
public DeleteDashboardServiceQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
public DeleteDashboardServiceQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a dashboard service by name
* Delete a Dashboard services by `name`. If dashboard (and charts) belong to the service, it can't be deleted.
* @param name Name of the dashboard service (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/dashboardServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDashboardServiceByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a dashboard service by name
* Similar to deleteDashboardServiceByName but it also returns the http response headers .
* Delete a Dashboard services by `name`. If dashboard (and charts) belong to the service, it can't be deleted.
* @param name Name of the dashboard service (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/dashboardServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardServiceByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a dashboard service by name
* Delete a Dashboard services by `name`. If dashboard (and charts) belong to the service, it can't be deleted.
* Note, this is equivalent to the other deleteDashboardServiceByName 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 DeleteDashboardServiceByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the dashboard service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/dashboardServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteDashboardServiceByName(@Param("name") String name, @QueryMap(encoded=true) DeleteDashboardServiceByNameQueryParams queryParams);
/**
* Delete a dashboard service by name
* Delete a Dashboard services by `name`. If dashboard (and charts) belong to the service, it can't be deleted.
* Note, this is equivalent to the other deleteDashboardServiceByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the dashboard service (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/services/dashboardServices/name/{name}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteDashboardServiceByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteDashboardServiceByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteDashboardServiceByName method in a fluent style.
*/
public static class DeleteDashboardServiceByNameQueryParams extends HashMap {
public DeleteDashboardServiceByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeleteDashboardServiceByNameQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Get dashboard service by name
* Get a dashboard service by the service `name`.
* @param name Name of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardService getDashboardServiceByFQN(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get dashboard service by name
* Similar to getDashboardServiceByFQN but it also returns the http response headers .
* Get a dashboard service by the service `name`.
* @param name Name of the dashboard service (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/services/dashboardServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardServiceByFQNWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get dashboard service by name
* Get a dashboard service by the service `name`.
* Note, this is equivalent to the other getDashboardServiceByFQN 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 GetDashboardServiceByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardService getDashboardServiceByFQN(@Param("name") String name, @QueryMap(encoded=true) GetDashboardServiceByFQNQueryParams queryParams);
/**
* Get dashboard service by name
* Get a dashboard service by the service `name`.
* Note, this is equivalent to the other getDashboardServiceByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardServiceByFQNWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetDashboardServiceByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDashboardServiceByFQN method in a fluent style.
*/
public static class GetDashboardServiceByFQNQueryParams extends HashMap {
public GetDashboardServiceByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDashboardServiceByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a dashboard service by Id
* Get a dashboard service by `Id`.
* @param id Id of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardService getDashboardServiceByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard service by Id
* Similar to getDashboardServiceByID but it also returns the http response headers .
* Get a dashboard service by `Id`.
* @param id Id of the dashboard service (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/services/dashboardServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardServiceByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a dashboard service by Id
* Get a dashboard service by `Id`.
* Note, this is equivalent to the other getDashboardServiceByID 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 GetDashboardServiceByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardService getDashboardServiceByID(@Param("id") UUID id, @QueryMap(encoded=true) GetDashboardServiceByIDQueryParams queryParams);
/**
* Get a dashboard service by Id
* Get a dashboard service by `Id`.
* Note, this is equivalent to the other getDashboardServiceByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the dashboard service (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 DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getDashboardServiceByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetDashboardServiceByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getDashboardServiceByID method in a fluent style.
*/
public static class GetDashboardServiceByIDQueryParams extends HashMap {
public GetDashboardServiceByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetDashboardServiceByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the dashboard service
* Get a version of the dashboard service by given `Id`
* @param id Id of the dashboard service (required)
* @param version dashboard service version number in the form `major`.`minor` (required)
* @return DashboardService
*/
@RequestLine("GET /v1/services/dashboardServices/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
DashboardService getSpecificDashboardServiceVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the dashboard service
* Similar to getSpecificDashboardServiceVersion but it also returns the http response headers .
* Get a version of the dashboard service by given `Id`
* @param id Id of the dashboard service (required)
* @param version dashboard service version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/dashboardServices/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificDashboardServiceVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* List dashboard service versions
* Get a list of all the versions of a dashboard service identified by `Id`
* @param id Id of the dashboard service (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/services/dashboardServices/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllDashboardServiceVersion(@Param("id") UUID id);
/**
* List dashboard service versions
* Similar to listAllDashboardServiceVersion but it also returns the http response headers .
* Get a list of all the versions of a dashboard service identified by `Id`
* @param id Id of the dashboard service (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/dashboardServices/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllDashboardServiceVersionWithHttpInfo(@Param("id") UUID id);
/**
* List dashboard services
* Get a list of dashboard services.
* @param name (optional)
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter services by domain (optional)
* @param limit (optional, default to 10)
* @param before Returns list of dashboard services before this cursor (optional)
* @param after Returns list of dashboard services after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return DashboardServiceList
*/
@RequestLine("GET /v1/services/dashboardServices?name={name}&fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardServiceList listDashboardsService(@Param("name") String name, @Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List dashboard services
* Similar to listDashboardsService but it also returns the http response headers .
* Get a list of dashboard services.
* @param name (optional)
* @param fields Fields requested in the returned resource (optional)
* @param domain Filter services by domain (optional)
* @param limit (optional, default to 10)
* @param before Returns list of dashboard services before this cursor (optional)
* @param after Returns list of dashboard services after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/dashboardServices?name={name}&fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDashboardsServiceWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("domain") String domain, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List dashboard services
* Get a list of dashboard services.
* Note, this is equivalent to the other listDashboardsService 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 ListDashboardsServiceQueryParams} 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:
*
* - name - (optional)
* - fields - Fields requested in the returned resource (optional)
* - domain - Filter services by domain (optional)
* - limit - (optional, default to 10)
* - before - Returns list of dashboard services before this cursor (optional)
* - after - Returns list of dashboard services after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DashboardServiceList
*/
@RequestLine("GET /v1/services/dashboardServices?name={name}&fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
DashboardServiceList listDashboardsService(@QueryMap(encoded=true) ListDashboardsServiceQueryParams queryParams);
/**
* List dashboard services
* Get a list of dashboard services.
* Note, this is equivalent to the other listDashboardsService 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:
*
* - name - (optional)
* - fields - Fields requested in the returned resource (optional)
* - domain - Filter services by domain (optional)
* - limit - (optional, default to 10)
* - before - Returns list of dashboard services before this cursor (optional)
* - after - Returns list of dashboard services after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return DashboardServiceList
*/
@RequestLine("GET /v1/services/dashboardServices?name={name}&fields={fields}&domain={domain}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listDashboardsServiceWithHttpInfo(@QueryMap(encoded=true) ListDashboardsServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listDashboardsService method in a fluent style.
*/
public static class ListDashboardsServiceQueryParams extends HashMap {
public ListDashboardsServiceQueryParams name(final String value) {
put("name", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams domain(final String value) {
put("domain", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListDashboardsServiceQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a dashboard service using name.
* Update an existing dashboard service using JsonPatch.
* @param fqn Name of the dashboard service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard service using name. Documentation
*/
@RequestLine("PATCH /v1/services/dashboardServices/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDashboardService(@Param("fqn") String fqn, Object body);
/**
* Update a dashboard service using name.
* Similar to patchDashboardService but it also returns the http response headers .
* Update an existing dashboard service using JsonPatch.
* @param fqn Name of the dashboard service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard service using name. Documentation
*/
@RequestLine("PATCH /v1/services/dashboardServices/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDashboardServiceWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a dashboard service
* Update an existing dashboard service using JsonPatch.
* @param id Id of the dashboard service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard service Documentation
*/
@RequestLine("PATCH /v1/services/dashboardServices/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchDashboardService1(@Param("id") UUID id, Object body);
/**
* Update a dashboard service
* Similar to patchDashboardService1 but it also returns the http response headers .
* Update an existing dashboard service using JsonPatch.
* @param id Id of the dashboard service (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a dashboard service Documentation
*/
@RequestLine("PATCH /v1/services/dashboardServices/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchDashboardService1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted dashboard service
* Restore a soft deleted dashboard service.
* @param restoreEntity (optional)
* @return DashboardService
*/
@RequestLine("PUT /v1/services/dashboardServices/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
DashboardService restore20(RestoreEntity restoreEntity);
/**
* Restore a soft deleted dashboard service
* Similar to restore20 but it also returns the http response headers .
* Restore a soft deleted dashboard service.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/dashboardServices/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore20WithHttpInfo(RestoreEntity restoreEntity);
}