org.openmetadata.client.api.PipelinesApi 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.ChangeEvent;
import org.openmetadata.client.model.CreatePipeline;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.Pipeline;
import org.openmetadata.client.model.PipelineList;
import org.openmetadata.client.model.PipelineStatus;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TestCaseList;
import java.util.UUID;
import org.openmetadata.client.model.VoteRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-08-22T14:05:58.429779152Z[Etc/UTC]")
public interface PipelinesApi extends ApiClient.Api {
/**
* Add a follower
* Add a user identified by `userId` as follower of this pipeline
* @param id Id of the pipeline (required)
* @param body Id of the user to be added as follower (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/pipelines/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent addFollower3(@Param("id") UUID id, String body);
/**
* Add a follower
* Similar to addFollower3 but it also returns the http response headers .
* Add a user identified by `userId` as follower of this pipeline
* @param id Id of the pipeline (required)
* @param body Id of the user to be added as follower (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/pipelines/{id}/followers")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addFollower3WithHttpInfo(@Param("id") UUID id, String body);
/**
* Add status data
* Add status data to the pipeline.
* @param fqn Fully qualified name of the pipeline (required)
* @param pipelineStatus (optional)
* @return Pipeline
*/
@RequestLine("PUT /v1/pipelines/{fqn}/status")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Pipeline addStatusData(@Param("fqn") String fqn, PipelineStatus pipelineStatus);
/**
* Add status data
* Similar to addStatusData but it also returns the http response headers .
* Add status data to the pipeline.
* @param fqn Fully qualified name of the pipeline (required)
* @param pipelineStatus (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/pipelines/{fqn}/status")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addStatusDataWithHttpInfo(@Param("fqn") String fqn, PipelineStatus pipelineStatus);
/**
* Create or update a pipeline
* Create a new pipeline, if it does not exist or update an existing pipeline.
* @param createPipeline (optional)
* @return Pipeline
*/
@RequestLine("PUT /v1/pipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Pipeline createOrUpdatePipeline(CreatePipeline createPipeline);
/**
* Create or update a pipeline
* Similar to createOrUpdatePipeline but it also returns the http response headers .
* Create a new pipeline, if it does not exist or update an existing pipeline.
* @param createPipeline (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/pipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdatePipelineWithHttpInfo(CreatePipeline createPipeline);
/**
* Create a pipeline
* Create a new pipeline.
* @param createPipeline (optional)
* @return Pipeline
*/
@RequestLine("POST /v1/pipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Pipeline createPipeline(CreatePipeline createPipeline);
/**
* Create a pipeline
* Similar to createPipeline but it also returns the http response headers .
* Create a new pipeline.
* @param createPipeline (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/pipelines")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createPipelineWithHttpInfo(CreatePipeline createPipeline);
/**
* Remove a follower
* Remove the user identified `userId` as a follower of the pipeline.
* @param id Id of the pipeline (required)
* @param userId Id of the user being removed as follower (required)
* @return ChangeEvent
*/
@RequestLine("DELETE /v1/pipelines/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
ChangeEvent deleteFollower4(@Param("id") UUID id, @Param("userId") UUID userId);
/**
* Remove a follower
* Similar to deleteFollower4 but it also returns the http response headers .
* Remove the user identified `userId` as a follower of the pipeline.
* @param id Id of the pipeline (required)
* @param userId Id of the user being removed as follower (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/pipelines/{id}/followers/{userId}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteFollower4WithHttpInfo(@Param("id") UUID id, @Param("userId") UUID userId);
/**
* Delete a pipeline by Id
* Delete a pipeline by `Id`.
* @param id Id of the pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/pipelines/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deletePipeline(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a pipeline by Id
* Similar to deletePipeline but it also returns the http response headers .
* Delete a pipeline by `Id`.
* @param id Id of the pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/pipelines/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a pipeline by Id
* Delete a pipeline by `Id`.
* Note, this is equivalent to the other deletePipeline 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 DeletePipelineQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/pipelines/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deletePipeline(@Param("id") UUID id, @QueryMap(encoded=true) DeletePipelineQueryParams queryParams);
/**
* Delete a pipeline by Id
* Delete a pipeline by `Id`.
* Note, this is equivalent to the other deletePipeline that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/pipelines/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeletePipelineQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deletePipeline method in a fluent style.
*/
public static class DeletePipelineQueryParams extends HashMap {
public DeletePipelineQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeletePipelineQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a pipeline by fully qualified name
* Delete a pipeline by `fullyQualifiedName`.
* @param fqn Fully qualified name of the pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/pipelines/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deletePipelineByFQN(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a pipeline by fully qualified name
* Similar to deletePipelineByFQN but it also returns the http response headers .
* Delete a pipeline by `fullyQualifiedName`.
* @param fqn Fully qualified name of the pipeline (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/pipelines/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* Delete a pipeline by fully qualified name
* Delete a pipeline by `fullyQualifiedName`.
* Note, this is equivalent to the other deletePipelineByFQN 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 DeletePipelineByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/pipelines/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deletePipelineByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) DeletePipelineByFQNQueryParams queryParams);
/**
* Delete a pipeline by fully qualified name
* Delete a pipeline by `fullyQualifiedName`.
* Note, this is equivalent to the other deletePipelineByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/pipelines/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeletePipelineByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deletePipelineByFQN method in a fluent style.
*/
public static class DeletePipelineByFQNQueryParams extends HashMap {
public DeletePipelineByFQNQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
public DeletePipelineByFQNQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete pipeline status
* Delete pipeline status for a pipeline.
* @param fqn Fully qualified name of the pipeline (required)
* @param timestamp Timestamp of the pipeline status (required)
* @return Pipeline
*/
@RequestLine("DELETE /v1/pipelines/{fqn}/status/{timestamp}")
@Headers({
"Accept: application/json",
})
Pipeline deletePipelineStatus(@Param("fqn") String fqn, @Param("timestamp") Long timestamp);
/**
* Delete pipeline status
* Similar to deletePipelineStatus but it also returns the http response headers .
* Delete pipeline status for a pipeline.
* @param fqn Fully qualified name of the pipeline (required)
* @param timestamp Timestamp of the pipeline status (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/pipelines/{fqn}/status/{timestamp}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePipelineStatusWithHttpInfo(@Param("fqn") String fqn, @Param("timestamp") Long timestamp);
/**
* Get a pipeline by fully qualified name
* Get a pipeline by fully qualified name.
* @param fqn Fully qualified name of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Pipeline getPipelineByFQN(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a pipeline by fully qualified name
* Similar to getPipelineByFQN but it also returns the http response headers .
* Get a pipeline by fully qualified name.
* @param fqn Fully qualified name of the 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/pipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a pipeline by fully qualified name
* Get a pipeline by fully qualified name.
* Note, this is equivalent to the other getPipelineByFQN 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 GetPipelineByFQNQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Pipeline getPipelineByFQN(@Param("fqn") String fqn, @QueryMap(encoded=true) GetPipelineByFQNQueryParams queryParams);
/**
* Get a pipeline by fully qualified name
* Get a pipeline by fully qualified name.
* Note, this is equivalent to the other getPipelineByFQN that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getPipelineByFQNWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) GetPipelineByFQNQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getPipelineByFQN method in a fluent style.
*/
public static class GetPipelineByFQNQueryParams extends HashMap {
public GetPipelineByFQNQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetPipelineByFQNQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a pipeline by Id
* Get a pipeline by `Id`.
* @param id Id of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Pipeline getPipelineWithID(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a pipeline by Id
* Similar to getPipelineWithID but it also returns the http response headers .
* Get a pipeline by `Id`.
* @param id Id of the 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/pipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getPipelineWithIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a pipeline by Id
* Get a pipeline by `Id`.
* Note, this is equivalent to the other getPipelineWithID 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 GetPipelineWithIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
Pipeline getPipelineWithID(@Param("id") UUID id, @QueryMap(encoded=true) GetPipelineWithIDQueryParams queryParams);
/**
* Get a pipeline by Id
* Get a pipeline by `Id`.
* Note, this is equivalent to the other getPipelineWithID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the 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 Pipeline
*/
@RequestLine("GET /v1/pipelines/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getPipelineWithIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetPipelineWithIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getPipelineWithID method in a fluent style.
*/
public static class GetPipelineWithIDQueryParams extends HashMap {
public GetPipelineWithIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetPipelineWithIDQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the pipeline
* Get a version of the pipeline by given `Id`
* @param id Id of the pipeline (required)
* @param version Pipeline version number in the form `major`.`minor` (required)
* @return Pipeline
*/
@RequestLine("GET /v1/pipelines/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
Pipeline getSpecificPipelineVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the pipeline
* Similar to getSpecificPipelineVersion but it also returns the http response headers .
* Get a version of the pipeline by given `Id`
* @param id Id of the pipeline (required)
* @param version Pipeline version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/pipelines/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificPipelineVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* List pipeline versions
* Get a list of all the versions of a pipeline identified by `Id`
* @param id Id of the pipeline (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/pipelines/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllPipelineVersion(@Param("id") UUID id);
/**
* List pipeline versions
* Similar to listAllPipelineVersion but it also returns the http response headers .
* Get a list of all the versions of a pipeline identified by `Id`
* @param id Id of the pipeline (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/pipelines/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllPipelineVersionWithHttpInfo(@Param("id") UUID id);
/**
* List pipeline status
* Get a list of pipeline status.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 fqn Fully qualified name of the pipeline (required)
* @param startTs Filter pipeline statues after the given start timestamp (required)
* @param endTs Filter pipeline statues before the given end timestamp (required)
* @return TestCaseList
*/
@RequestLine("GET /v1/pipelines/{fqn}/status?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
TestCaseList listPipelineStatuses(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List pipeline status
* Similar to listPipelineStatuses but it also returns the http response headers .
* Get a list of pipeline status.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 fqn Fully qualified name of the pipeline (required)
* @param startTs Filter pipeline statues after the given start timestamp (required)
* @param endTs Filter pipeline statues before the given end timestamp (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/pipelines/{fqn}/status?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelineStatusesWithHttpInfo(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List pipeline status
* Get a list of pipeline status.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 listPipelineStatuses 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 ListPipelineStatusesQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the 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 statues after the given start timestamp (required)
* - endTs - Filter pipeline statues before the given end timestamp (required)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/pipelines/{fqn}/status?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
TestCaseList listPipelineStatuses(@Param("fqn") String fqn, @QueryMap(encoded=true) ListPipelineStatusesQueryParams queryParams);
/**
* List pipeline status
* Get a list of pipeline status.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 listPipelineStatuses that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the 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 statues after the given start timestamp (required)
* - endTs - Filter pipeline statues before the given end timestamp (required)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/pipelines/{fqn}/status?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelineStatusesWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) ListPipelineStatusesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listPipelineStatuses method in a fluent style.
*/
public static class ListPipelineStatusesQueryParams extends HashMap {
public ListPipelineStatusesQueryParams startTs(final BigDecimal value) {
put("startTs", EncodingUtils.encode(value));
return this;
}
public ListPipelineStatusesQueryParams endTs(final BigDecimal value) {
put("endTs", EncodingUtils.encode(value));
return this;
}
}
/**
* List pipelines
* Get a list of pipelines, optionally filtered by `service` it belongs to. 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 pipelines by service name (optional)
* @param limit Limit the number pipelines returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of pipelines before this cursor (optional)
* @param after Returns list of pipelines after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return PipelineList
*/
@RequestLine("GET /v1/pipelines?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
PipelineList listPipelines(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List pipelines
* Similar to listPipelines but it also returns the http response headers .
* Get a list of pipelines, optionally filtered by `service` it belongs to. 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 pipelines by service name (optional)
* @param limit Limit the number pipelines returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of pipelines before this cursor (optional)
* @param after Returns list of pipelines 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/pipelines?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelinesWithHttpInfo(@Param("fields") String fields, @Param("service") String service, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List pipelines
* Get a list of pipelines, optionally filtered by `service` it belongs to. 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 listPipelines 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 ListPipelinesQueryParams} 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 pipelines by service name (optional)
* - limit - Limit the number pipelines returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of pipelines before this cursor (optional)
* - after - Returns list of pipelines after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return PipelineList
*/
@RequestLine("GET /v1/pipelines?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
PipelineList listPipelines(@QueryMap(encoded=true) ListPipelinesQueryParams queryParams);
/**
* List pipelines
* Get a list of pipelines, optionally filtered by `service` it belongs to. 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 listPipelines 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 pipelines by service name (optional)
* - limit - Limit the number pipelines returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of pipelines before this cursor (optional)
* - after - Returns list of pipelines after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return PipelineList
*/
@RequestLine("GET /v1/pipelines?fields={fields}&service={service}&limit={limit}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listPipelinesWithHttpInfo(@QueryMap(encoded=true) ListPipelinesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listPipelines method in a fluent style.
*/
public static class ListPipelinesQueryParams extends HashMap {
public ListPipelinesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListPipelinesQueryParams service(final String value) {
put("service", EncodingUtils.encode(value));
return this;
}
public ListPipelinesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListPipelinesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListPipelinesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListPipelinesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a pipeline by name.
* Update an existing pipeline using JsonPatch.
* @param fqn Name of the pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a pipeline by name. Documentation
*/
@RequestLine("PATCH /v1/pipelines/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchPipeline(@Param("fqn") String fqn, Object body);
/**
* Update a pipeline by name.
* Similar to patchPipeline but it also returns the http response headers .
* Update an existing pipeline using JsonPatch.
* @param fqn Name of the pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a pipeline by name. Documentation
*/
@RequestLine("PATCH /v1/pipelines/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchPipelineWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update a pipeline
* Update an existing pipeline using JsonPatch.
* @param id Id of the pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a pipeline Documentation
*/
@RequestLine("PATCH /v1/pipelines/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchPipeline1(@Param("id") UUID id, Object body);
/**
* Update a pipeline
* Similar to patchPipeline1 but it also returns the http response headers .
* Update an existing pipeline using JsonPatch.
* @param id Id of the pipeline (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a pipeline Documentation
*/
@RequestLine("PATCH /v1/pipelines/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchPipeline1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted pipeline
* Restore a soft deleted pipeline.
* @param restoreEntity (optional)
* @return Pipeline
*/
@RequestLine("PUT /v1/pipelines/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Pipeline restore18(RestoreEntity restoreEntity);
/**
* Restore a soft deleted pipeline
* Similar to restore18 but it also returns the http response headers .
* Restore a soft deleted pipeline.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/pipelines/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore18WithHttpInfo(RestoreEntity restoreEntity);
/**
* Update Vote for a Entity
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return ChangeEvent
*/
@RequestLine("PUT /v1/pipelines/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ChangeEvent updateVoteForEntity11(@Param("id") UUID id, VoteRequest voteRequest);
/**
* Update Vote for a Entity
* Similar to updateVoteForEntity11 but it also returns the http response headers .
* Update vote for a Entity
* @param id Id of the Entity (required)
* @param voteRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/pipelines/{id}/vote")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateVoteForEntity11WithHttpInfo(@Param("id") UUID id, VoteRequest voteRequest);
}