mn.foreman.api.endpoints.sitemap.SiteMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-api Show documentation

A library for interacting with the Foreman API.

There is a newer version: 1.78.0

package mn.foreman.api.endpoints.sitemap;

import mn.foreman.api.endpoints.StatusSubmit;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.Optional;

/**
 * A {@link SiteMap} provides a handler for interacting with the
 * /api/site-map/ Foreman API endpoint.
 */
public interface SiteMap {

    /**
     * Changes the site map location of a miner.
     *
     * @param minerId The miner ID.
     * @param rack    The rack.
     * @param row     The row.
     * @param index   The index.
     *
     * @return The response.
     */
    Optional setLocation(
            int minerId,
            String rack,
            int row,
            int index);

    /** An response. */
    @JsonIgnoreProperties(ignoreUnknown = true)
    class Response {

        /** The status. */
        @JsonProperty("status")
        public StatusSubmit status;
    }
}