com.spotify.styx.client.StyxStatusClient 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.api.RunStateDataPayload;
import com.spotify.styx.api.TestServiceAccountUsageAuthorizationResponse;
import com.spotify.styx.model.Event;
import com.spotify.styx.model.WorkflowInstance;
import com.spotify.styx.model.data.EventInfo;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletionStage;
/**
* Interface for Styx client, status resources.
*/
public interface StyxStatusClient extends AutoCloseable {
/**
* Get information about the active states (workflow instances)
*
* @param componentId component id to filter on
* @return The information about the active states
*/
CompletionStage activeStates(Optional componentId);
/**
* Get {@link EventInfo}s for a {@link WorkflowInstance}. If an unrecognized {@link Event} is
* received, possibly because of version difference between client and server, a best effort
* attempt is performed to construct the {@link EventInfo} with basic information for the
* received {@link Event}, i.e the event name and event timestamp.
*
* @param componentId component id
* @param workflowId workflow id
* @param parameter parameter
*
* @return The list of {@link EventInfo}s for the selected {@link WorkflowInstance}
*/
CompletionStage> eventsForWorkflowInstance(String componentId,
String workflowId,
String parameter);
/**
* Test if a principal is authorized to use a service account.
*/
CompletionStage testServiceAccountUsageAuthorization(
String serviceAccountEmail, String principalEmail);
@Override
void close();
}