com.spotify.styx.client.StyxSchedulerClient Maven / Gradle / Ivy
/*-
* -\-\-
* 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.TriggerParameters;
import com.spotify.styx.model.WorkflowInstance;
import java.util.concurrent.CompletionStage;
/**
* Interface for Styx client, scheduler resources.
*/
public interface StyxSchedulerClient extends AutoCloseable {
/**
* Trigger a {@link WorkflowInstance}
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
*/
CompletionStage triggerWorkflowInstance(String componentId,
String workflowId,
String parameter);
/**
* Trigger a {@link WorkflowInstance}
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
* @param triggerParameters additional parameters for the {@link WorkflowInstance}
*/
CompletionStage triggerWorkflowInstance(String componentId,
String workflowId,
String parameter,
TriggerParameters triggerParameters);
/**
* Trigger a {@link WorkflowInstance}
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
* @param triggerParameters additional parameters for the {@link WorkflowInstance}
* @param allowFuture allow triggering future partition
*/
CompletionStage triggerWorkflowInstance(String componentId,
String workflowId,
String parameter,
TriggerParameters triggerParameters,
boolean allowFuture);
/**
* Halt a {@link WorkflowInstance}
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
*/
CompletionStage haltWorkflowInstance(String componentId,
String workflowId,
String parameter);
/**
* Retry a {@link WorkflowInstance}
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
*/
CompletionStage retryWorkflowInstance(String componentId,
String workflowId,
String parameter);
@Override
void close();
}