Class ListenResponse.Builder (3.7.10)

public static final class ListenResponse.Builder extends GeneratedMessageV3.Builder<ListenResponse.Builder> implements ListenResponseOrBuilder

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListenResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListenResponse.Builder
Overrides

build()

public ListenResponse build()
Returns
TypeDescription
ListenResponse

buildPartial()

public ListenResponse buildPartial()
Returns
TypeDescription
ListenResponse

clear()

public ListenResponse.Builder clear()
Returns
TypeDescription
ListenResponse.Builder
Overrides

clearDocumentChange()

public ListenResponse.Builder clearDocumentChange()

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Returns
TypeDescription
ListenResponse.Builder

clearDocumentDelete()

public ListenResponse.Builder clearDocumentDelete()

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Returns
TypeDescription
ListenResponse.Builder

clearDocumentRemove()

public ListenResponse.Builder clearDocumentRemove()

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Returns
TypeDescription
ListenResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListenResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListenResponse.Builder
Overrides

clearFilter()

public ListenResponse.Builder clearFilter()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Returns
TypeDescription
ListenResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ListenResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListenResponse.Builder
Overrides

clearResponseType()

public ListenResponse.Builder clearResponseType()
Returns
TypeDescription
ListenResponse.Builder

clearTargetChange()

public ListenResponse.Builder clearTargetChange()

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Returns
TypeDescription
ListenResponse.Builder

clone()

public ListenResponse.Builder clone()
Returns
TypeDescription
ListenResponse.Builder
Overrides

getDefaultInstanceForType()

public ListenResponse getDefaultInstanceForType()
Returns
TypeDescription
ListenResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocumentChange()

public DocumentChange getDocumentChange()

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Returns
TypeDescription
DocumentChange

The documentChange.

getDocumentChangeBuilder()

public DocumentChange.Builder getDocumentChangeBuilder()

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Returns
TypeDescription
DocumentChange.Builder

getDocumentChangeOrBuilder()

public DocumentChangeOrBuilder getDocumentChangeOrBuilder()

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Returns
TypeDescription
DocumentChangeOrBuilder

getDocumentDelete()

public DocumentDelete getDocumentDelete()

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Returns
TypeDescription
DocumentDelete

The documentDelete.

getDocumentDeleteBuilder()

public DocumentDelete.Builder getDocumentDeleteBuilder()

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Returns
TypeDescription
DocumentDelete.Builder

getDocumentDeleteOrBuilder()

public DocumentDeleteOrBuilder getDocumentDeleteOrBuilder()

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Returns
TypeDescription
DocumentDeleteOrBuilder

getDocumentRemove()

public DocumentRemove getDocumentRemove()

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Returns
TypeDescription
DocumentRemove

The documentRemove.

getDocumentRemoveBuilder()

public DocumentRemove.Builder getDocumentRemoveBuilder()

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Returns
TypeDescription
DocumentRemove.Builder

getDocumentRemoveOrBuilder()

public DocumentRemoveOrBuilder getDocumentRemoveOrBuilder()

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Returns
TypeDescription
DocumentRemoveOrBuilder

getFilter()

public ExistenceFilter getFilter()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Returns
TypeDescription
ExistenceFilter

The filter.

getFilterBuilder()

public ExistenceFilter.Builder getFilterBuilder()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Returns
TypeDescription
ExistenceFilter.Builder

getFilterOrBuilder()

public ExistenceFilterOrBuilder getFilterOrBuilder()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Returns
TypeDescription
ExistenceFilterOrBuilder

getResponseTypeCase()

public ListenResponse.ResponseTypeCase getResponseTypeCase()
Returns
TypeDescription
ListenResponse.ResponseTypeCase

getTargetChange()

public TargetChange getTargetChange()

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Returns
TypeDescription
TargetChange

The targetChange.

getTargetChangeBuilder()

public TargetChange.Builder getTargetChangeBuilder()

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Returns
TypeDescription
TargetChange.Builder

getTargetChangeOrBuilder()

public TargetChangeOrBuilder getTargetChangeOrBuilder()

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Returns
TypeDescription
TargetChangeOrBuilder

hasDocumentChange()

public boolean hasDocumentChange()

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Returns
TypeDescription
boolean

Whether the documentChange field is set.

hasDocumentDelete()

public boolean hasDocumentDelete()

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Returns
TypeDescription
boolean

Whether the documentDelete field is set.

hasDocumentRemove()

public boolean hasDocumentRemove()

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Returns
TypeDescription
boolean

Whether the documentRemove field is set.

hasFilter()

public boolean hasFilter()

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasTargetChange()

public boolean hasTargetChange()

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Returns
TypeDescription
boolean

