BundledDocumentMetadata.Builder (proto-google-cloud-firestore-bundle-v1 3.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
    - - com.google.firestore.bundle.BundledDocumentMetadata.Builder

All Implemented Interfaces:

BundledDocumentMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BundledDocumentMetadata
```
public static final class BundledDocumentMetadata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
implements BundledDocumentMetadataOrBuilder
```
```
 Metadata describing a Firestore document saved in the bundle.
 
```
Protobuf type google.firestore.bundle.BundledDocumentMetadata

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BundledDocumentMetadata.Builder`	`addAllQueries(Iterable<String> values)` The names of the queries in this bundle that this document matches to.
`BundledDocumentMetadata.Builder`	`addQueries(String value)` The names of the queries in this bundle that this document matches to.
`BundledDocumentMetadata.Builder`	`addQueriesBytes(com.google.protobuf.ByteString value)` The names of the queries in this bundle that this document matches to.
`BundledDocumentMetadata.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`BundledDocumentMetadata`	`build()`
`BundledDocumentMetadata`	`buildPartial()`
`BundledDocumentMetadata.Builder`	`clear()`
`BundledDocumentMetadata.Builder`	`clearExists()` Whether the document exists.
`BundledDocumentMetadata.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`BundledDocumentMetadata.Builder`	`clearName()` The document key of a bundled document.
`BundledDocumentMetadata.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`BundledDocumentMetadata.Builder`	`clearQueries()` The names of the queries in this bundle that this document matches to.
`BundledDocumentMetadata.Builder`	`clearReadTime()` The snapshot version of the document data bundled.
`BundledDocumentMetadata.Builder`	`clone()`
`BundledDocumentMetadata`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getExists()` Whether the document exists.
`String`	`getName()` The document key of a bundled document.
`com.google.protobuf.ByteString`	`getNameBytes()` The document key of a bundled document.
`String`	`getQueries(int index)` The names of the queries in this bundle that this document matches to.
`com.google.protobuf.ByteString`	`getQueriesBytes(int index)` The names of the queries in this bundle that this document matches to.
`int`	`getQueriesCount()` The names of the queries in this bundle that this document matches to.
`com.google.protobuf.ProtocolStringList`	`getQueriesList()` The names of the queries in this bundle that this document matches to.
`com.google.protobuf.Timestamp`	`getReadTime()` The snapshot version of the document data bundled.
`com.google.protobuf.Timestamp.Builder`	`getReadTimeBuilder()` The snapshot version of the document data bundled.
`com.google.protobuf.TimestampOrBuilder`	`getReadTimeOrBuilder()` The snapshot version of the document data bundled.
`boolean`	`hasReadTime()` The snapshot version of the document data bundled.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`BundledDocumentMetadata.Builder`	`mergeFrom(BundledDocumentMetadata other)`
`BundledDocumentMetadata.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`BundledDocumentMetadata.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`BundledDocumentMetadata.Builder`	`mergeReadTime(com.google.protobuf.Timestamp value)` The snapshot version of the document data bundled.
`BundledDocumentMetadata.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`BundledDocumentMetadata.Builder`	`setExists(boolean value)` Whether the document exists.
`BundledDocumentMetadata.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`BundledDocumentMetadata.Builder`	`setName(String value)` The document key of a bundled document.
`BundledDocumentMetadata.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The document key of a bundled document.
`BundledDocumentMetadata.Builder`	`setQueries(int index, String value)` The names of the queries in this bundle that this document matches to.
`BundledDocumentMetadata.Builder`	`setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)` The snapshot version of the document data bundled.
`BundledDocumentMetadata.Builder`	`setReadTime(com.google.protobuf.Timestamp value)` The snapshot version of the document data bundled.
`BundledDocumentMetadata.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`BundledDocumentMetadata.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - clear
```
public BundledDocumentMetadata.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - getDefaultInstanceForType
```
public BundledDocumentMetadata getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public BundledDocumentMetadata build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public BundledDocumentMetadata buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public BundledDocumentMetadata.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - setField
```
public BundledDocumentMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - clearField
```
public BundledDocumentMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - clearOneof
```
public BundledDocumentMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - setRepeatedField
```
public BundledDocumentMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - addRepeatedField
```
public BundledDocumentMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - mergeFrom
```
public BundledDocumentMetadata.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BundledDocumentMetadata.Builder>
  - mergeFrom
```
public BundledDocumentMetadata.Builder mergeFrom(BundledDocumentMetadata other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - mergeFrom
```
public BundledDocumentMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BundledDocumentMetadata.Builder>
    
    Throws:
    
    IOException
  - getName
```
public String getName()
```
```
 The document key of a bundled document.
 
```
    string name = 1;
    Specified by:
    
    getName in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    The name.
  - getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The document key of a bundled document.
 
```
    string name = 1;
    Specified by:
    
    getNameBytes in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    The bytes for name.
  - setName
```
public BundledDocumentMetadata.Builder setName(String value)
```
```
 The document key of a bundled document.
 
```
    string name = 1;
    Parameters:
    
    value - The name to set.
    
    Returns:
    
    This builder for chaining.
  - clearName
```
public BundledDocumentMetadata.Builder clearName()
```
```
 The document key of a bundled document.
 
```
    string name = 1;
    Returns:
    
    This builder for chaining.
  - setNameBytes
```
public BundledDocumentMetadata.Builder setNameBytes(com.google.protobuf.ByteString value)
```
```
 The document key of a bundled document.
 
```
    string name = 1;
    Parameters:
    
    value - The bytes for name to set.
    
    Returns:
    
    This builder for chaining.
  - hasReadTime
```
public boolean hasReadTime()
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
    Specified by:
    
    hasReadTime in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    Whether the readTime field is set.
  - getReadTime
```
public com.google.protobuf.Timestamp getReadTime()
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
    Specified by:
    
    getReadTime in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    The readTime.
  - setReadTime
```
public BundledDocumentMetadata.Builder setReadTime(com.google.protobuf.Timestamp value)
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
  - setReadTime
```
public BundledDocumentMetadata.Builder setReadTime(com.google.protobuf.Timestamp.Builder builderForValue)
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
  - mergeReadTime
```
public BundledDocumentMetadata.Builder mergeReadTime(com.google.protobuf.Timestamp value)
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
  - clearReadTime
```
public BundledDocumentMetadata.Builder clearReadTime()
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
  - getReadTimeBuilder
```
public com.google.protobuf.Timestamp.Builder getReadTimeBuilder()
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
  - getReadTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
```
```
 The snapshot version of the document data bundled.
 
```
    .google.protobuf.Timestamp read_time = 2;
    Specified by:
    
    getReadTimeOrBuilder in interface BundledDocumentMetadataOrBuilder
  - getExists
```
public boolean getExists()
```
```
 Whether the document exists.
 
```
    bool exists = 3;
    Specified by:
    
    getExists in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    The exists.
  - setExists
```
public BundledDocumentMetadata.Builder setExists(boolean value)
```
```
 Whether the document exists.
 
```
    bool exists = 3;
    Parameters:
    
    value - The exists to set.
    
    Returns:
    
    This builder for chaining.
  - clearExists
```
public BundledDocumentMetadata.Builder clearExists()
```
```
 Whether the document exists.
 
```
    bool exists = 3;
    Returns:
    
    This builder for chaining.
  - getQueriesList
```
public com.google.protobuf.ProtocolStringList getQueriesList()
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Specified by:
    
    getQueriesList in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    A list containing the queries.
  - getQueriesCount
```
public int getQueriesCount()
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Specified by:
    
    getQueriesCount in interface BundledDocumentMetadataOrBuilder
    
    Returns:
    
    The count of queries.
  - getQueries
```
public String getQueries(int index)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Specified by:
    
    getQueries in interface BundledDocumentMetadataOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The queries at the given index.
  - getQueriesBytes
```
public com.google.protobuf.ByteString getQueriesBytes(int index)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Specified by:
    
    getQueriesBytes in interface BundledDocumentMetadataOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the queries at the given index.
  - setQueries
```
public BundledDocumentMetadata.Builder setQueries(int index,
                                                  String value)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Parameters:
    
    index - The index to set the value at.
    
    value - The queries to set.
    
    Returns:
    
    This builder for chaining.
  - addQueries
```
public BundledDocumentMetadata.Builder addQueries(String value)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Parameters:
    
    value - The queries to add.
    
    Returns:
    
    This builder for chaining.
  - addAllQueries
```
public BundledDocumentMetadata.Builder addAllQueries(Iterable<String> values)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Parameters:
    
    values - The queries to add.
    
    Returns:
    
    This builder for chaining.
  - clearQueries
```
public BundledDocumentMetadata.Builder clearQueries()
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Returns:
    
    This builder for chaining.
  - addQueriesBytes
```
public BundledDocumentMetadata.Builder addQueriesBytes(com.google.protobuf.ByteString value)
```
```
 The names of the queries in this bundle that this document matches to.
 
```
    repeated string queries = 4;
    Parameters:
    
    value - The bytes of the queries to add.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final BundledDocumentMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>
  - mergeUnknownFields
```
public final BundledDocumentMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BundledDocumentMetadata.Builder>

Class BundledDocumentMetadata.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getName

getNameBytes

setName

clearName

setNameBytes

hasReadTime

getReadTime

setReadTime

setReadTime

mergeReadTime

clearReadTime

getReadTimeBuilder

getReadTimeOrBuilder

getExists

setExists

clearExists

getQueriesList

getQueriesCount

getQueries

getQueriesBytes

setQueries

addQueries

addAllQueries

clearQueries

addQueriesBytes

setUnknownFields

mergeUnknownFields