org.graylog.plugins.views.search.export.ExportMessagesCommand Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog.plugins.views.search.export;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableSet;
import org.graylog.plugins.views.search.elasticsearch.ElasticsearchQueryString;
import org.graylog2.decorators.Decorator;
import org.graylog2.plugin.indexer.searches.timeranges.AbsoluteRange;
import org.graylog2.plugin.indexer.searches.timeranges.InvalidRangeParametersException;
import org.graylog2.plugin.indexer.searches.timeranges.RelativeRange;
import org.joda.time.DateTimeZone;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.OptionalInt;
import java.util.Set;
import static org.graylog.plugins.views.search.export.LinkedHashSetUtil.linkedHashSetOf;
@AutoValue
public abstract class ExportMessagesCommand {
public static final ElasticsearchQueryString DEFAULT_QUERY = ElasticsearchQueryString.empty();
public static final Set DEFAULT_STREAMS = ImmutableSet.of();
public static final LinkedHashSet DEFAULT_FIELDS = linkedHashSetOf("timestamp", "source", "message");
public static final int DEFAULT_CHUNK_SIZE = 1000;
public static final DateTimeZone DEFAULT_TIME_ZONE = DateTimeZone.UTC;
public static AbsoluteRange defaultTimeRange() {
try {
RelativeRange lastFiveMinutes = RelativeRange.create(300);
return AbsoluteRange.create(lastFiveMinutes.getFrom(), lastFiveMinutes.getTo());
} catch (InvalidRangeParametersException e) {
throw new RuntimeException("Error creating default time range", e);
}
}
public abstract AbsoluteRange timeRange();
public abstract ElasticsearchQueryString queryString();
public abstract Set streams();
public abstract LinkedHashSet fieldsInOrder();
public abstract List decorators();
public abstract int chunkSize();
public abstract OptionalInt limit();
public abstract DateTimeZone timeZone();
public static ExportMessagesCommand withDefaults() {
return builder().build();
}
public static ExportMessagesCommand.Builder builder() {
return ExportMessagesCommand.Builder.create();
}
public abstract ExportMessagesCommand.Builder toBuilder();
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder timeRange(AbsoluteRange timeRange);
public abstract Builder streams(Set streams);
public Builder streams(String... streams) {
return streams(ImmutableSet.copyOf(streams));
}
public abstract Builder queryString(ElasticsearchQueryString queryString);
public abstract Builder fieldsInOrder(LinkedHashSet fieldsInOrder);
public Builder fieldsInOrder(String... fieldsInOrder) {
return fieldsInOrder(linkedHashSetOf(fieldsInOrder));
}
public abstract Builder decorators(List decorators);
public abstract Builder chunkSize(int chunkSize);
public abstract Builder limit(Integer limit);
public abstract Builder timeZone(DateTimeZone timeZone);
abstract ExportMessagesCommand autoBuild();
public ExportMessagesCommand build() {
return autoBuild();
}
public static Builder create() {
return new AutoValue_ExportMessagesCommand.Builder()
.timeRange(defaultTimeRange())
.streams(DEFAULT_STREAMS)
.queryString(DEFAULT_QUERY)
.fieldsInOrder(DEFAULT_FIELDS)
.decorators(Collections.emptyList())
.chunkSize(DEFAULT_CHUNK_SIZE)
.timeZone(DEFAULT_TIME_ZONE);
}
}
}