mn.foreman.api.endpoints.groups.Groups 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.groups;

import mn.foreman.api.endpoints.notifications.Notifications;

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

import java.util.List;
import java.util.Optional;

/**
 * A {@link Notifications} provides a handler for interacting with the
 * /api/groups Foreman API endpoint.
 */
public interface Groups {

    /**
     * Obtains the {@link GroupInfo}.
     *
     * @return The {@link GroupInfo}.
     */
    Optional groups();

    /** An object representing group information. */
    @JsonIgnoreProperties(ignoreUnknown = true)
    class GroupInfo {

        /** The group name. */
        @JsonProperty("groupName")
        public String name;

        /** The sub-clients. */
        @JsonProperty("subClients")
        public List subClients;

        /** An object representing a sub-client. */
        @JsonIgnoreProperties(ignoreUnknown = true)
        public static class SubClient {

            /** The client name. */
            @JsonProperty("clientName")
            public String clientName;

            /** The client ID. */
            @JsonProperty("id")
            public int id;
        }
    }
}