org.openmetadata.client.api.AppsApi 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.App;
import org.openmetadata.client.model.AppList;
import org.openmetadata.client.model.AppMarketPlaceDefinition;
import org.openmetadata.client.model.AppMarketPlaceDefinitionList;
import org.openmetadata.client.model.AppRunList;
import org.openmetadata.client.model.AppRunRecord;
import java.math.BigDecimal;
import org.openmetadata.client.model.ConfigureApplication200Response;
import org.openmetadata.client.model.CreateApp;
import org.openmetadata.client.model.CreateAppMarketPlaceDefinitionReq;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
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 AppsApi extends ApiClient.Api {
/**
* Configure an Application
* Schedule a application to be run on demand.
* @param name Name of the App (required)
* @return ConfigureApplication200Response
*/
@RequestLine("POST /v1/apps/configure/{name}")
@Headers({
"Accept: application/json",
})
ConfigureApplication200Response configureApplication(@Param("name") String name);
/**
* Configure an Application
* Similar to configureApplication but it also returns the http response headers .
* Schedule a application to be run on demand.
* @param name Name of the App (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/apps/configure/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse configureApplicationWithHttpInfo(@Param("name") String name);
/**
* Create a Application
* Create a application
* @param createAppMarketPlaceDefinitionReq (optional)
* @return AppMarketPlaceDefinition
*/
@RequestLine("POST /v1/apps/marketplace")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
AppMarketPlaceDefinition createApplication(CreateAppMarketPlaceDefinitionReq createAppMarketPlaceDefinitionReq);
/**
* Create a Application
* Similar to createApplication but it also returns the http response headers .
* Create a application
* @param createAppMarketPlaceDefinitionReq (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/apps/marketplace")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createApplicationWithHttpInfo(CreateAppMarketPlaceDefinitionReq createAppMarketPlaceDefinitionReq);
/**
* Create a Application
* Create a application
* @param createApp (optional)
* @return App
*/
@RequestLine("POST /v1/apps")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
App createApplication1(CreateApp createApp);
/**
* Create a Application
* Similar to createApplication1 but it also returns the http response headers .
* Create a application
* @param createApp (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/apps")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createApplication1WithHttpInfo(CreateApp createApp);
/**
* Create Or Update App
* Create or Update App, it it does not exist or update an existing KPI.
* @param createAppMarketPlaceDefinitionReq (optional)
* @return App
*/
@RequestLine("PUT /v1/apps/marketplace")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
App createOrUpdateApp(CreateAppMarketPlaceDefinitionReq createAppMarketPlaceDefinitionReq);
/**
* Create Or Update App
* Similar to createOrUpdateApp but it also returns the http response headers .
* Create or Update App, it it does not exist or update an existing KPI.
* @param createAppMarketPlaceDefinitionReq (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/apps/marketplace")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateAppWithHttpInfo(CreateAppMarketPlaceDefinitionReq createAppMarketPlaceDefinitionReq);
/**
* Create Or Update App
* Create or Update App, it it does not exist or update an existing KPI.
* @param createApp (optional)
* @return App
*/
@RequestLine("PUT /v1/apps")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
App createOrUpdateApp1(CreateApp createApp);
/**
* Create Or Update App
* Similar to createOrUpdateApp1 but it also returns the http response headers .
* Create or Update App, it it does not exist or update an existing KPI.
* @param createApp (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/apps")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateApp1WithHttpInfo(CreateApp createApp);
/**
* Delete a App by Id
* Delete a App by `Id`.
* @param id Id of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/marketplace/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteApp(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by Id
* Similar to deleteApp but it also returns the http response headers .
* Delete a App by `Id`.
* @param id Id of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/marketplace/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAppWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by Id
* Delete a App by `Id`.
* Note, this is equivalent to the other deleteApp 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 DeleteAppQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/marketplace/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteApp(@Param("id") UUID id, @QueryMap(encoded=true) DeleteAppQueryParams queryParams);
/**
* Delete a App by Id
* Delete a App by `Id`.
* Note, this is equivalent to the other deleteApp that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/marketplace/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAppWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteAppQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteApp method in a fluent style.
*/
public static class DeleteAppQueryParams extends HashMap {
public DeleteAppQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a App by name
* Delete a App by `name`.
* @param name Name of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/marketplace/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteAppByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by name
* Similar to deleteAppByName but it also returns the http response headers .
* Delete a App by `name`.
* @param name Name of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/marketplace/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAppByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by name
* Delete a App by `name`.
* Note, this is equivalent to the other deleteAppByName 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 DeleteAppByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/marketplace/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteAppByName(@Param("name") String name, @QueryMap(encoded=true) DeleteAppByNameQueryParams queryParams);
/**
* Delete a App by name
* Delete a App by `name`.
* Note, this is equivalent to the other deleteAppByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/marketplace/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteAppByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteAppByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteAppByName method in a fluent style.
*/
public static class DeleteAppByNameQueryParams extends HashMap {
public DeleteAppByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Deploy App to Quartz or Ingestion
* Deploy App to Quartz or Ingestion.
* @param name Name of the App (required)
*/
@RequestLine("POST /v1/apps/deploy/{name}")
@Headers({
"Accept: application/json",
})
void deployApplicationToQuartzOrIngestion(@Param("name") String name);
/**
* Deploy App to Quartz or Ingestion
* Similar to deployApplicationToQuartzOrIngestion but it also returns the http response headers .
* Deploy App to Quartz or Ingestion.
* @param name Name of the App (required)
*/
@RequestLine("POST /v1/apps/deploy/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse deployApplicationToQuartzOrIngestionWithHttpInfo(@Param("name") String name);
/**
* Get a app by Id
* Get a app by `Id`.
* @param id Id of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinition get(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a app by Id
* Similar to get but it also returns the http response headers .
* Get a app by `Id`.
* @param id Id of the App (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/apps/marketplace/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a app by Id
* Get a app by `Id`.
* Note, this is equivalent to the other get 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 GetQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinition get(@Param("id") UUID id, @QueryMap(encoded=true) GetQueryParams queryParams);
/**
* Get a app by Id
* Get a app by `Id`.
* Note, this is equivalent to the other get that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get method in a fluent style.
*/
public static class GetQueryParams extends HashMap {
public GetQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a app by Id
* Get a app by `Id`.
* @param id Id of the App (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 App
*/
@RequestLine("GET /v1/apps/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
App get1(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a app by Id
* Similar to get1 but it also returns the http response headers .
* Get a app by `Id`.
* @param id Id of the App (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/apps/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get1WithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a app by Id
* Get a app by `Id`.
* Note, this is equivalent to the other get1 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 Get1QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the App (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 App
*/
@RequestLine("GET /v1/apps/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
App get1(@Param("id") UUID id, @QueryMap(encoded=true) Get1QueryParams queryParams);
/**
* Get a app by Id
* Get a app by `Id`.
* Note, this is equivalent to the other get1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the App (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 App
*/
@RequestLine("GET /v1/apps/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get1WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Get1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get1 method in a fluent style.
*/
public static class Get1QueryParams extends HashMap {
public Get1QueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public Get1QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a App by name
* Get a App by `name`.
* @param name Name of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinition getAppByName(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a App by name
* Similar to getAppByName but it also returns the http response headers .
* Get a App by `name`.
* @param name Name of the App (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/apps/marketplace/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getAppByNameWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a App by name
* Get a App by `name`.
* Note, this is equivalent to the other getAppByName 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 GetAppByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinition getAppByName(@Param("name") String name, @QueryMap(encoded=true) GetAppByNameQueryParams queryParams);
/**
* Get a App by name
* Get a App by `name`.
* Note, this is equivalent to the other getAppByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (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 AppMarketPlaceDefinition
*/
@RequestLine("GET /v1/apps/marketplace/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getAppByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetAppByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getAppByName method in a fluent style.
*/
public static class GetAppByNameQueryParams extends HashMap {
public GetAppByNameQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetAppByNameQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a App by name
* Get a App by `name`.
* @param name Name of the App (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 App
*/
@RequestLine("GET /v1/apps/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
App getAppByName1(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a App by name
* Similar to getAppByName1 but it also returns the http response headers .
* Get a App by `name`.
* @param name Name of the App (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/apps/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getAppByName1WithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a App by name
* Get a App by `name`.
* Note, this is equivalent to the other getAppByName1 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 GetAppByName1QueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (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 App
*/
@RequestLine("GET /v1/apps/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
App getAppByName1(@Param("name") String name, @QueryMap(encoded=true) GetAppByName1QueryParams queryParams);
/**
* Get a App by name
* Get a App by `name`.
* Note, this is equivalent to the other getAppByName1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (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 App
*/
@RequestLine("GET /v1/apps/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getAppByName1WithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetAppByName1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getAppByName1 method in a fluent style.
*/
public static class GetAppByName1QueryParams extends HashMap {
public GetAppByName1QueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetAppByName1QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Retrieve all logs from last ingestion pipeline run for the application
* Get all logs from last ingestion pipeline run by `Id`.
* @param name Name of the App (required)
* @param after Returns log chunk after this cursor (optional, default to )
*/
@RequestLine("GET /v1/apps/name/{name}/logs?after={after}")
@Headers({
"Accept: application/json",
})
void getLastLogs(@Param("name") String name, @Param("after") String after);
/**
* Retrieve all logs from last ingestion pipeline run for the application
* Similar to getLastLogs but it also returns the http response headers .
* Get all logs from last ingestion pipeline run by `Id`.
* @param name Name of the App (required)
* @param after Returns log chunk after this cursor (optional, default to )
*/
@RequestLine("GET /v1/apps/name/{name}/logs?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse getLastLogsWithHttpInfo(@Param("name") String name, @Param("after") String after);
/**
* Retrieve all logs from last ingestion pipeline run for the application
* Get all logs from last ingestion pipeline run by `Id`.
* Note, this is equivalent to the other getLastLogs 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 GetLastLogsQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - after - Returns log chunk after this cursor (optional, default to )
*
*/
@RequestLine("GET /v1/apps/name/{name}/logs?after={after}")
@Headers({
"Accept: application/json",
})
void getLastLogs(@Param("name") String name, @QueryMap(encoded=true) GetLastLogsQueryParams queryParams);
/**
* Retrieve all logs from last ingestion pipeline run for the application
* Get all logs from last ingestion pipeline run by `Id`.
* Note, this is equivalent to the other getLastLogs that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - after - Returns log chunk after this cursor (optional, default to )
*
*/
@RequestLine("GET /v1/apps/name/{name}/logs?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse getLastLogsWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetLastLogsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getLastLogs method in a fluent style.
*/
public static class GetLastLogsQueryParams extends HashMap {
public GetLastLogsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the App
* Get a version of the App by given `id`
* @param id Id of the App (required)
* @param version KPI version number in the form `major`.`minor` (required)
* @return App
*/
@RequestLine("GET /v1/apps/marketplace/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
App getSpecificAppVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the App
* Similar to getSpecificAppVersion but it also returns the http response headers .
* Get a version of the App by given `id`
* @param id Id of the App (required)
* @param version KPI version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/marketplace/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificAppVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the App
* Get a version of the App by given `id`
* @param id Id of the App (required)
* @param version App version number in the form `major`.`minor` (required)
* @return App
*/
@RequestLine("GET /v1/apps/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
App getSpecificAppVersion1(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the App
* Similar to getSpecificAppVersion1 but it also returns the http response headers .
* Get a version of the App by given `id`
* @param id Id of the App (required)
* @param version App version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificAppVersion1WithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get Latest App Run Record
* Get a latest applications Run Record.
* @param name Name of the App (required)
* @param after Returns log chunk after this cursor (optional, default to )
* @return AppRunRecord
*/
@RequestLine("GET /v1/apps/name/{name}/runs/latest?after={after}")
@Headers({
"Accept: application/json",
})
AppRunRecord latestAppRunRecord(@Param("name") String name, @Param("after") String after);
/**
* Get Latest App Run Record
* Similar to latestAppRunRecord but it also returns the http response headers .
* Get a latest applications Run Record.
* @param name Name of the App (required)
* @param after Returns log chunk after this cursor (optional, default to )
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/name/{name}/runs/latest?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse latestAppRunRecordWithHttpInfo(@Param("name") String name, @Param("after") String after);
/**
* Get Latest App Run Record
* Get a latest applications Run Record.
* Note, this is equivalent to the other latestAppRunRecord 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 LatestAppRunRecordQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - after - Returns log chunk after this cursor (optional, default to )
*
* @return AppRunRecord
*/
@RequestLine("GET /v1/apps/name/{name}/runs/latest?after={after}")
@Headers({
"Accept: application/json",
})
AppRunRecord latestAppRunRecord(@Param("name") String name, @QueryMap(encoded=true) LatestAppRunRecordQueryParams queryParams);
/**
* Get Latest App Run Record
* Get a latest applications Run Record.
* Note, this is equivalent to the other latestAppRunRecord that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - after - Returns log chunk after this cursor (optional, default to )
*
* @return AppRunRecord
*/
@RequestLine("GET /v1/apps/name/{name}/runs/latest?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse latestAppRunRecordWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) LatestAppRunRecordQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* latestAppRunRecord method in a fluent style.
*/
public static class LatestAppRunRecordQueryParams extends HashMap {
public LatestAppRunRecordQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* List Installed Application versions
* Get a list of all the versions of a application identified by `id`
* @param id Id of the app (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/apps/marketplace/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllInstalledApplications(@Param("id") UUID id);
/**
* List Installed Application versions
* Similar to listAllInstalledApplications but it also returns the http response headers .
* Get a list of all the versions of a application identified by `id`
* @param id Id of the app (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/marketplace/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllInstalledApplicationsWithHttpInfo(@Param("id") UUID id);
/**
* List Installed Application versions
* Get a list of all the versions of a application identified by `id`
* @param id Id of the app (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/apps/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllInstalledApplications1(@Param("id") UUID id);
/**
* List Installed Application versions
* Similar to listAllInstalledApplications1 but it also returns the http response headers .
* Get a list of all the versions of a application identified by `id`
* @param id Id of the app (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllInstalledApplications1WithHttpInfo(@Param("id") UUID id);
/**
* List App Run Records
* Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params.
* @param name Name of the App (required)
* @param limit Limit records. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Offset records. (0 to 1000000, default = 0) (optional, default to 0)
* @param startTs Filter pipeline status after the given start timestamp (optional)
* @param endTs Filter pipeline status before the given end timestamp (optional)
* @return AppRunList
*/
@RequestLine("GET /v1/apps/name/{name}/status?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
AppRunList listAppRunRecords(@Param("name") String name, @Param("limit") Integer limit, @Param("offset") Integer offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List App Run Records
* Similar to listAppRunRecords but it also returns the http response headers .
* Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params.
* @param name Name of the App (required)
* @param limit Limit records. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Offset records. (0 to 1000000, default = 0) (optional, default to 0)
* @param startTs Filter pipeline status after the given start timestamp (optional)
* @param endTs Filter pipeline status before the given end timestamp (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/apps/name/{name}/status?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listAppRunRecordsWithHttpInfo(@Param("name") String name, @Param("limit") Integer limit, @Param("offset") Integer offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List App Run Records
* Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params.
* Note, this is equivalent to the other listAppRunRecords 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 ListAppRunRecordsQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Limit records. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Offset records. (0 to 1000000, default = 0) (optional, default to 0)
* - startTs - Filter pipeline status after the given start timestamp (optional)
* - endTs - Filter pipeline status before the given end timestamp (optional)
*
* @return AppRunList
*/
@RequestLine("GET /v1/apps/name/{name}/status?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
AppRunList listAppRunRecords(@Param("name") String name, @QueryMap(encoded=true) ListAppRunRecordsQueryParams queryParams);
/**
* List App Run Records
* Get a list of applications Run Record. Use cursor-based pagination to limit the number entries in the list using `offset` query params.
* Note, this is equivalent to the other listAppRunRecords that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Limit records. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Offset records. (0 to 1000000, default = 0) (optional, default to 0)
* - startTs - Filter pipeline status after the given start timestamp (optional)
* - endTs - Filter pipeline status before the given end timestamp (optional)
*
* @return AppRunList
*/
@RequestLine("GET /v1/apps/name/{name}/status?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listAppRunRecordsWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) ListAppRunRecordsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listAppRunRecords method in a fluent style.
*/
public static class ListAppRunRecordsQueryParams extends HashMap {
public ListAppRunRecordsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListAppRunRecordsQueryParams offset(final Integer value) {
put("offset", EncodingUtils.encode(value));
return this;
}
public ListAppRunRecordsQueryParams startTs(final BigDecimal value) {
put("startTs", EncodingUtils.encode(value));
return this;
}
public ListAppRunRecordsQueryParams endTs(final BigDecimal value) {
put("endTs", EncodingUtils.encode(value));
return this;
}
}
/**
* List application
* Get a list of applications. 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 fields Fields requested in the returned resource (optional)
* @param limit Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return AppMarketPlaceDefinitionList
*/
@RequestLine("GET /v1/apps/marketplace?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinitionList listApplications(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List application
* Similar to listApplications but it also returns the http response headers .
* Get a list of applications. 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 fields Fields requested in the returned resource (optional)
* @param limit Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests 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/apps/marketplace?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listApplicationsWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List application
* Get a list of applications. 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 listApplications 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 ListApplicationsQueryParams} 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)
* - limit - Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return AppMarketPlaceDefinitionList
*/
@RequestLine("GET /v1/apps/marketplace?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
AppMarketPlaceDefinitionList listApplications(@QueryMap(encoded=true) ListApplicationsQueryParams queryParams);
/**
* List application
* Get a list of applications. 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 listApplications 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)
* - limit - Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return AppMarketPlaceDefinitionList
*/
@RequestLine("GET /v1/apps/marketplace?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listApplicationsWithHttpInfo(@QueryMap(encoded=true) ListApplicationsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listApplications method in a fluent style.
*/
public static class ListApplicationsQueryParams extends HashMap {
public ListApplicationsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListApplicationsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListApplicationsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListApplicationsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListApplicationsQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List installed application
* Get a list of applications. 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 fields Fields requested in the returned resource (optional)
* @param limit Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return AppList
*/
@RequestLine("GET /v1/apps?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
AppList listInstalledApplications(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List installed application
* Similar to listInstalledApplications but it also returns the http response headers .
* Get a list of applications. 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 fields Fields requested in the returned resource (optional)
* @param limit Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests 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/apps?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listInstalledApplicationsWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List installed application
* Get a list of applications. 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 listInstalledApplications 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 ListInstalledApplicationsQueryParams} 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)
* - limit - Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return AppList
*/
@RequestLine("GET /v1/apps?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
AppList listInstalledApplications(@QueryMap(encoded=true) ListInstalledApplicationsQueryParams queryParams);
/**
* List installed application
* Get a list of applications. 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 listInstalledApplications 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)
* - limit - Limit the number of installed applications returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return AppList
*/
@RequestLine("GET /v1/apps?fields={fields}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listInstalledApplicationsWithHttpInfo(@QueryMap(encoded=true) ListInstalledApplicationsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listInstalledApplications method in a fluent style.
*/
public static class ListInstalledApplicationsQueryParams extends HashMap {
public ListInstalledApplicationsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListInstalledApplicationsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListInstalledApplicationsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListInstalledApplicationsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListInstalledApplicationsQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Updates an App by name.
* Update an existing App using JsonPatch.
* @param fqn Name of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates an App by name. Documentation
*/
@RequestLine("PATCH /v1/apps/marketplace/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchApplication(@Param("fqn") String fqn, Object body);
/**
* Updates an App by name.
* Similar to patchApplication but it also returns the http response headers .
* Update an existing App using JsonPatch.
* @param fqn Name of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates an App by name. Documentation
*/
@RequestLine("PATCH /v1/apps/marketplace/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchApplicationWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Updates a App
* Update an existing App using JsonPatch.
* @param id Id of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App Documentation
*/
@RequestLine("PATCH /v1/apps/marketplace/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchApplication1(@Param("id") UUID id, Object body);
/**
* Updates a App
* Similar to patchApplication1 but it also returns the http response headers .
* Update an existing App using JsonPatch.
* @param id Id of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App Documentation
*/
@RequestLine("PATCH /v1/apps/marketplace/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchApplication1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Updates a App by name.
* Update an existing App using JsonPatch.
* @param fqn Name of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App by name. Documentation
*/
@RequestLine("PATCH /v1/apps/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchApplication2(@Param("fqn") String fqn, Object body);
/**
* Updates a App by name.
* Similar to patchApplication2 but it also returns the http response headers .
* Update an existing App using JsonPatch.
* @param fqn Name of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App by name. Documentation
*/
@RequestLine("PATCH /v1/apps/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchApplication2WithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Updates a App
* Update an existing App using JsonPatch.
* @param id Id of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App Documentation
*/
@RequestLine("PATCH /v1/apps/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchApplication3(@Param("id") UUID id, Object body);
/**
* Updates a App
* Similar to patchApplication3 but it also returns the http response headers .
* Update an existing App using JsonPatch.
* @param id Id of the App (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Updates a App Documentation
*/
@RequestLine("PATCH /v1/apps/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchApplication3WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted KPI
* Restore a soft deleted App.
* @param restoreEntity (optional)
* @return AppMarketPlaceDefinition
*/
@RequestLine("PUT /v1/apps/marketplace/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
AppMarketPlaceDefinition restore(RestoreEntity restoreEntity);
/**
* Restore a soft deleted KPI
* Similar to restore but it also returns the http response headers .
* Restore a soft deleted App.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/apps/marketplace/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restoreWithHttpInfo(RestoreEntity restoreEntity);
/**
* Restore a soft deleted KPI
* Restore a soft deleted App.
* @param restoreEntity (optional)
* @return App
*/
@RequestLine("PUT /v1/apps/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
App restore1(RestoreEntity restoreEntity);
/**
* Restore a soft deleted KPI
* Similar to restore1 but it also returns the http response headers .
* Restore a soft deleted App.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/apps/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore1WithHttpInfo(RestoreEntity restoreEntity);
/**
* Schedule an Application
* Schedule a application to be run on demand.
* @param name Name of the App (required)
* @return ConfigureApplication200Response
*/
@RequestLine("POST /v1/apps/schedule/{name}")
@Headers({
"Accept: application/json",
})
ConfigureApplication200Response scheduleApplication(@Param("name") String name);
/**
* Schedule an Application
* Similar to scheduleApplication but it also returns the http response headers .
* Schedule a application to be run on demand.
* @param name Name of the App (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/apps/schedule/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse scheduleApplicationWithHttpInfo(@Param("name") String name);
/**
* Trigger an Application run
* Trigger a Application run by id.
* @param name Name of the App (required)
*/
@RequestLine("POST /v1/apps/trigger/{name}")
@Headers({
"Accept: application/json",
})
void triggerApplicationRun(@Param("name") String name);
/**
* Trigger an Application run
* Similar to triggerApplicationRun but it also returns the http response headers .
* Trigger a Application run by id.
* @param name Name of the App (required)
*/
@RequestLine("POST /v1/apps/trigger/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse triggerApplicationRunWithHttpInfo(@Param("name") String name);
/**
* Delete a App by name
* Delete a App by `name`.
* @param name Name of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void uninstallAppByName(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by name
* Similar to uninstallAppByName but it also returns the http response headers .
* Delete a App by `name`.
* @param name Name of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse uninstallAppByNameWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by name
* Delete a App by `name`.
* Note, this is equivalent to the other uninstallAppByName 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 UninstallAppByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void uninstallAppByName(@Param("name") String name, @QueryMap(encoded=true) UninstallAppByNameQueryParams queryParams);
/**
* Delete a App by name
* Delete a App by `name`.
* Note, this is equivalent to the other uninstallAppByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse uninstallAppByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) UninstallAppByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* uninstallAppByName method in a fluent style.
*/
public static class UninstallAppByNameQueryParams extends HashMap {
public UninstallAppByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a App by Id
* Delete a App by `Id`.
* @param id Id of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void uninstallAppByName1(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by Id
* Similar to uninstallAppByName1 but it also returns the http response headers .
* Delete a App by `Id`.
* @param id Id of the App (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/apps/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse uninstallAppByName1WithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a App by Id
* Delete a App by `Id`.
* Note, this is equivalent to the other uninstallAppByName1 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 UninstallAppByName1QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void uninstallAppByName1(@Param("id") UUID id, @QueryMap(encoded=true) UninstallAppByName1QueryParams queryParams);
/**
* Delete a App by Id
* Delete a App by `Id`.
* Note, this is equivalent to the other uninstallAppByName1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the App (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)
*
*/
@RequestLine("DELETE /v1/apps/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse uninstallAppByName1WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) UninstallAppByName1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* uninstallAppByName1 method in a fluent style.
*/
public static class UninstallAppByName1QueryParams extends HashMap {
public UninstallAppByName1QueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
}