Class ListenResponse (3.11.0)

public final class ListenResponse extends GeneratedMessageV3 implements ListenResponseOrBuilder

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

Static Fields

DOCUMENT_CHANGE_FIELD_NUMBER

public static final int DOCUMENT_CHANGE_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_DELETE_FIELD_NUMBER

public static final int DOCUMENT_DELETE_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_REMOVE_FIELD_NUMBER

public static final int DOCUMENT_REMOVE_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_CHANGE_FIELD_NUMBER

public static final int TARGET_CHANGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListenResponse getDefaultInstance()
Returns
TypeDescription
ListenResponse

getDescriptor()

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

newBuilder()

public static ListenResponse.Builder newBuilder()
Returns
TypeDescription
ListenResponse.Builder

newBuilder(ListenResponse prototype)

public static ListenResponse.Builder newBuilder(ListenResponse prototype)
Parameter
NameDescription
prototypeListenResponse
Returns
TypeDescription
ListenResponse.Builder

parseDelimitedFrom(InputStream input)

public static ListenResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListenResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListenResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListenResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListenResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListenResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListenResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListenResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListenResponse> parser()
Returns
TypeDescription
Parser<ListenResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListenResponse getDefaultInstanceForType()
Returns
TypeDescription
ListenResponse

getDocumentChange()

public DocumentChange getDocumentChange()

A Document has changed.

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

Returns
TypeDescription
DocumentChange

The documentChange.

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.

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.

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.

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

getParserForType()

public Parser<ListenResponse> getParserForType()
Returns
TypeDescription
Parser<ListenResponse>
Overrides

getResponseTypeCase()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetChange()

public TargetChange getTargetChange()

Targets have changed.

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

Returns
TypeDescription
TargetChange

The targetChange.

getTargetChangeOrBuilder()

public TargetChangeOrBuilder getTargetChangeOrBuilder()

Targets have changed.

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

Returns
TypeDescription
TargetChangeOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListenResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListenResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException