com.hashicorp.nomad.javasdk.RegionsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nomad-sdk Show documentation

There is a newer version: 0.11.3.0

package com.hashicorp.nomad.javasdk;


import java.io.IOException;
import java.util.List;

/**
 * API for querying for information about regions,
 * exposing the functionality of the {@code /v1/regions} endpoint of the
 * Nomad HTTP API.
 */
public class RegionsApi extends ApiBase {

    RegionsApi(NomadApiClient apiClient) {
        super(apiClient);
    }

    /**
     * List the names of the known regions in the cluster.
     *
     * @throws IOException    if there is an HTTP or lower-level problem
     * @throws NomadException if the response signals an error or cannot be deserialized
     * @see {@code GET /v1/regions}
     */
    public NomadResponse> list() throws IOException, NomadException {
        return executePlain(get("/v1/regions"), NomadJson.parserForListOf(String.class));
    }
}