org.elasticsearch.xpack.core.monitoring.action.MonitoringBulkResponse Maven / Gradle / Ivy

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */
package org.elasticsearch.xpack.core.monitoring.action;

import org.elasticsearch.ElasticsearchException;
import org.elasticsearch.ExceptionsHelper;
import org.elasticsearch.Version;
import org.elasticsearch.action.ActionResponse;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.common.io.stream.Writeable;
import org.elasticsearch.common.unit.TimeValue;
import org.elasticsearch.common.xcontent.ToXContentObject;
import org.elasticsearch.common.xcontent.XContentBuilder;
import org.elasticsearch.rest.RestStatus;

import java.io.IOException;
import java.util.Objects;

public class MonitoringBulkResponse extends ActionResponse {

    private long tookInMillis;
    private Error error;
    private boolean ignored;

    public MonitoringBulkResponse(StreamInput in) throws IOException {
        super(in);
        tookInMillis = in.readVLong();
        error = in.readOptionalWriteable(Error::new);

        if (in.getVersion().onOrAfter(Version.V_6_3_0)) {
            ignored = in.readBoolean();
        }
    }

    public MonitoringBulkResponse(final long tookInMillis, final boolean ignored) {
        this.tookInMillis = tookInMillis;
        this.ignored = ignored;
    }

    public MonitoringBulkResponse(final long tookInMillis, final Error error) {
        this(tookInMillis, false);
        this.error = error;
    }

    public TimeValue getTook() {
        return new TimeValue(tookInMillis);
    }

    public long getTookInMillis() {
        return tookInMillis;
    }

    /**
     * Determine if the request was ignored.
     *
     * @return {@code true} if the request was ignored because collection was disabled.
     */
    public boolean isIgnored() {
        return ignored;
    }

    /**
     * Returns HTTP status
     *
     * 
     * {@link RestStatus#OK} if monitoring bulk request was successful (or ignored because collection is disabled)
     * {@link RestStatus#INTERNAL_SERVER_ERROR} if monitoring bulk request was partially successful or failed completely
     * 
     */
    public RestStatus status() {
        if (error == null) {
            return RestStatus.OK;
        }

        return RestStatus.INTERNAL_SERVER_ERROR;
    }

    public Error getError() {
        return error;
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        out.writeVLong(tookInMillis);
        out.writeOptionalWriteable(error);

        if (out.getVersion().onOrAfter(Version.V_6_3_0)) {
            out.writeBoolean(ignored);
        }
    }

    public static class Error implements Writeable, ToXContentObject {

        private final Throwable cause;
        private final RestStatus status;

        public Error(Throwable t) {
            cause = Objects.requireNonNull(t);
            status = ExceptionsHelper.status(t);
        }

        public Error(StreamInput in) throws IOException {
            this(in.readException());
        }

        @Override
        public void writeTo(StreamOutput out) throws IOException {
            out.writeException(getCause());
        }

        /**
         * The failure message.
         */
        public String getMessage() {
            return this.cause.toString();
        }

        /**
         * The rest status.
         */
        public RestStatus getStatus() {
            return this.status;
        }

        /**
         * The actual cause of the failure.
         */
        public Throwable getCause() {
            return cause;
        }

        @Override
        public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
            builder.startObject();
            ElasticsearchException.generateThrowableXContent(builder, params, cause);
            builder.endObject();
            return builder;
        }

        @Override
        public String toString() {
            final StringBuilder sb = new StringBuilder("Error [");
            sb.append("cause=").append(cause);
            sb.append(", status=").append(status);
            sb.append(']');
            return sb.toString();
        }
    }
}