Class ListenRequest (3.21.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
Type Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_TARGET_FIELD_NUMBER

public static final int REMOVE_TARGET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListenRequest getDefaultInstance()
Returns
Type Description
ListenRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListenRequest.Builder newBuilder()
Returns
Type Description
ListenRequest.Builder

newBuilder(ListenRequest prototype)

public static ListenRequest.Builder newBuilder(ListenRequest prototype)
Parameter
Name Description
prototype ListenRequest
Returns
Type Description
ListenRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListenRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListenRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListenRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListenRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListenRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListenRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListenRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListenRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListenRequest> parser()
Returns
Type Description
Parser<ListenRequest>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddTarget()

public Target getAddTarget()

A target to add to this stream.

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

Returns
Type Description
Target

The addTarget.

getAddTargetOrBuilder()

public TargetOrBuilder getAddTargetOrBuilder()

A target to add to this stream.

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

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

The bytes for database.

getDefaultInstanceForType()

public ListenRequest getDefaultInstanceForType()
Returns
Type Description
ListenRequest

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels associated with this target change.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this target change.

map<string, string> labels = 4;

Returns
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<ListenRequest> getParserForType()
Returns
Type Description
Parser<ListenRequest>
Overrides

getRemoveTarget()

public int getRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
Type Description
int

The removeTarget.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetChangeCase()

public ListenRequest.TargetChangeCase getTargetChangeCase()
Returns
Type Description
ListenRequest.TargetChangeCase

hasAddTarget()

public boolean hasAddTarget()

A target to add to this stream.

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

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

Whether the removeTarget field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListenRequest.Builder newBuilderForType()
Returns
Type Description
ListenRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListenRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListenRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListenRequest.Builder toBuilder()
Returns
Type Description
ListenRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException