Class ListenResponse.Builder (3.24.3)

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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListenResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListenResponse.Builder
Overrides

build()

public ListenResponse build()
Returns
Type Description
ListenResponse

buildPartial()

public ListenResponse buildPartial()
Returns
Type Description
ListenResponse

clear()

public ListenResponse.Builder clear()
Returns
Type Description
ListenResponse.Builder
Overrides

clearDocumentChange()

public ListenResponse.Builder clearDocumentChange()

A Document has changed.

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

Returns
Type Description
ListenResponse.Builder

clearDocumentDelete()

public ListenResponse.Builder clearDocumentDelete()

A Document has been deleted.

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

Returns
Type Description
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
Type Description
ListenResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListenResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
ListenResponse.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ListenResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListenResponse.Builder
Overrides

clearResponseType()

public ListenResponse.Builder clearResponseType()
Returns
Type Description
ListenResponse.Builder

clearTargetChange()

public ListenResponse.Builder clearTargetChange()

Targets have changed.

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

Returns
Type Description
ListenResponse.Builder

clone()

public ListenResponse.Builder clone()
Returns
Type Description
ListenResponse.Builder
Overrides

getDefaultInstanceForType()

public ListenResponse getDefaultInstanceForType()
Returns
Type Description
ListenResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentChange()

public DocumentChange getDocumentChange()

A Document has changed.

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

Returns
Type Description
DocumentChange

The documentChange.

getDocumentChangeBuilder()

public DocumentChange.Builder getDocumentChangeBuilder()

A Document has changed.

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

Returns
Type Description
DocumentChange.Builder

getDocumentChangeOrBuilder()

public DocumentChangeOrBuilder getDocumentChangeOrBuilder()

A Document has changed.

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

Returns
Type Description
DocumentChangeOrBuilder

getDocumentDelete()

public DocumentDelete getDocumentDelete()

A Document has been deleted.

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

Returns
Type Description
DocumentDelete

The documentDelete.

getDocumentDeleteBuilder()

public DocumentDelete.Builder getDocumentDeleteBuilder()

A Document has been deleted.

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

Returns
Type Description
DocumentDelete.Builder

getDocumentDeleteOrBuilder()

public DocumentDeleteOrBuilder getDocumentDeleteOrBuilder()

A Document has been deleted.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ExistenceFilterOrBuilder

getResponseTypeCase()

public ListenResponse.ResponseTypeCase getResponseTypeCase()
Returns
Type Description
ListenResponse.ResponseTypeCase

getTargetChange()

public TargetChange getTargetChange()

Targets have changed.

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

Returns
Type Description
TargetChange

The targetChange.

getTargetChangeBuilder()

public TargetChange.Builder getTargetChangeBuilder()

Targets have changed.

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

Returns
Type Description
TargetChange.Builder

getTargetChangeOrBuilder()

public TargetChangeOrBuilder getTargetChangeOrBuilder()

Targets have changed.

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

Returns
Type Description
TargetChangeOrBuilder

hasDocumentChange()

public boolean hasDocumentChange()

A Document has changed.

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

Returns
Type Description
boolean

Whether the documentChange field is set.

hasDocumentDelete()

public boolean hasDocumentDelete()

A Document has been deleted.

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

Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the filter field is set.

hasTargetChange()

public boolean hasTargetChange()

Targets have changed.

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

Returns
Type Description
boolean

Whether the targetChange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocumentChange(DocumentChange value)

public ListenResponse.Builder mergeDocumentChange(DocumentChange value)

A Document has changed.

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

Parameter
Name Description
value DocumentChange
Returns
Type Description
ListenResponse.Builder

mergeDocumentDelete(DocumentDelete value)

public ListenResponse.Builder mergeDocumentDelete(DocumentDelete value)

A Document has been deleted.

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

Parameter
Name Description
value DocumentDelete
Returns
Type Description
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
Name Description
value DocumentRemove
Returns
Type Description
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
Name Description
value ExistenceFilter
Returns
Type Description
ListenResponse.Builder

mergeFrom(ListenResponse other)

public ListenResponse.Builder mergeFrom(ListenResponse other)
Parameter
Name Description
other ListenResponse
Returns
Type Description
ListenResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListenResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListenResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListenResponse.Builder
Overrides

mergeTargetChange(TargetChange value)

public ListenResponse.Builder mergeTargetChange(TargetChange value)

Targets have changed.

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

Parameter
Name Description
value TargetChange
Returns
Type Description
ListenResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListenResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListenResponse.Builder
Overrides

setDocumentChange(DocumentChange value)

public ListenResponse.Builder setDocumentChange(DocumentChange value)

A Document has changed.

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

Parameter
Name Description
value DocumentChange
Returns
Type Description
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
Name Description
builderForValue DocumentChange.Builder
Returns
Type Description
ListenResponse.Builder

setDocumentDelete(DocumentDelete value)

public ListenResponse.Builder setDocumentDelete(DocumentDelete value)

A Document has been deleted.

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

Parameter
Name Description
value DocumentDelete
Returns
Type Description
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
Name Description
builderForValue DocumentDelete.Builder
Returns
Type Description
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
Name Description
value DocumentRemove
Returns
Type Description
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
Name Description
builderForValue DocumentRemove.Builder
Returns
Type Description
ListenResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListenResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value ExistenceFilter
Returns
Type Description
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
Name Description
builderForValue ExistenceFilter.Builder
Returns
Type Description
ListenResponse.Builder

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

public ListenResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListenResponse.Builder
Overrides

setTargetChange(TargetChange value)

public ListenResponse.Builder setTargetChange(TargetChange value)

Targets have changed.

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

Parameter
Name Description
value TargetChange
Returns
Type Description
ListenResponse.Builder

setTargetChange(TargetChange.Builder builderForValue)

public ListenResponse.Builder setTargetChange(TargetChange.Builder builderForValue)

Targets have changed.

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

Parameter
Name Description
builderForValue TargetChange.Builder
Returns
Type Description
ListenResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ListenResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListenResponse.Builder
Overrides