Whether the targetChange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDocumentChange(DocumentChange value)

public ListenResponse.Builder mergeDocumentChange(DocumentChange value)

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Parameter
NameDescription
valueDocumentChange
Returns
TypeDescription
ListenResponse.Builder

mergeDocumentDelete(DocumentDelete value)

public ListenResponse.Builder mergeDocumentDelete(DocumentDelete value)

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Parameter
NameDescription
valueDocumentDelete
Returns
TypeDescription
ListenResponse.Builder

mergeDocumentRemove(DocumentRemove value)

public ListenResponse.Builder mergeDocumentRemove(DocumentRemove value)

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Parameter
NameDescription
valueDocumentRemove
Returns
TypeDescription
ListenResponse.Builder

mergeFilter(ExistenceFilter value)

public ListenResponse.Builder mergeFilter(ExistenceFilter value)

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Parameter
NameDescription
valueExistenceFilter
Returns
TypeDescription
ListenResponse.Builder

mergeFrom(ListenResponse other)

public ListenResponse.Builder mergeFrom(ListenResponse other)
Parameter
NameDescription
otherListenResponse
Returns
TypeDescription
ListenResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListenResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListenResponse.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListenResponse.Builder
Overrides

mergeTargetChange(TargetChange value)

public ListenResponse.Builder mergeTargetChange(TargetChange value)

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Parameter
NameDescription
valueTargetChange
Returns
TypeDescription
ListenResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListenResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListenResponse.Builder
Overrides

setDocumentChange(DocumentChange value)

public ListenResponse.Builder setDocumentChange(DocumentChange value)

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Parameter
NameDescription
valueDocumentChange
Returns
TypeDescription
ListenResponse.Builder

setDocumentChange(DocumentChange.Builder builderForValue)

public ListenResponse.Builder setDocumentChange(DocumentChange.Builder builderForValue)

A Document has changed.

.google.firestore.v1.DocumentChange document_change = 3;

Parameter
NameDescription
builderForValueDocumentChange.Builder
Returns
TypeDescription
ListenResponse.Builder

setDocumentDelete(DocumentDelete value)

public ListenResponse.Builder setDocumentDelete(DocumentDelete value)

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Parameter
NameDescription
valueDocumentDelete
Returns
TypeDescription
ListenResponse.Builder

setDocumentDelete(DocumentDelete.Builder builderForValue)

public ListenResponse.Builder setDocumentDelete(DocumentDelete.Builder builderForValue)

A Document has been deleted.

.google.firestore.v1.DocumentDelete document_delete = 4;

Parameter
NameDescription
builderForValueDocumentDelete.Builder
Returns
TypeDescription
ListenResponse.Builder

setDocumentRemove(DocumentRemove value)

public ListenResponse.Builder setDocumentRemove(DocumentRemove value)

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Parameter
NameDescription
valueDocumentRemove
Returns
TypeDescription
ListenResponse.Builder

setDocumentRemove(DocumentRemove.Builder builderForValue)

public ListenResponse.Builder setDocumentRemove(DocumentRemove.Builder builderForValue)

A Document has been removed from a target (because it is no longer relevant to that target).

.google.firestore.v1.DocumentRemove document_remove = 6;

Parameter
NameDescription
builderForValueDocumentRemove.Builder
Returns
TypeDescription
ListenResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListenResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListenResponse.Builder
Overrides

setFilter(ExistenceFilter value)

public ListenResponse.Builder setFilter(ExistenceFilter value)

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Parameter
NameDescription
valueExistenceFilter
Returns
TypeDescription
ListenResponse.Builder

setFilter(ExistenceFilter.Builder builderForValue)

public ListenResponse.Builder setFilter(ExistenceFilter.Builder builderForValue)

A filter to apply to the set of documents previously returned for the given target. Returned when documents may have been removed from the given target, but the exact documents are unknown.

.google.firestore.v1.ExistenceFilter filter = 5;

Parameter
NameDescription
builderForValueExistenceFilter.Builder
Returns
TypeDescription
ListenResponse.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListenResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListenResponse.Builder
Overrides

setTargetChange(TargetChange value)

public ListenResponse.Builder setTargetChange(TargetChange value)

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Parameter
NameDescription
valueTargetChange
Returns
TypeDescription
ListenResponse.Builder

setTargetChange(TargetChange.Builder builderForValue)

public ListenResponse.Builder setTargetChange(TargetChange.Builder builderForValue)

Targets have changed.

.google.firestore.v1.TargetChange target_change = 2;

Parameter
NameDescription
builderForValueTargetChange.Builder
Returns
TypeDescription
ListenResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ListenResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListenResponse.Builder
Overrides