org.openmetadata.client.api.WorkflowInstanceStatesApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-java-client Show documentation
There is a newer version: 1.6.1
Show newest version
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 java.util.UUID;
import org.openmetadata.client.model.WorkflowInstanceState;
import org.openmetadata.client.model.WorkflowInstanceStateResultList;

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-11-20T14:35:21.920766473Z[Etc/UTC]")
public interface WorkflowInstanceStatesApi extends ApiClient.Api {


  /**
   * Get a Workflow Instance State by id
   * Get a Workflow Instance State by id
   * @param id Workflow Instance State ID (required)
   * @return WorkflowInstanceState
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates/{id}")
  @Headers({
    "Accept: application/json",
  })
  WorkflowInstanceState getWorkflowInstanceStateById(@Param("id") UUID id);

  /**
   * Get a Workflow Instance State by id
   * Similar to getWorkflowInstanceStateById but it also returns the http response headers .
   * Get a Workflow Instance State by id
   * @param id Workflow Instance State ID (required)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates/{id}")
  @Headers({
    "Accept: application/json",
  })
  ApiResponse getWorkflowInstanceStateByIdWithHttpInfo(@Param("id") UUID id);



  /**
   * Get all the Workflow Instance States for a Workflow Instance id
   * Get all the Workflow Instance States for a Workflow Instancee id
   * @param workflowDefinitionName Workflow Definition Name (required)
   * @param workflowInstanceId Workflow Instance ID (required)
   * @param limit Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   * @param offset Returns list of Workflow Instance States at the offset (optional)
   * @param startTs Filter Workflow Instance States after the given start timestamp (optional)
   * @param endTs Filter Workflow Instance States before the given end timestamp (optional)
   * @param latest Only list the latest Workflow Instance States (optional, default to false)
   * @return WorkflowInstanceStateResultList
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates/{workflowDefinitionName}/{workflowInstanceId}?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
    "Accept: application/json",
  })
  WorkflowInstanceStateResultList getWorkflowInstanceStatesForAWorkflowInstanceId(@Param("workflowDefinitionName") String workflowDefinitionName, @Param("workflowInstanceId") UUID workflowInstanceId, @Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("latest") Boolean latest);

  /**
   * Get all the Workflow Instance States for a Workflow Instance id
   * Similar to getWorkflowInstanceStatesForAWorkflowInstanceId but it also returns the http response headers .
   * Get all the Workflow Instance States for a Workflow Instancee id
   * @param workflowDefinitionName Workflow Definition Name (required)
   * @param workflowInstanceId Workflow Instance ID (required)
   * @param limit Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   * @param offset Returns list of Workflow Instance States at the offset (optional)
   * @param startTs Filter Workflow Instance States after the given start timestamp (optional)
   * @param endTs Filter Workflow Instance States before the given end timestamp (optional)
   * @param latest Only list the latest Workflow Instance States (optional, default to false)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates/{workflowDefinitionName}/{workflowInstanceId}?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
    "Accept: application/json",
  })
  ApiResponse getWorkflowInstanceStatesForAWorkflowInstanceIdWithHttpInfo(@Param("workflowDefinitionName") String workflowDefinitionName, @Param("workflowInstanceId") UUID workflowInstanceId, @Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("latest") Boolean latest);


  /**
   * Get all the Workflow Instance States for a Workflow Instance id
   * Get all the Workflow Instance States for a Workflow Instancee id
   * Note, this is equivalent to the other getWorkflowInstanceStatesForAWorkflowInstanceId 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 GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams} class that allows for
   * building up this map in a fluent style.
   * @param workflowDefinitionName Workflow Definition Name (required)
   * @param workflowInstanceId Workflow Instance ID (required)
   * @param queryParams Map of query parameters as name-value pairs
   *   The following elements may be specified in the query map:
   *   
   *   limit - Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   *   offset - Returns list of Workflow Instance States at the offset (optional)
   *   startTs - Filter Workflow Instance States after the given start timestamp (optional)
   *   endTs - Filter Workflow Instance States before the given end timestamp (optional)
   *   latest - Only list the latest Workflow Instance States (optional, default to false)
   *   
   * @return WorkflowInstanceStateResultList
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates/{workflowDefinitionName}/{workflowInstanceId}?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
  "Accept: application/json",
  })
  WorkflowInstanceStateResultList getWorkflowInstanceStatesForAWorkflowInstanceId(@Param("workflowDefinitionName") String workflowDefinitionName, @Param("workflowInstanceId") UUID workflowInstanceId, @QueryMap(encoded=true) GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams queryParams);

  /**
  * Get all the Workflow Instance States for a Workflow Instance id
  * Get all the Workflow Instance States for a Workflow Instancee id
  * Note, this is equivalent to the other getWorkflowInstanceStatesForAWorkflowInstanceId that receives the query parameters as a map,
  * but this one also exposes the Http response headers
              * @param workflowDefinitionName Workflow Definition Name (required)
              * @param workflowInstanceId Workflow Instance ID (required)
      * @param queryParams Map of query parameters as name-value pairs
      *   The following elements may be specified in the query map:
      *   
          *   limit - Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
          *   offset - Returns list of Workflow Instance States at the offset (optional)
          *   startTs - Filter Workflow Instance States after the given start timestamp (optional)
          *   endTs - Filter Workflow Instance States before the given end timestamp (optional)
          *   latest - Only list the latest Workflow Instance States (optional, default to false)
      *   
          * @return WorkflowInstanceStateResultList
      */
      @RequestLine("GET /v1/governance/workflowInstanceStates/{workflowDefinitionName}/{workflowInstanceId}?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
      @Headers({
    "Accept: application/json",
      })
   ApiResponse getWorkflowInstanceStatesForAWorkflowInstanceIdWithHttpInfo(@Param("workflowDefinitionName") String workflowDefinitionName, @Param("workflowInstanceId") UUID workflowInstanceId, @QueryMap(encoded=true) GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams queryParams);


   /**
   * A convenience class for generating query parameters for the
   * getWorkflowInstanceStatesForAWorkflowInstanceId method in a fluent style.
   */
  public static class GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams extends HashMap {
    public GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams limit(final Integer value) {
      put("limit", EncodingUtils.encode(value));
      return this;
    }
    public GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams offset(final String value) {
      put("offset", EncodingUtils.encode(value));
      return this;
    }
    public GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams startTs(final BigDecimal value) {
      put("startTs", EncodingUtils.encode(value));
      return this;
    }
    public GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams endTs(final BigDecimal value) {
      put("endTs", EncodingUtils.encode(value));
      return this;
    }
    public GetWorkflowInstanceStatesForAWorkflowInstanceIdQueryParams latest(final Boolean value) {
      put("latest", EncodingUtils.encode(value));
      return this;
    }
  }

  /**
   * List the Workflow Instance States
   * Get a list of all the workflow instances states, filtered by `startTs` and `endTs` of the creation. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
   * @param limit Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   * @param offset Returns list of Workflow Instance States at the offset (optional)
   * @param startTs Filter Workflow Instance States after the given start timestamp (optional)
   * @param endTs Filter Workflow Instance States before the given end timestamp (optional)
   * @param latest Only list the latest Workflow Instance States (optional, default to false)
   * @return WorkflowInstanceStateResultList
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
    "Accept: application/json",
  })
  WorkflowInstanceStateResultList listWorkflowInstanceStates(@Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("latest") Boolean latest);

  /**
   * List the Workflow Instance States
   * Similar to listWorkflowInstanceStates but it also returns the http response headers .
   * Get a list of all the workflow instances states, filtered by `startTs` and `endTs` of the creation. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
   * @param limit Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   * @param offset Returns list of Workflow Instance States at the offset (optional)
   * @param startTs Filter Workflow Instance States after the given start timestamp (optional)
   * @param endTs Filter Workflow Instance States before the given end timestamp (optional)
   * @param latest Only list the latest Workflow Instance States (optional, default to false)
   * @return A ApiResponse that wraps the response boyd and the http headers.
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
    "Accept: application/json",
  })
  ApiResponse listWorkflowInstanceStatesWithHttpInfo(@Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("latest") Boolean latest);


  /**
   * List the Workflow Instance States
   * Get a list of all the workflow instances states, filtered by `startTs` and `endTs` of the creation. 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 listWorkflowInstanceStates 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 ListWorkflowInstanceStatesQueryParams} 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:
   *   
   *   limit - Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
   *   offset - Returns list of Workflow Instance States at the offset (optional)
   *   startTs - Filter Workflow Instance States after the given start timestamp (optional)
   *   endTs - Filter Workflow Instance States before the given end timestamp (optional)
   *   latest - Only list the latest Workflow Instance States (optional, default to false)
   *   
   * @return WorkflowInstanceStateResultList
   */
  @RequestLine("GET /v1/governance/workflowInstanceStates?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
  @Headers({
  "Accept: application/json",
  })
  WorkflowInstanceStateResultList listWorkflowInstanceStates(@QueryMap(encoded=true) ListWorkflowInstanceStatesQueryParams queryParams);

  /**
  * List the Workflow Instance States
  * Get a list of all the workflow instances states, filtered by `startTs` and `endTs` of the creation. 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 listWorkflowInstanceStates 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:
      *   
          *   limit - Limit the number of Workflow Instance States returned. (1 to 1000000, default = 10) (optional, default to 10)
          *   offset - Returns list of Workflow Instance States at the offset (optional)
          *   startTs - Filter Workflow Instance States after the given start timestamp (optional)
          *   endTs - Filter Workflow Instance States before the given end timestamp (optional)
          *   latest - Only list the latest Workflow Instance States (optional, default to false)
      *   
          * @return WorkflowInstanceStateResultList
      */
      @RequestLine("GET /v1/governance/workflowInstanceStates?limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&latest={latest}")
      @Headers({
    "Accept: application/json",
      })
   ApiResponse listWorkflowInstanceStatesWithHttpInfo(@QueryMap(encoded=true) ListWorkflowInstanceStatesQueryParams queryParams);


   /**
   * A convenience class for generating query parameters for the
   * listWorkflowInstanceStates method in a fluent style.
   */
  public static class ListWorkflowInstanceStatesQueryParams extends HashMap {
    public ListWorkflowInstanceStatesQueryParams limit(final Integer value) {
      put("limit", EncodingUtils.encode(value));
      return this;
    }
    public ListWorkflowInstanceStatesQueryParams offset(final String value) {
      put("offset", EncodingUtils.encode(value));
      return this;
    }
    public ListWorkflowInstanceStatesQueryParams startTs(final BigDecimal value) {
      put("startTs", EncodingUtils.encode(value));
      return this;
    }
    public ListWorkflowInstanceStatesQueryParams endTs(final BigDecimal value) {
      put("endTs", EncodingUtils.encode(value));
      return this;
    }
    public ListWorkflowInstanceStatesQueryParams latest(final Boolean value) {
      put("latest", EncodingUtils.encode(value));
      return this;
    }
  }
}