All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.elasticsearch.action.admin.cluster.state.ClusterStateRequestBuilder Maven / Gradle / Ivy

There is a newer version: 8.14.1
Show newest version
/*
 * Licensed to ElasticSearch and Shay Banon under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. ElasticSearch licenses this
 * file to you 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 org.elasticsearch.action.admin.cluster.state;

import org.elasticsearch.action.ActionListener;
import org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder;
import org.elasticsearch.client.ClusterAdminClient;
import org.elasticsearch.client.internal.InternalClusterAdminClient;

/**
 *
 */
public class ClusterStateRequestBuilder extends MasterNodeOperationRequestBuilder {

    public ClusterStateRequestBuilder(ClusterAdminClient clusterClient) {
        super((InternalClusterAdminClient) clusterClient, new ClusterStateRequest());
    }

    /**
     * Filters all data responses.
     */
    public ClusterStateRequestBuilder setFilterAll() {
        request.filterAll();
        return this;
    }

    public ClusterStateRequestBuilder setFilterBlocks(boolean filter) {
        request.filterBlocks(filter);
        return this;
    }

    /**
     * Should the cluster state result include the {@link org.elasticsearch.cluster.metadata.MetaData}. Defaults
     * to false.
     */
    public ClusterStateRequestBuilder setFilterMetaData(boolean filter) {
        request.filterMetaData(filter);
        return this;
    }

    /**
     * Should the cluster state result include the {@link org.elasticsearch.cluster.node.DiscoveryNodes}. Defaults
     * to false.
     */
    public ClusterStateRequestBuilder setFilterNodes(boolean filter) {
        request.filterNodes(filter);
        return this;
    }

    /**
     * Should the cluster state result include teh {@link org.elasticsearch.cluster.routing.RoutingTable}. Defaults
     * to false.
     */
    public ClusterStateRequestBuilder setFilterRoutingTable(boolean filter) {
        request.filterRoutingTable(filter);
        return this;
    }

    /**
     * When {@link #setFilterMetaData(boolean)} is not set, which indices to return the {@link org.elasticsearch.cluster.metadata.IndexMetaData}
     * for. Defaults to all indices.
     */
    public ClusterStateRequestBuilder setFilterIndices(String... indices) {
        request.filteredIndices(indices);
        return this;
    }

    public ClusterStateRequestBuilder setFilterIndexTemplates(String... templates) {
        request.filteredIndexTemplates(templates);
        return this;
    }

    /**
     * Sets if the cluster state request should be executed locally on the node, and not go to the master.
     */
    public ClusterStateRequestBuilder setLocal(boolean local) {
        request.local(local);
        return this;
    }

    @Override
    protected void doExecute(ActionListener listener) {
        ((ClusterAdminClient) client).state(request, listener);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy