com.spotify.styx.client.StyxWorkflowClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of styx-client Show documentation
There is a newer version: 2.1.179
/*-
 * -\-\-
 * styx-client
 * --
 * Copyright (C) 2016 - 2017 Spotify AB
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -/-/-
 */

package com.spotify.styx.client;

import com.spotify.styx.model.Workflow;
import com.spotify.styx.model.WorkflowConfiguration;
import com.spotify.styx.model.WorkflowState;
import com.spotify.styx.model.WorkflowWithState;
import com.spotify.styx.model.data.WorkflowInstanceExecutionData;
import java.util.List;
import java.util.concurrent.CompletionStage;

/**
 * Interface for Styx client, workflow resources.
 */
public interface StyxWorkflowClient extends AutoCloseable {

  /**
   * Get a {@link Workflow}
   *
   * @param componentId component id
   * @param workflowId  workflow id
   * @return the {@link Workflow}
   */
  CompletionStage workflow(String componentId, String workflowId);

  /**
   * Get all {@link Workflow}s of a component
   *
   * @return all {@link Workflow}s of the given component
   */
  CompletionStage> workflows(String componentId);

  /**
   * Get all {@link Workflow}s
   *
   * @return all {@link Workflow}s
   */
  CompletionStage> workflows();

  /**
   * Create or update a workflow
   *
   * @param componentId    component id
   * @param workflowConfig workflow configuration
   * @return the created {@link Workflow}
   */
  CompletionStage createOrUpdateWorkflow(String componentId,
                                                   WorkflowConfiguration workflowConfig);

  /**
   * Delete a {@link Workflow}
   *
   * @param componentId component id
   * @param workflowId  workflow id
   */
  CompletionStage deleteWorkflow(String componentId, String workflowId);

  /**
   * Get a {@link WorkflowState}
   *
   * @param componentId component id
   * @param workflowId  workflow id
   * @return the {@link WorkflowState}
   */
  CompletionStage workflowState(String componentId, String workflowId);

  /**
   * Get a {@link WorkflowWithState}
   *
   * @param componentId component id
   * @param workflowId  workflow id
   * @return the {@link WorkflowWithState}
   */
  CompletionStage workflowWithState(String componentId, String workflowId);

  /**
   * Get execution data of an instance of a {@link Workflow}
   *
   * @param componentId component id
   * @param workflowId  workflow id
   * @param parameter   parameter
   * @return the {@link WorkflowInstanceExecutionData}
   */
  CompletionStage workflowInstanceExecutions(String componentId,
                                                                            String workflowId,
                                                                            String parameter);

  /**
   * Update {@link WorkflowState}
   *
   * @param componentId   component id
   * @param workflowId    workflow id
   * @param workflowState workflow state
   * @return the updated {@link WorkflowState}
   */
  CompletionStage updateWorkflowState(String componentId,
                                                     String workflowId,
                                                     WorkflowState workflowState);

  @Override
  void close();
}