io.etcd.jetcd.options.GetOption Maven / Gradle / Ivy
/*
* Copyright 2016-2021 The jetcd authors
*
* Licensed 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 io.etcd.jetcd.options;
import java.util.Optional;
import io.etcd.jetcd.ByteSequence;
import io.etcd.jetcd.KV;
import static java.util.Objects.requireNonNull;
/**
* The option for get operation.
*/
public final class GetOption {
public static final GetOption DEFAULT = builder().build();
private final ByteSequence endKey;
private final long limit;
private final long revision;
private final SortOrder sortOrder;
private final SortTarget sortTarget;
private final boolean serializable;
private final boolean keysOnly;
private final boolean countOnly;
private final long minCreateRevision;
private final long maxCreateRevision;
private final long minModRevision;
private final long maxModRevision;
private final boolean prefix;
private GetOption(
ByteSequence endKey,
long limit,
long revision,
SortOrder sortOrder,
SortTarget sortTarget,
boolean serializable,
boolean keysOnly,
boolean countOnly,
long minCreateRevision,
long maxCreateRevision,
long minModRevision,
long maxModRevision,
boolean prefix) {
this.endKey = endKey;
this.limit = limit;
this.revision = revision;
this.sortOrder = sortOrder;
this.sortTarget = sortTarget;
this.serializable = serializable;
this.keysOnly = keysOnly;
this.countOnly = countOnly;
this.minCreateRevision = minCreateRevision;
this.maxCreateRevision = maxCreateRevision;
this.minModRevision = minModRevision;
this.maxModRevision = maxModRevision;
this.prefix = prefix;
}
/**
* Get the maximum number of keys to return for a get request.
*
* @return the maximum number of keys to return.
*/
public long getLimit() {
return this.limit;
}
public Optional getEndKey() {
return Optional.ofNullable(this.endKey);
}
public long getRevision() {
return revision;
}
public SortOrder getSortOrder() {
return sortOrder;
}
public SortTarget getSortField() {
return sortTarget;
}
public boolean isSerializable() {
return serializable;
}
public boolean isKeysOnly() {
return keysOnly;
}
public boolean isCountOnly() {
return countOnly;
}
public long getMinCreateRevision() {
return this.minCreateRevision;
}
public long getMaxCreateRevision() {
return this.maxCreateRevision;
}
public long getMinModRevision() {
return this.minModRevision;
}
public long getMaxModRevision() {
return this.maxModRevision;
}
public boolean isPrefix() {
return prefix;
}
public enum SortOrder {
NONE, ASCEND, DESCEND,
}
public enum SortTarget {
KEY, VERSION, CREATE, MOD, VALUE,
}
/**
* Returns the builder.
*
* @deprecated use {@link #builder()}
* @return the builder
*/
@SuppressWarnings("InlineMeSuggester")
@Deprecated
public static Builder newBuilder() {
return builder();
}
public static Builder builder() {
return new Builder();
}
public static final class Builder {
private long limit = 0L;
private long revision = 0L;
private SortOrder sortOrder = SortOrder.NONE;
private SortTarget sortTarget = SortTarget.KEY;
private boolean serializable = false;
private boolean keysOnly = false;
private boolean countOnly = false;
private ByteSequence endKey;
private long minCreateRevision = 0L;
private long maxCreateRevision = 0L;
private long minModRevision = 0L;
private long maxModRevision = 0L;
private boolean prefix = false;
private Builder() {
}
/**
* Limit the number of keys to return for a get request. By default is 0 - no limitation.
*
* @param limit the maximum number of keys to return for a get request.
* @return builder
*/
public Builder withLimit(long limit) {
this.limit = limit;
return this;
}
/**
* Provide the revision to use for the get request.
*
*
* If the revision is less or equal to zero, the get is over the newest key-value store.
*
*
* If the revision has been compacted, ErrCompacted is returned as a response.
*
* @param revision the revision to get.
* @return builder
*/
public Builder withRevision(long revision) {
this.revision = revision;
return this;
}
/**
* Sort the return key value pairs in the provided order.
*
* @param order order to sort the returned key value pairs.
* @return builder
*/
public Builder withSortOrder(SortOrder order) {
this.sortOrder = order;
return this;
}
/**
* Sort the return key value pairs in the provided field.
*
* @param field field to sort the key value pairs by the provided
* @return builder
*/
public Builder withSortField(SortTarget field) {
this.sortTarget = field;
return this;
}
/**
* Set the get request to be a serializable get request.
*
*
* Get requests are linearizable by
* default. For better performance, a serializable get request is served locally without needing
* to reach consensus with other nodes in the cluster.
*
* @param serializable is the get request a serializable get request.
* @return builder
*/
public Builder withSerializable(boolean serializable) {
this.serializable = serializable;
return this;
}
/**
* Set the get request to only return keys.
*
* @param keysOnly flag to only return keys
* @return builder
*/
public Builder withKeysOnly(boolean keysOnly) {
this.keysOnly = keysOnly;
return this;
}
/**
* Set the get request to only return count of the keys.
*
* @param countOnly flag to only return count of the keys
* @return builder
*/
public Builder withCountOnly(boolean countOnly) {
this.countOnly = countOnly;
return this;
}
/**
* Set the end key of the get request. If it is set, the get request will return the keys from
* key to endKey (exclusive).
*
*
* If end key is '\0', the range is all keys {@literal >=} key.
*
*
* If the end key is one bit larger than the given key, then it gets all keys with the
* prefix (the given key).
*
*
* If both key and end key are '\0', it returns all keys.
*
* @param endKey end key
* @return builder
*/
public Builder withRange(ByteSequence endKey) {
this.endKey = endKey;
return this;
}
/**
* Enables 'Get' requests to obtain all the keys by prefix.
*
*
*
* @param prefix flag to obtain all the keys by prefix
* @return builder
*/
public Builder isPrefix(boolean prefix) {
this.prefix = prefix;
return this;
}
/**
* Enables 'Get' requests to obtain all the keys with matching prefix.
*
*
* You should pass the key that is passed into
* {@link KV#get(ByteSequence) KV.get} method into this method as the given key.
*
* @param prefix the common prefix of all the keys that you want to get
* @return builder
* @deprecated Use {@link #isPrefix(boolean)} instead.
*/
@Deprecated
public Builder withPrefix(ByteSequence prefix) {
requireNonNull(prefix, "prefix should not be null");
ByteSequence prefixEnd = OptionsUtil.prefixEndOf(prefix);
this.withRange(prefixEnd);
return this;
}
/**
* Limit returned keys to those with create revision greater than the provided value.
* min_create_revision is the lower bound for returned key create revisions; all keys with
* lesser create revisions will be filtered away.
*
* @param createRevision create revision
* @return builder
*/
public Builder withMinCreateRevision(long createRevision) {
this.minCreateRevision = createRevision;
return this;
}
/**
* Limit returned keys to those with create revision less than the provided value.
* max_create_revision is the upper bound for returned key create revisions; all keys with
* greater create revisions will be filtered away.
*
* @param createRevision create revision
* @return builder
*/
public Builder withMaxCreateRevision(long createRevision) {
this.maxCreateRevision = createRevision;
return this;
}
/**
* Limit returned keys to those with mod revision greater than the provided value.
* min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod
* revisions will be filtered away.
*
* @param modRevision mod revision
* @return this builder instance
*/
public Builder withMinModRevision(long modRevision) {
this.minModRevision = modRevision;
return this;
}
/**
* Limit returned keys to those with mod revision less than the provided value. max_mod_revision
* is the upper bound for returned key mod revisions; all keys with greater mod revisions will
* be filtered away.
*
* @param modRevision mod revision
* @return this builder instance
*/
public Builder withMaxModRevision(long modRevision) {
this.maxModRevision = modRevision;
return this;
}
/**
* Build the GetOption.
*
* @return the GetOption
*/
public GetOption build() {
return new GetOption(
endKey,
limit,
revision,
sortOrder,
sortTarget,
serializable,
keysOnly,
countOnly,
minCreateRevision,
maxCreateRevision,
minModRevision,
maxModRevision,
prefix);
}
}
}