com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib Show documentation
Show all versions of clientlib Show documentation
GRPC Clientlib for nrtSearch
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yelp/nrtsearch/luceneserver.proto
// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;
/**
*
*
*Creates a snapshot in the index, which is saved point-in-time view of the last commit in the
*index such that no files referenced by that snapshot will be deleted by ongoing indexing until
*the snapshot is released with @releaseSnapshot. Note that this will reference the last commit,
*so be sure to call commit first if you have pending changes that you'd like to be included in
*the snapshot.<p>This can be used for backup purposes, i.e. after creating the snapshot you can
*copy all referenced files to backup storage, and then release the snapshot once complete.
*To restore the backup, just copy all the files back and restart the server. It can also
*be used for transactional purposes, i.e. if you sometimes need to search a specific snapshot
*instead of the current live index.<p>Creating a snapshot is very fast (does not require any
*file copying), but over time it will consume extra disk space as old segments are merged in
*the index. Be sure to release the snapshot once you're done. Snapshots survive shutdown
*and restart of the server. Returns all protected filenames referenced by this snapshot:
*these files will not change and will not be deleted until the snapshot is released.
*This returns the directories and files referenced by the snapshot.
*
*
* Protobuf type {@code luceneserver.CreateSnapshotRequest}
*/
public final class CreateSnapshotRequest extends
com.google.protobuf.GeneratedMessageV3 implements
// @@protoc_insertion_point(message_implements:luceneserver.CreateSnapshotRequest)
CreateSnapshotRequestOrBuilder {
private static final long serialVersionUID = 0L;
// Use CreateSnapshotRequest.newBuilder() to construct.
private CreateSnapshotRequest(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private CreateSnapshotRequest() {
indexName_ = "";
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(
UnusedPrivateParameter unused) {
return new CreateSnapshotRequest();
}
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.yelp.nrtsearch.server.grpc.LuceneServerProto.internal_static_luceneserver_CreateSnapshotRequest_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.yelp.nrtsearch.server.grpc.LuceneServerProto.internal_static_luceneserver_CreateSnapshotRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.class, com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.Builder.class);
}
public static final int INDEXNAME_FIELD_NUMBER = 1;
@SuppressWarnings("serial")
private volatile java.lang.Object indexName_ = "";
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @return The indexName.
*/
@java.lang.Override
public java.lang.String getIndexName() {
java.lang.Object ref = indexName_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
indexName_ = s;
return s;
}
}
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @return The bytes for indexName.
*/
@java.lang.Override
public com.google.protobuf.ByteString
getIndexNameBytes() {
java.lang.Object ref = indexName_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
indexName_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int OPENSEARCHER_FIELD_NUMBER = 2;
private boolean openSearcher_ = false;
/**
*
*Pass true if you intend to do searches against this snapshot, by passing searcher: {snapshot: X} to @search
*
*
* bool openSearcher = 2;
* @return The openSearcher.
*/
@java.lang.Override
public boolean getOpenSearcher() {
return openSearcher_;
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException {
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(indexName_)) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, indexName_);
}
if (openSearcher_ != false) {
output.writeBool(2, openSearcher_);
}
getUnknownFields().writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(indexName_)) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, indexName_);
}
if (openSearcher_ != false) {
size += com.google.protobuf.CodedOutputStream
.computeBoolSize(2, openSearcher_);
}
size += getUnknownFields().getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest)) {
return super.equals(obj);
}
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest other = (com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest) obj;
if (!getIndexName()
.equals(other.getIndexName())) return false;
if (getOpenSearcher()
!= other.getOpenSearcher()) return false;
if (!getUnknownFields().equals(other.getUnknownFields())) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + INDEXNAME_FIELD_NUMBER;
hash = (53 * hash) + getIndexName().hashCode();
hash = (37 * hash) + OPENSEARCHER_FIELD_NUMBER;
hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(
getOpenSearcher());
hash = (29 * hash) + getUnknownFields().hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseDelimitedFrom(
java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseDelimitedWithIOException(PARSER, input, extensionRegistry);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input);
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3
.parseWithIOException(PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() { return newBuilder(); }
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE
? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
*
*
*Creates a snapshot in the index, which is saved point-in-time view of the last commit in the
*index such that no files referenced by that snapshot will be deleted by ongoing indexing until
*the snapshot is released with @releaseSnapshot. Note that this will reference the last commit,
*so be sure to call commit first if you have pending changes that you'd like to be included in
*the snapshot.<p>This can be used for backup purposes, i.e. after creating the snapshot you can
*copy all referenced files to backup storage, and then release the snapshot once complete.
*To restore the backup, just copy all the files back and restart the server. It can also
*be used for transactional purposes, i.e. if you sometimes need to search a specific snapshot
*instead of the current live index.<p>Creating a snapshot is very fast (does not require any
*file copying), but over time it will consume extra disk space as old segments are merged in
*the index. Be sure to release the snapshot once you're done. Snapshots survive shutdown
*and restart of the server. Returns all protected filenames referenced by this snapshot:
*these files will not change and will not be deleted until the snapshot is released.
*This returns the directories and files referenced by the snapshot.
*
*
* Protobuf type {@code luceneserver.CreateSnapshotRequest}
*/
public static final class Builder extends
com.google.protobuf.GeneratedMessageV3.Builder implements
// @@protoc_insertion_point(builder_implements:luceneserver.CreateSnapshotRequest)
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequestOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor
getDescriptor() {
return com.yelp.nrtsearch.server.grpc.LuceneServerProto.internal_static_luceneserver_CreateSnapshotRequest_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.yelp.nrtsearch.server.grpc.LuceneServerProto.internal_static_luceneserver_CreateSnapshotRequest_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.class, com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.Builder.class);
}
// Construct using com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.newBuilder()
private Builder() {
}
private Builder(
com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
}
@java.lang.Override
public Builder clear() {
super.clear();
bitField0_ = 0;
indexName_ = "";
openSearcher_ = false;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor
getDescriptorForType() {
return com.yelp.nrtsearch.server.grpc.LuceneServerProto.internal_static_luceneserver_CreateSnapshotRequest_descriptor;
}
@java.lang.Override
public com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest getDefaultInstanceForType() {
return com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.getDefaultInstance();
}
@java.lang.Override
public com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest build() {
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest buildPartial() {
com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest result = new com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest(this);
if (bitField0_ != 0) { buildPartial0(result); }
onBuilt();
return result;
}
private void buildPartial0(com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest result) {
int from_bitField0_ = bitField0_;
if (((from_bitField0_ & 0x00000001) != 0)) {
result.indexName_ = indexName_;
}
if (((from_bitField0_ & 0x00000002) != 0)) {
result.openSearcher_ = openSearcher_;
}
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(
com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(
com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest) {
return mergeFrom((com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest)other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest other) {
if (other == com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest.getDefaultInstance()) return this;
if (!other.getIndexName().isEmpty()) {
indexName_ = other.indexName_;
bitField0_ |= 0x00000001;
onChanged();
}
if (other.getOpenSearcher() != false) {
setOpenSearcher(other.getOpenSearcher());
}
this.mergeUnknownFields(other.getUnknownFields());
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10: {
indexName_ = input.readStringRequireUtf8();
bitField0_ |= 0x00000001;
break;
} // case 10
case 16: {
openSearcher_ = input.readBool();
bitField0_ |= 0x00000002;
break;
} // case 16
default: {
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
done = true; // was an endgroup tag
}
break;
} // default:
} // switch (tag)
} // while (!done)
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.unwrapIOException();
} finally {
onChanged();
} // finally
return this;
}
private int bitField0_;
private java.lang.Object indexName_ = "";
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @return The indexName.
*/
public java.lang.String getIndexName() {
java.lang.Object ref = indexName_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs =
(com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
indexName_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @return The bytes for indexName.
*/
public com.google.protobuf.ByteString
getIndexNameBytes() {
java.lang.Object ref = indexName_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8(
(java.lang.String) ref);
indexName_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @param value The indexName to set.
* @return This builder for chaining.
*/
public Builder setIndexName(
java.lang.String value) {
if (value == null) { throw new NullPointerException(); }
indexName_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @return This builder for chaining.
*/
public Builder clearIndexName() {
indexName_ = getDefaultInstance().getIndexName();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
return this;
}
/**
*
*name of the index to snapshot;
*
*
* string indexName = 1;
* @param value The bytes for indexName to set.
* @return This builder for chaining.
*/
public Builder setIndexNameBytes(
com.google.protobuf.ByteString value) {
if (value == null) { throw new NullPointerException(); }
checkByteStringIsUtf8(value);
indexName_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
private boolean openSearcher_ ;
/**
*
*Pass true if you intend to do searches against this snapshot, by passing searcher: {snapshot: X} to @search
*
*
* bool openSearcher = 2;
* @return The openSearcher.
*/
@java.lang.Override
public boolean getOpenSearcher() {
return openSearcher_;
}
/**
*
*Pass true if you intend to do searches against this snapshot, by passing searcher: {snapshot: X} to @search
*
*
* bool openSearcher = 2;
* @param value The openSearcher to set.
* @return This builder for chaining.
*/
public Builder setOpenSearcher(boolean value) {
openSearcher_ = value;
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*Pass true if you intend to do searches against this snapshot, by passing searcher: {snapshot: X} to @search
*
*
* bool openSearcher = 2;
* @return This builder for chaining.
*/
public Builder clearOpenSearcher() {
bitField0_ = (bitField0_ & ~0x00000002);
openSearcher_ = false;
onChanged();
return this;
}
@java.lang.Override
public final Builder setUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:luceneserver.CreateSnapshotRequest)
}
// @@protoc_insertion_point(class_scope:luceneserver.CreateSnapshotRequest)
private static final com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest();
}
public static com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser
PARSER = new com.google.protobuf.AbstractParser() {
@java.lang.Override
public CreateSnapshotRequest parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
Builder builder = newBuilder();
try {
builder.mergeFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(builder.buildPartial());
} catch (com.google.protobuf.UninitializedMessageException e) {
throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e)
.setUnfinishedMessage(builder.buildPartial());
}
return builder.buildPartial();
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
@java.lang.Override
public com.yelp.nrtsearch.server.grpc.CreateSnapshotRequest getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}