com.hashicorp.nomad.javasdk.SearchApi 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 com.hashicorp.nomad.apimodel.SearchResponse;

import javax.annotation.Nullable;
import java.io.IOException;

/**
 * API for performing searches in the Nomad cluster,
 * exposing the search functionality of the
 * Nomad HTTP API.
 */
public class SearchApi extends ApiBase {

    SearchApi(NomadApiClient nomadApiClient) {
        super(nomadApiClient);
    }

    /**
     * Returns a list of matches for a particular context and prefix.
     *
     * @param prefix  items with this prefix are returned
     * @param context one of the following: allocs, deployment, evals, jobs, nodes, namespaces, quotas, all
     * @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 PUT /v1/search}
     */
    public ServerQueryResponse prefixSearch(
            String prefix,
            String context
    ) throws IOException, NomadException {
        return prefixSearch(prefix, context, null);
    }

    /**
     * Returns a list of matches for a particular context and prefix.
     *
     * @param prefix  items with this prefix are returned
     * @param context one of the following: allocs, deployment, evals, jobs, nodes, namespaces, quotas, all
     * @param options options controlling how the request is performed
     * @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 PUT /v1/search}
     */
    public ServerQueryResponse prefixSearch(
            String prefix,
            String context,
            @Nullable QueryOptions options
    ) throws IOException, NomadException {

        return executeServerQueryPut(
                uri("/v1/search"),
                new SearchRequest(prefix, context),
                options,
                NomadJson.parserFor(SearchResponse.class)
        );
    }

    /**
     * Class matching the JSON request entity for search requests.
     */
    private static class SearchRequest {
        public final String prefix;  // Checkstyle suppress VisibilityModifier
        public final String context; // Checkstyle suppress VisibilityModifier

        SearchRequest(String prefix, String context) {
            this.prefix = prefix;
            this.context = context;
        }
    }

}