Class ListenRequest (3.6.0)

public final class ListenRequest extends GeneratedMessageV3 implements ListenRequestOrBuilder

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

Static Fields

ADD_TARGET_FIELD_NUMBER

public static final int ADD_TARGET_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

REMOVE_TARGET_FIELD_NUMBER

public static final int REMOVE_TARGET_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListenRequest getDefaultInstance()
Returns
TypeDescription
ListenRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListenRequest prototype)

public static ListenRequest.Builder newBuilder(ListenRequest prototype)
Parameter
NameDescription
prototypeListenRequest
Returns
TypeDescription
ListenRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getAddTarget()

public Target getAddTarget()

A target to add to this stream.

.google.firestore.v1.Target add_target = 2;

Returns
TypeDescription
Target

The addTarget.

getAddTargetOrBuilder()

public TargetOrBuilder getAddTargetOrBuilder()

A target to add to this stream.

.google.firestore.v1.Target add_target = 2;

Returns
TypeDescription
TargetOrBuilder

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public ListenRequest getDefaultInstanceForType()
Returns
TypeDescription
ListenRequest

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this target change.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this target change.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this target change.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

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

getRemoveTarget()

public int getRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
TypeDescription
int

The removeTarget.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetChangeCase()

public ListenRequest.TargetChangeCase getTargetChangeCase()
Returns
TypeDescription
ListenRequest.TargetChangeCase

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasAddTarget()

public boolean hasAddTarget()

A target to add to this stream.

.google.firestore.v1.Target add_target = 2;

Returns
TypeDescription
boolean

Whether the addTarget field is set.

hasRemoveTarget()

public boolean hasRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
TypeDescription
boolean

Whether the removeTarget field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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