org.elasticsearch.action.ShardOperationFailedException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.elasticsearch Show documentation

The newest version!

/*
 * Licensed to Elasticsearch 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;

import org.elasticsearch.common.io.stream.Streamable;
import org.elasticsearch.common.xcontent.ToXContent;
import org.elasticsearch.rest.RestStatus;

/**
 * An exception indicating that a failure occurred performing an operation on the shard.
 */
public interface ShardOperationFailedException extends Streamable, ToXContent {

    /**
     * The index the operation failed on. Might return null if it can't be derived.
     *
     * @return The index the operation failed on or null if it can't be derived
     */
    String index();

    /**
     * The shard the operation failed on. Might return -1 if it can't be derived.
     *
     * @return The shard the operation failed on or -1 if it can't be derived
     */
    int shardId();

    /**
     * The reason of the failure.
     *
     * @return The reason of the failure
     */
    String reason();

    /**
     * The status of the failure.
     *
     * @return The status of the failure
     */
    RestStatus status();

    /**
     * The cause of this failure.
     *
     * @return The cause of this failure
     */
    Throwable getCause();
}