com.google.firestore.v1.DocumentMask Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-firestore-v1 Show documentation
Show all versions of proto-google-cloud-firestore-v1 Show documentation
PROTO library for proto-google-cloud-firestore-v1
/*
* Copyright 2024 Google LLC
*
* 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
*
* https://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.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/firestore/v1/common.proto
// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;
/**
*
*
*
* A set of field paths on a document.
* Used to restrict a get or update operation on a document to a subset of its
* fields.
* This is different from standard field masks, as this is always scoped to a
* [Document][google.firestore.v1.Document], and takes in account the dynamic
* nature of [Value][google.firestore.v1.Value].
*
*
* Protobuf type {@code google.firestore.v1.DocumentMask}
*/
public final class DocumentMask extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.firestore.v1.DocumentMask)
DocumentMaskOrBuilder {
private static final long serialVersionUID = 0L;
// Use DocumentMask.newBuilder() to construct.
private DocumentMask(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private DocumentMask() {
fieldPaths_ = com.google.protobuf.LazyStringArrayList.emptyList();
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new DocumentMask();
}
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.firestore.v1.CommonProto
.internal_static_google_firestore_v1_DocumentMask_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.firestore.v1.CommonProto
.internal_static_google_firestore_v1_DocumentMask_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.firestore.v1.DocumentMask.class,
com.google.firestore.v1.DocumentMask.Builder.class);
}
public static final int FIELD_PATHS_FIELD_NUMBER = 1;
@SuppressWarnings("serial")
private com.google.protobuf.LazyStringArrayList fieldPaths_ =
com.google.protobuf.LazyStringArrayList.emptyList();
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @return A list containing the fieldPaths.
*/
public com.google.protobuf.ProtocolStringList getFieldPathsList() {
return fieldPaths_;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @return The count of fieldPaths.
*/
public int getFieldPathsCount() {
return fieldPaths_.size();
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param index The index of the element to return.
* @return The fieldPaths at the given index.
*/
public java.lang.String getFieldPaths(int index) {
return fieldPaths_.get(index);
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param index The index of the value to return.
* @return The bytes of the fieldPaths at the given index.
*/
public com.google.protobuf.ByteString getFieldPathsBytes(int index) {
return fieldPaths_.getByteString(index);
}
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 {
for (int i = 0; i < fieldPaths_.size(); i++) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, fieldPaths_.getRaw(i));
}
getUnknownFields().writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
{
int dataSize = 0;
for (int i = 0; i < fieldPaths_.size(); i++) {
dataSize += computeStringSizeNoTag(fieldPaths_.getRaw(i));
}
size += dataSize;
size += 1 * getFieldPathsList().size();
}
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.google.firestore.v1.DocumentMask)) {
return super.equals(obj);
}
com.google.firestore.v1.DocumentMask other = (com.google.firestore.v1.DocumentMask) obj;
if (!getFieldPathsList().equals(other.getFieldPathsList())) 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();
if (getFieldPathsCount() > 0) {
hash = (37 * hash) + FIELD_PATHS_FIELD_NUMBER;
hash = (53 * hash) + getFieldPathsList().hashCode();
}
hash = (29 * hash) + getUnknownFields().hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.google.firestore.v1.DocumentMask parseFrom(java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.firestore.v1.DocumentMask parseFrom(
java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.firestore.v1.DocumentMask parseFrom(com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.firestore.v1.DocumentMask parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.firestore.v1.DocumentMask parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.firestore.v1.DocumentMask parseFrom(
byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.firestore.v1.DocumentMask parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.firestore.v1.DocumentMask 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.google.firestore.v1.DocumentMask parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
}
public static com.google.firestore.v1.DocumentMask 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.google.firestore.v1.DocumentMask parseFrom(
com.google.protobuf.CodedInputStream input) throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.firestore.v1.DocumentMask 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.google.firestore.v1.DocumentMask 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;
}
/**
*
*
*
* A set of field paths on a document.
* Used to restrict a get or update operation on a document to a subset of its
* fields.
* This is different from standard field masks, as this is always scoped to a
* [Document][google.firestore.v1.Document], and takes in account the dynamic
* nature of [Value][google.firestore.v1.Value].
*
*
* Protobuf type {@code google.firestore.v1.DocumentMask}
*/
public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder
implements
// @@protoc_insertion_point(builder_implements:google.firestore.v1.DocumentMask)
com.google.firestore.v1.DocumentMaskOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.firestore.v1.CommonProto
.internal_static_google_firestore_v1_DocumentMask_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.firestore.v1.CommonProto
.internal_static_google_firestore_v1_DocumentMask_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.firestore.v1.DocumentMask.class,
com.google.firestore.v1.DocumentMask.Builder.class);
}
// Construct using com.google.firestore.v1.DocumentMask.newBuilder()
private Builder() {}
private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
}
@java.lang.Override
public Builder clear() {
super.clear();
bitField0_ = 0;
fieldPaths_ = com.google.protobuf.LazyStringArrayList.emptyList();
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() {
return com.google.firestore.v1.CommonProto
.internal_static_google_firestore_v1_DocumentMask_descriptor;
}
@java.lang.Override
public com.google.firestore.v1.DocumentMask getDefaultInstanceForType() {
return com.google.firestore.v1.DocumentMask.getDefaultInstance();
}
@java.lang.Override
public com.google.firestore.v1.DocumentMask build() {
com.google.firestore.v1.DocumentMask result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.google.firestore.v1.DocumentMask buildPartial() {
com.google.firestore.v1.DocumentMask result = new com.google.firestore.v1.DocumentMask(this);
if (bitField0_ != 0) {
buildPartial0(result);
}
onBuilt();
return result;
}
private void buildPartial0(com.google.firestore.v1.DocumentMask result) {
int from_bitField0_ = bitField0_;
if (((from_bitField0_ & 0x00000001) != 0)) {
fieldPaths_.makeImmutable();
result.fieldPaths_ = fieldPaths_;
}
}
@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.google.firestore.v1.DocumentMask) {
return mergeFrom((com.google.firestore.v1.DocumentMask) other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.google.firestore.v1.DocumentMask other) {
if (other == com.google.firestore.v1.DocumentMask.getDefaultInstance()) return this;
if (!other.fieldPaths_.isEmpty()) {
if (fieldPaths_.isEmpty()) {
fieldPaths_ = other.fieldPaths_;
bitField0_ |= 0x00000001;
} else {
ensureFieldPathsIsMutable();
fieldPaths_.addAll(other.fieldPaths_);
}
onChanged();
}
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:
{
java.lang.String s = input.readStringRequireUtf8();
ensureFieldPathsIsMutable();
fieldPaths_.add(s);
break;
} // case 10
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 com.google.protobuf.LazyStringArrayList fieldPaths_ =
com.google.protobuf.LazyStringArrayList.emptyList();
private void ensureFieldPathsIsMutable() {
if (!fieldPaths_.isModifiable()) {
fieldPaths_ = new com.google.protobuf.LazyStringArrayList(fieldPaths_);
}
bitField0_ |= 0x00000001;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @return A list containing the fieldPaths.
*/
public com.google.protobuf.ProtocolStringList getFieldPathsList() {
fieldPaths_.makeImmutable();
return fieldPaths_;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @return The count of fieldPaths.
*/
public int getFieldPathsCount() {
return fieldPaths_.size();
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param index The index of the element to return.
* @return The fieldPaths at the given index.
*/
public java.lang.String getFieldPaths(int index) {
return fieldPaths_.get(index);
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param index The index of the value to return.
* @return The bytes of the fieldPaths at the given index.
*/
public com.google.protobuf.ByteString getFieldPathsBytes(int index) {
return fieldPaths_.getByteString(index);
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param index The index to set the value at.
* @param value The fieldPaths to set.
* @return This builder for chaining.
*/
public Builder setFieldPaths(int index, java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
ensureFieldPathsIsMutable();
fieldPaths_.set(index, value);
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param value The fieldPaths to add.
* @return This builder for chaining.
*/
public Builder addFieldPaths(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
ensureFieldPathsIsMutable();
fieldPaths_.add(value);
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param values The fieldPaths to add.
* @return This builder for chaining.
*/
public Builder addAllFieldPaths(java.lang.Iterable values) {
ensureFieldPathsIsMutable();
com.google.protobuf.AbstractMessageLite.Builder.addAll(values, fieldPaths_);
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @return This builder for chaining.
*/
public Builder clearFieldPaths() {
fieldPaths_ = com.google.protobuf.LazyStringArrayList.emptyList();
bitField0_ = (bitField0_ & ~0x00000001);
;
onChanged();
return this;
}
/**
*
*
*
* The list of field paths in the mask. See
* [Document.fields][google.firestore.v1.Document.fields] for a field path
* syntax reference.
*
*
* repeated string field_paths = 1;
*
* @param value The bytes of the fieldPaths to add.
* @return This builder for chaining.
*/
public Builder addFieldPathsBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
ensureFieldPathsIsMutable();
fieldPaths_.add(value);
bitField0_ |= 0x00000001;
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:google.firestore.v1.DocumentMask)
}
// @@protoc_insertion_point(class_scope:google.firestore.v1.DocumentMask)
private static final com.google.firestore.v1.DocumentMask DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.firestore.v1.DocumentMask();
}
public static com.google.firestore.v1.DocumentMask getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser PARSER =
new com.google.protobuf.AbstractParser() {
@java.lang.Override
public DocumentMask 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.google.firestore.v1.DocumentMask getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy