org.openmetadata.client.api.IngestionPipelinesApi 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 java.math.BigDecimal;
import org.openmetadata.client.model.CreateIngestionPipeline;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.IngestionPipeline;
import org.openmetadata.client.model.PipelineServiceClientResponse;
import org.openmetadata.client.model.PipelineStatus;
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-09-13T20:15:57.513387948Z[Etc/UTC]")
public interface IngestionPipelinesApi extends ApiClient.Api {
/**
* Add pipeline status
* Add pipeline status of ingestion pipeline.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param pipelineStatus (optional)
* @return IngestionPipeline
*/
@RequestLine("PUT /v1/services/ingestionPipelines/{fqn}/pipelineStatus")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
IngestionPipeline addPipelineStatus(@Param("fqn") String fqn, PipelineStatus pipelineStatus);
/**
* Add pipeline status
* Similar to addPipelineStatus but it also returns the http response headers .
* Add pipeline status of ingestion pipeline.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param pipelineStatus (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/ingestionPipelines/{fqn}/pipelineStatus")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addPipelineStatusWithHttpInfo(@Param("fqn") String fqn, PipelineStatus pipelineStatus);
/**
* Bulk deploy a list of Ingestion Pipeline
* Bulk deploy a list of Ingestion Pipelines given a list of IDs
* @param UUID (optional)
* @return PipelineServiceClientResponse
*/
@RequestLine("POST /v1/services/ingestionPipelines/bulk/deploy")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
PipelineServiceClientResponse bulkDeployIngestion(List UUID);
/**
* Bulk deploy a list of Ingestion Pipeline
* Similar to bulkDeployIngestion but it also returns the http response headers .
* Bulk deploy a list of Ingestion Pipelines given a list of IDs
* @param UUID (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines/bulk/deploy")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse bulkDeployIngestionWithHttpInfo(List UUID);
/**
* Check the airflow REST host IP
* Check the Airflow REST host IP
*/
@RequestLine("GET /v1/services/ingestionPipelines/ip")
@Headers({
"Accept: application/json",
})
void checkAirflowHostIp();
/**
* Check the airflow REST host IP
* Similar to checkAirflowHostIp but it also returns the http response headers .
* Check the Airflow REST host IP
*/
@RequestLine("GET /v1/services/ingestionPipelines/ip")
@Headers({
"Accept: application/json",
})
ApiResponse checkAirflowHostIpWithHttpInfo();
/**
* Check the airflow REST status
* Check that the Airflow REST endpoint is reachable and up and running
*/
@RequestLine("GET /v1/services/ingestionPipelines/status")
@Headers({
"Accept: application/json",
})
void checkRestAirflowStatus();
/**
* Check the airflow REST status
* Similar to checkRestAirflowStatus but it also returns the http response headers .
* Check that the Airflow REST endpoint is reachable and up and running
*/
@RequestLine("GET /v1/services/ingestionPipelines/status")
@Headers({
"Accept: application/json",
})
ApiResponse checkRestAirflowStatusWithHttpInfo();
/**
* Create an ingestion pipeline
* Create a new ingestion pipeline.
* @param createIngestionPipeline (optional)
* @return IngestionPipeline
*/
@RequestLine("POST /v1/services/ingestionPipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
IngestionPipeline createIngestionPipeline(CreateIngestionPipeline createIngestionPipeline);
/**
* Create an ingestion pipeline
* Similar to createIngestionPipeline but it also returns the http response headers .
* Create a new ingestion pipeline.
* @param createIngestionPipeline (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createIngestionPipelineWithHttpInfo(CreateIngestionPipeline createIngestionPipeline);
/**
* Create or update an ingestion pipeline
* Create a new ingestion pipeline, if it does not exist or update an existing ingestion pipeline.
* @param createIngestionPipeline (optional)
* @return IngestionPipeline
*/
@RequestLine("PUT /v1/services/ingestionPipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
IngestionPipeline createOrUpdateIngestionPipeline(CreateIngestionPipeline createIngestionPipeline);
/**
* Create or update an ingestion pipeline
* Similar to createOrUpdateIngestionPipeline but it also returns the http response headers .
* Create a new ingestion pipeline, if it does not exist or update an existing ingestion pipeline.
* @param createIngestionPipeline (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/ingestionPipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateIngestionPipelineWithHttpInfo(CreateIngestionPipeline createIngestionPipeline);
/**
* Delete an ingestion pipeline by Id
* Delete an ingestion pipeline by `Id`.
* @param id Id of the ingestion pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteIngestionPipeline(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete an ingestion pipeline by Id
* Similar to deleteIngestionPipeline but it also returns the http response headers .
* Delete an ingestion pipeline by `Id`.
* @param id Id of the ingestion pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteIngestionPipelineWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete an ingestion pipeline by Id
* Delete an ingestion pipeline by `Id`.
* Note, this is equivalent to the other deleteIngestionPipeline 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 DeleteIngestionPipelineQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the ingestion pipeline (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/services/ingestionPipelines/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteIngestionPipeline(@Param("id") UUID id, @QueryMap(encoded=true) DeleteIngestionPipelineQueryParams queryParams);
/**
* Delete an ingestion pipeline by Id
* Delete an ingestion pipeline by `Id`.
* Note, this is equivalent to the other deleteIngestionPipeline that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the ingestion pipeline (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/services/ingestionPipelines/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteIngestionPipelineWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteIngestionPipelineQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteIngestionPipeline method in a fluent style.
*/
public static class DeleteIngestionPipelineQueryParams extends HashMap {
public DeleteIngestionPipelineQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete an ingestion pipeline by fully qualified name
* Delete an ingestion pipeline by `fullyQualifiedName`.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteIngestionPipelineByFQN(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete);
/**
* Delete an ingestion pipeline by fully qualified name
* Similar to deleteIngestionPipelineByFQN but it also returns the http response headers .
* Delete an ingestion pipeline by `fullyQualifiedName`.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteIngestionPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete);
/**
* Delete an ingestion pipeline by fully qualified name
* Delete an ingestion pipeline by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteIngestionPipelineByFQN 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 DeleteIngestionPipelineByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the ingestion pipeline (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/services/ingestionPipelines/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteIngestionPipelineByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteIngestionPipelineByFQNQueryParams queryParams);
/**
* Delete an ingestion pipeline by fully qualified name
* Delete an ingestion pipeline by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteIngestionPipelineByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the ingestion pipeline (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/services/ingestionPipelines/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteIngestionPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteIngestionPipelineByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteIngestionPipelineByFQN method in a fluent style.
*/
public static class DeleteIngestionPipelineByFQNQueryParams extends HashMap {
public DeleteIngestionPipelineByFQNQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete Pipeline Status
* Delete the Pipeline Status for this Ingestion Pipeline.
* @param id Id of the Ingestion Pipeline (required)
* @return IngestionPipeline
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}/pipelineStatus")
@Headers({
"Accept: application/json",
})
IngestionPipeline deletePipelineStatus(@Param("id") UUID id);
/**
* Delete Pipeline Status
* Similar to deletePipelineStatus but it also returns the http response headers .
* Delete the Pipeline Status for this Ingestion Pipeline.
* @param id Id of the Ingestion Pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}/pipelineStatus")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineStatusWithHttpInfo(@Param("id") UUID id);
/**
* Delete Pipeline Status
* Delete the Pipeline Status for this Ingestion Pipeline.
* @param id Id of the Ingestion Pipeline (required)
* @return IngestionPipeline
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}/pipelineStatus")
@Headers({
"Accept: application/json",
})
IngestionPipeline deletePipelineStatus_1(@Param("id") UUID id);
/**
* Delete Pipeline Status
* Similar to deletePipelineStatus_0 but it also returns the http response headers .
* Delete the Pipeline Status for this Ingestion Pipeline.
* @param id Id of the Ingestion Pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/services/ingestionPipelines/{id}/pipelineStatus")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineStatus_1WithHttpInfo(@Param("id") UUID id);
/**
* Deploy an ingestion pipeline run
* Deploy a ingestion pipeline run by Id.
* @param id Id of the ingestion pipeline (required)
* @return PipelineServiceClientResponse
*/
@RequestLine("POST /v1/services/ingestionPipelines/deploy/{id}")
@Headers({
"Accept: application/json",
})
PipelineServiceClientResponse deployIngestion(@Param("id") UUID id);
/**
* Deploy an ingestion pipeline run
* Similar to deployIngestion but it also returns the http response headers .
* Deploy a ingestion pipeline run by Id.
* @param id Id of the ingestion pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines/deploy/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deployIngestionWithHttpInfo(@Param("id") UUID id);
/**
* Get an ingestion pipeline by Id
* Get an ingestion pipeline by `Id`.
* @param id Id of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getIngestionPipelineByID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get an ingestion pipeline by Id
* Similar to getIngestionPipelineByID but it also returns the http response headers .
* Get an ingestion pipeline by `Id`.
* @param id Id of the ingestion pipeline (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/ingestionPipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getIngestionPipelineByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get an ingestion pipeline by Id
* Get an ingestion pipeline by `Id`.
* Note, this is equivalent to the other getIngestionPipelineByID 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 GetIngestionPipelineByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getIngestionPipelineByID(@Param("id") UUID id, @QueryMap(encoded=true) GetIngestionPipelineByIDQueryParams queryParams);
/**
* Get an ingestion pipeline by Id
* Get an ingestion pipeline by `Id`.
* Note, this is equivalent to the other getIngestionPipelineByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getIngestionPipelineByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetIngestionPipelineByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getIngestionPipelineByID method in a fluent style.
*/
public static class GetIngestionPipelineByIDQueryParams extends HashMap {
public GetIngestionPipelineByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetIngestionPipelineByIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Retrieve all logs from last ingestion pipeline run
* Get all logs from last ingestion pipeline run by `Id`.
* @param id Id of the ingestion pipeline (required)
* @param after Returns log chunk after this cursor (optional)
*/
@RequestLine("GET /v1/services/ingestionPipelines/logs/{id}/last?after={after}")
@Headers({
"Accept: application/json",
})
void getLastIngestionLogs(@Param("id") UUID id, @Param("after") String after);
/**
* Retrieve all logs from last ingestion pipeline run
* Similar to getLastIngestionLogs but it also returns the http response headers .
* Get all logs from last ingestion pipeline run by `Id`.
* @param id Id of the ingestion pipeline (required)
* @param after Returns log chunk after this cursor (optional)
*/
@RequestLine("GET /v1/services/ingestionPipelines/logs/{id}/last?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse getLastIngestionLogsWithHttpInfo(@Param("id") UUID id, @Param("after") String after);
/**
* Retrieve all logs from last ingestion pipeline run
* Get all logs from last ingestion pipeline run by `Id`.
* Note, this is equivalent to the other getLastIngestionLogs 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 GetLastIngestionLogsQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the ingestion pipeline (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)
*
*/
@RequestLine("GET /v1/services/ingestionPipelines/logs/{id}/last?after={after}")
@Headers({
"Accept: application/json",
})
void getLastIngestionLogs(@Param("id") UUID id, @QueryMap(encoded=true) GetLastIngestionLogsQueryParams queryParams);
/**
* Retrieve all logs from last ingestion pipeline run
* Get all logs from last ingestion pipeline run by `Id`.
* Note, this is equivalent to the other getLastIngestionLogs that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the ingestion pipeline (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)
*
*/
@RequestLine("GET /v1/services/ingestionPipelines/logs/{id}/last?after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse getLastIngestionLogsWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetLastIngestionLogsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getLastIngestionLogs method in a fluent style.
*/
public static class GetLastIngestionLogsQueryParams extends HashMap {
public GetLastIngestionLogsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* Get pipeline status
* Get pipeline status of ingestion pipeline
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param id Id of pipeline status run (required)
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{fqn}/pipelineStatus/{id}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getPipelineStatus(@Param("fqn") String fqn, @Param("id") String id);
/**
* Get pipeline status
* Similar to getPipelineStatus but it also returns the http response headers .
* Get pipeline status of ingestion pipeline
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param id Id of pipeline status run (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/ingestionPipelines/{fqn}/pipelineStatus/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getPipelineStatusWithHttpInfo(@Param("fqn") String fqn, @Param("id") String id);
/**
* Get an ingestion pipeline by fully qualified name
* Get an ingestion by fully qualified name.
* @param fqn Fully qualified name of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getSpecificIngestionPipelineByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get an ingestion pipeline by fully qualified name
* Similar to getSpecificIngestionPipelineByFQN but it also returns the http response headers .
* Get an ingestion by fully qualified name.
* @param fqn Fully qualified name of the ingestion pipeline (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/ingestionPipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificIngestionPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get an ingestion pipeline by fully qualified name
* Get an ingestion by fully qualified name.
* Note, this is equivalent to the other getSpecificIngestionPipelineByFQN 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 GetSpecificIngestionPipelineByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getSpecificIngestionPipelineByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetSpecificIngestionPipelineByFQNQueryParams queryParams);
/**
* Get an ingestion pipeline by fully qualified name
* Get an ingestion by fully qualified name.
* Note, this is equivalent to the other getSpecificIngestionPipelineByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the ingestion pipeline (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 IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificIngestionPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetSpecificIngestionPipelineByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getSpecificIngestionPipelineByFQN method in a fluent style.
*/
public static class GetSpecificIngestionPipelineByFQNQueryParams extends HashMap {
public GetSpecificIngestionPipelineByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetSpecificIngestionPipelineByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the ingestion pipeline
* Get a version of the ingestion pipeline by given `Id`
* @param id Id of the ingestion pipeline (required)
* @param version Ingestion version number in the form `major`.`minor` (required)
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
IngestionPipeline getSpecificIngestionPipelineVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the ingestion pipeline
* Similar to getSpecificIngestionPipelineVersion but it also returns the http response headers .
* Get a version of the ingestion pipeline by given `Id`
* @param id Id of the ingestion pipeline (required)
* @param version Ingestion version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificIngestionPipelineVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Mark as failed and kill any not-finished workflow or task for the ingestion pipeline
* Kill an ingestion pipeline by Id.
* @param id Id of the ingestion pipeline (required)
* @return PipelineServiceClientResponse
*/
@RequestLine("POST /v1/services/ingestionPipelines/kill/{id}")
@Headers({
"Accept: application/json",
})
PipelineServiceClientResponse killIngestionPipelineRuns(@Param("id") UUID id);
/**
* Mark as failed and kill any not-finished workflow or task for the ingestion pipeline
* Similar to killIngestionPipelineRuns but it also returns the http response headers .
* Kill an ingestion pipeline by Id.
* @param id Id of the ingestion pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines/kill/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse killIngestionPipelineRunsWithHttpInfo(@Param("id") UUID id);
/**
* List ingestion workflow versions
* Get a list of all the versions of a ingestion pipeline identified by `Id`
* @param id Id of the ingestion pipeline (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllIngestionPipelineVersion(@Param("id") UUID id);
/**
* List ingestion workflow versions
* Similar to listAllIngestionPipelineVersion but it also returns the http response headers .
* Get a list of all the versions of a ingestion pipeline identified by `Id`
* @param id Id of the ingestion pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/services/ingestionPipelines/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllIngestionPipelineVersionWithHttpInfo(@Param("id") UUID id);
/**
* List ingestion pipelines for metadata operations
* Get a list of airflow pipelines for metadata operations. 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 service Filter Ingestion Pipelines by service fully qualified name (optional)
* @param testSuite Filter Ingestion Pipelines by test suite fully qualified name (optional)
* @param pipelineType Filter Ingestion Pipelines by pipeline Type (optional)
* @param serviceType Filter Ingestion Pipelines by service Type (optional)
* @param applicationType Filter Ingestion Pipelines by the type of the application (optional)
* @param limit Limit the number ingestion returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of ingestion before this cursor (optional)
* @param after Returns list of ingestion after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines?fields={fields}&service={service}&testSuite={testSuite}&pipelineType={pipelineType}&serviceType={serviceType}&applicationType={applicationType}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline listIngestionPipelines(@Param("fields") String fields, @Param("service") String service, @Param("testSuite") String testSuite, @Param("pipelineType") String pipelineType, @Param("serviceType") String serviceType, @Param("applicationType") String applicationType, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List ingestion pipelines for metadata operations
* Similar to listIngestionPipelines but it also returns the http response headers .
* Get a list of airflow pipelines for metadata operations. 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 service Filter Ingestion Pipelines by service fully qualified name (optional)
* @param testSuite Filter Ingestion Pipelines by test suite fully qualified name (optional)
* @param pipelineType Filter Ingestion Pipelines by pipeline Type (optional)
* @param serviceType Filter Ingestion Pipelines by service Type (optional)
* @param applicationType Filter Ingestion Pipelines by the type of the application (optional)
* @param limit Limit the number ingestion returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of ingestion before this cursor (optional)
* @param after Returns list of ingestion 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/ingestionPipelines?fields={fields}&service={service}&testSuite={testSuite}&pipelineType={pipelineType}&serviceType={serviceType}&applicationType={applicationType}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listIngestionPipelinesWithHttpInfo(@Param("fields") String fields, @Param("service") String service, @Param("testSuite") String testSuite, @Param("pipelineType") String pipelineType, @Param("serviceType") String serviceType, @Param("applicationType") String applicationType, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List ingestion pipelines for metadata operations
* Get a list of airflow pipelines for metadata operations. 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 listIngestionPipelines 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 ListIngestionPipelinesQueryParams} 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)
* - service - Filter Ingestion Pipelines by service fully qualified name (optional)
* - testSuite - Filter Ingestion Pipelines by test suite fully qualified name (optional)
* - pipelineType - Filter Ingestion Pipelines by pipeline Type (optional)
* - serviceType - Filter Ingestion Pipelines by service Type (optional)
* - applicationType - Filter Ingestion Pipelines by the type of the application (optional)
* - limit - Limit the number ingestion returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of ingestion before this cursor (optional)
* - after - Returns list of ingestion after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines?fields={fields}&service={service}&testSuite={testSuite}&pipelineType={pipelineType}&serviceType={serviceType}&applicationType={applicationType}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
IngestionPipeline listIngestionPipelines(@QueryMap(encoded=true) ListIngestionPipelinesQueryParams queryParams);
/**
* List ingestion pipelines for metadata operations
* Get a list of airflow pipelines for metadata operations. 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 listIngestionPipelines 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)
* - service - Filter Ingestion Pipelines by service fully qualified name (optional)
* - testSuite - Filter Ingestion Pipelines by test suite fully qualified name (optional)
* - pipelineType - Filter Ingestion Pipelines by pipeline Type (optional)
* - serviceType - Filter Ingestion Pipelines by service Type (optional)
* - applicationType - Filter Ingestion Pipelines by the type of the application (optional)
* - limit - Limit the number ingestion returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of ingestion before this cursor (optional)
* - after - Returns list of ingestion after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines?fields={fields}&service={service}&testSuite={testSuite}&pipelineType={pipelineType}&serviceType={serviceType}&applicationType={applicationType}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listIngestionPipelinesWithHttpInfo(@QueryMap(encoded=true) ListIngestionPipelinesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listIngestionPipelines method in a fluent style.
*/
public static class ListIngestionPipelinesQueryParams extends HashMap {
public ListIngestionPipelinesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams service(final String value) {
put("service", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams testSuite(final String value) {
put("testSuite", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams pipelineType(final String value) {
put("pipelineType", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams serviceType(final String value) {
put("serviceType", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams applicationType(final String value) {
put("applicationType", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListIngestionPipelinesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List of pipeline status
* Get a list of all the pipeline status for the given ingestion pipeline id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param startTs Filter pipeline status after the given start timestamp (optional)
* @param endTs Filter pipeline status before the given end timestamp (optional)
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{fqn}/pipelineStatus?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
IngestionPipeline listPipelineStatuses1(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List of pipeline status
* Similar to listPipelineStatuses1 but it also returns the http response headers .
* Get a list of all the pipeline status for the given ingestion pipeline id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @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/services/ingestionPipelines/{fqn}/pipelineStatus?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelineStatuses1WithHttpInfo(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List of pipeline status
* Get a list of all the pipeline status for the given ingestion pipeline id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listPipelineStatuses1 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 ListPipelineStatuses1QueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - startTs - Filter pipeline status after the given start timestamp (optional)
* - endTs - Filter pipeline status before the given end timestamp (optional)
*
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{fqn}/pipelineStatus?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
IngestionPipeline listPipelineStatuses1(@Param("fqn") String fqn, @QueryMap(encoded=true) ListPipelineStatuses1QueryParams queryParams);
/**
* List of pipeline status
* Get a list of all the pipeline status for the given ingestion pipeline id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listPipelineStatuses1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the ingestion pipeline (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - startTs - Filter pipeline status after the given start timestamp (optional)
* - endTs - Filter pipeline status before the given end timestamp (optional)
*
* @return IngestionPipeline
*/
@RequestLine("GET /v1/services/ingestionPipelines/{fqn}/pipelineStatus?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelineStatuses1WithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) ListPipelineStatuses1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listPipelineStatuses1 method in a fluent style.
*/
public static class ListPipelineStatuses1QueryParams extends HashMap {
public ListPipelineStatuses1QueryParams startTs(final BigDecimal value) {
put("startTs", EncodingUtils.encode(value));
return this;
}
public ListPipelineStatuses1QueryParams endTs(final BigDecimal value) {
put("endTs", EncodingUtils.encode(value));
return this;
}
}
/**
* Update an ingestion pipeline using name.
* Update an existing ingestion pipeline using JsonPatch.
* @param fqn Name of the ingestion pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an ingestion pipeline using name. Documentation
*/
@RequestLine("PATCH /v1/services/ingestionPipelines/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchIngestionPipeline(@Param("fqn") String fqn, Object body);
/**
* Update an ingestion pipeline using name.
* Similar to patchIngestionPipeline but it also returns the http response headers .
* Update an existing ingestion pipeline using JsonPatch.
* @param fqn Name of the ingestion pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an ingestion pipeline using name. Documentation
*/
@RequestLine("PATCH /v1/services/ingestionPipelines/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchIngestionPipelineWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update an ingestion pipeline
* Update an existing ingestion pipeline using JsonPatch.
* @param id Id of the ingestion pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an ingestion pipeline Documentation
*/
@RequestLine("PATCH /v1/services/ingestionPipelines/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchIngestionPipeline1(@Param("id") UUID id, Object body);
/**
* Update an ingestion pipeline
* Similar to patchIngestionPipeline1 but it also returns the http response headers .
* Update an existing ingestion pipeline using JsonPatch.
* @param id Id of the ingestion pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an ingestion pipeline Documentation
*/
@RequestLine("PATCH /v1/services/ingestionPipelines/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchIngestionPipeline1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted ingestion pipeline
* Restore a soft deleted ingestion pipeline.
* @param restoreEntity (optional)
* @return IngestionPipeline
*/
@RequestLine("PUT /v1/services/ingestionPipelines/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
IngestionPipeline restore25(RestoreEntity restoreEntity);
/**
* Restore a soft deleted ingestion pipeline
* Similar to restore25 but it also returns the http response headers .
* Restore a soft deleted ingestion pipeline.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/services/ingestionPipelines/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore25WithHttpInfo(RestoreEntity restoreEntity);
/**
* Set an ingestion pipeline either as enabled or disabled
* Toggle an ingestion pipeline state by Id.
* @param id Id of the ingestion pipeline (required)
* @return IngestionPipeline
*/
@RequestLine("POST /v1/services/ingestionPipelines/toggleIngestion/{id}")
@Headers({
"Accept: application/json",
})
IngestionPipeline toggleIngestionPipelineEnabled(@Param("id") UUID id);
/**
* Set an ingestion pipeline either as enabled or disabled
* Similar to toggleIngestionPipelineEnabled but it also returns the http response headers .
* Toggle an ingestion pipeline state by Id.
* @param id Id of the ingestion pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines/toggleIngestion/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse toggleIngestionPipelineEnabledWithHttpInfo(@Param("id") UUID id);
/**
* Trigger an ingestion pipeline run
* Trigger a ingestion pipeline run by id.
* @param id Id of the ingestion pipeline (required)
* @return PipelineServiceClientResponse
*/
@RequestLine("POST /v1/services/ingestionPipelines/trigger/{id}")
@Headers({
"Accept: application/json",
})
PipelineServiceClientResponse triggerIngestionPipelineRun(@Param("id") UUID id);
/**
* Trigger an ingestion pipeline run
* Similar to triggerIngestionPipelineRun but it also returns the http response headers .
* Trigger a ingestion pipeline run by id.
* @param id Id of the ingestion pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/services/ingestionPipelines/trigger/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse triggerIngestionPipelineRunWithHttpInfo(@Param("id") UUID id);
}