public static final class BundleMetadata.Builder extends GeneratedMessageV3.Builder<BundleMetadata.Builder> implements BundleMetadataOrBuilder
Metadata describing the bundle file/stream.
Protobuf type google.firestore.bundle.BundleMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BundleMetadata.BuilderImplements
BundleMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BundleMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
build()
public BundleMetadata build()
Returns | |
---|---|
Type | Description |
BundleMetadata |
buildPartial()
public BundleMetadata buildPartial()
Returns | |
---|---|
Type | Description |
BundleMetadata |
clear()
public BundleMetadata.Builder clear()
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
clearCreateTime()
public BundleMetadata.Builder clearCreateTime()
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
clearField(Descriptors.FieldDescriptor field)
public BundleMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
clearId()
public BundleMetadata.Builder clearId()
The ID of the bundle.
string id = 1;
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public BundleMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
clearTotalBytes()
public BundleMetadata.Builder clearTotalBytes()
The size of the bundle in bytes, excluding this BundleMetadata
.
uint64 total_bytes = 5;
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
clearTotalDocuments()
public BundleMetadata.Builder clearTotalDocuments()
The number of documents in the bundle.
uint32 total_documents = 4;
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
clearVersion()
public BundleMetadata.Builder clearVersion()
The schema version of the bundle.
uint32 version = 3;
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
clone()
public BundleMetadata.Builder clone()
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
getCreateTime()
public Timestamp getCreateTime()
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Returns | |
---|---|
Type | Description |
Timestamp | The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public BundleMetadata getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
BundleMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getId()
public String getId()
The ID of the bundle.
string id = 1;
Returns | |
---|---|
Type | Description |
String | The id. |
getIdBytes()
public ByteString getIdBytes()
The ID of the bundle.
string id = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for id. |
getTotalBytes()
public long getTotalBytes()
The size of the bundle in bytes, excluding this BundleMetadata
.
uint64 total_bytes = 5;
Returns | |
---|---|
Type | Description |
long | The totalBytes. |
getTotalDocuments()
public int getTotalDocuments()
The number of documents in the bundle.
uint32 total_documents = 4;
Returns | |
---|---|
Type | Description |
int | The totalDocuments. |
getVersion()
public int getVersion()
The schema version of the bundle.
uint32 version = 3;
Returns | |
---|---|
Type | Description |
int | The version. |
hasCreateTime()
public boolean hasCreateTime()
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Returns | |
---|---|
Type | Description |
boolean | Whether the createTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public BundleMetadata.Builder mergeCreateTime(Timestamp value)
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
mergeFrom(BundleMetadata other)
public BundleMetadata.Builder mergeFrom(BundleMetadata other)
Parameter | |
---|---|
Name | Description |
other | BundleMetadata |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BundleMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public BundleMetadata.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BundleMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setCreateTime(Timestamp value)
public BundleMetadata.Builder setCreateTime(Timestamp value)
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public BundleMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)
Time at which the documents snapshot is taken for this bundle.
.google.protobuf.Timestamp create_time = 2;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public BundleMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setId(String value)
public BundleMetadata.Builder setId(String value)
The ID of the bundle.
string id = 1;
Parameter | |
---|---|
Name | Description |
value | String The id to set. |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public BundleMetadata.Builder setIdBytes(ByteString value)
The ID of the bundle.
string id = 1;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for id to set. |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BundleMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setTotalBytes(long value)
public BundleMetadata.Builder setTotalBytes(long value)
The size of the bundle in bytes, excluding this BundleMetadata
.
uint64 total_bytes = 5;
Parameter | |
---|---|
Name | Description |
value | long The totalBytes to set. |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
setTotalDocuments(int value)
public BundleMetadata.Builder setTotalDocuments(int value)
The number of documents in the bundle.
uint32 total_documents = 4;
Parameter | |
---|---|
Name | Description |
value | int The totalDocuments to set. |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BundleMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder |
setVersion(int value)
public BundleMetadata.Builder setVersion(int value)
The schema version of the bundle.
uint32 version = 3;
Parameter | |
---|---|
Name | Description |
value | int The version to set. |
Returns | |
---|---|
Type | Description |
BundleMetadata.Builder | This builder for chaining. |