com.spotify.helios.testing.HeliosDeployment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helios-testing Show documentation

There is a newer version: 0.9.283

/*
 * Copyright (c) 2015 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.helios.testing;

import com.google.common.net.HostAndPort;

import com.spotify.helios.client.HeliosClient;

/**
 * A HeliosDeployment represents a collection of Helios masters and agents upon which jobs may be
 * run.
 */
public interface HeliosDeployment extends AutoCloseable {
  /**
   * @return A helios client connected to the master(s) of this helios deployment.
   */
  HeliosClient client();

  /**
   * Returns the host and port information  that the deployment is available at.
   */
  // TODO (mbrown): should this be URI to capture scheme info also?
  HostAndPort address();

  /**
   * Undeploy (shut down) this Helios deployment.
   */
  void close();
}