Class ListenRequest.Builder (3.17.0)

public static final class ListenRequest.Builder extends GeneratedMessageV3.Builder<ListenRequest.Builder> implements ListenRequestOrBuilder

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListenRequest build()
Returns
TypeDescription
ListenRequest

buildPartial()

public ListenRequest buildPartial()
Returns
TypeDescription
ListenRequest

clear()

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

clearAddTarget()

public ListenRequest.Builder clearAddTarget()

A target to add to this stream.

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

Returns
TypeDescription
ListenRequest.Builder

clearDatabase()

public ListenRequest.Builder clearDatabase()

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

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

Returns
TypeDescription
ListenRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRemoveTarget()

public ListenRequest.Builder clearRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
TypeDescription
ListenRequest.Builder

This builder for chaining.

clearTargetChange()

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

clone()

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

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

getAddTarget()

public Target getAddTarget()

A target to add to this stream.

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

Returns
TypeDescription
Target

The addTarget.

getAddTargetBuilder()

public Target.Builder getAddTargetBuilder()

A target to add to this stream.

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

Returns
TypeDescription
Target.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getRemoveTarget()

public int getRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
TypeDescription
int

The removeTarget.

getTargetChangeCase()

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAddTarget(Target value)

public ListenRequest.Builder mergeAddTarget(Target value)

A target to add to this stream.

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

Parameter
NameDescription
valueTarget
Returns
TypeDescription
ListenRequest.Builder

mergeFrom(ListenRequest other)

public ListenRequest.Builder mergeFrom(ListenRequest other)
Parameter
NameDescription
otherListenRequest
Returns
TypeDescription
ListenRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

public ListenRequest.Builder putAllLabels(Map<String,String> values)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
ListenRequest.Builder

putLabels(String key, String value)

public ListenRequest.Builder putLabels(String key, String value)

Labels associated with this target change.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
ListenRequest.Builder

removeLabels(String key)

public ListenRequest.Builder removeLabels(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
ListenRequest.Builder

setAddTarget(Target value)

public ListenRequest.Builder setAddTarget(Target value)

A target to add to this stream.

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

Parameter
NameDescription
valueTarget
Returns
TypeDescription
ListenRequest.Builder

setAddTarget(Target.Builder builderForValue)

public ListenRequest.Builder setAddTarget(Target.Builder builderForValue)

A target to add to this stream.

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

Parameter
NameDescription
builderForValueTarget.Builder
Returns
TypeDescription
ListenRequest.Builder

setDatabase(String value)

public ListenRequest.Builder setDatabase(String value)

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

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

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
ListenRequest.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public ListenRequest.Builder setDatabaseBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
ListenRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setRemoveTarget(int value)

public ListenRequest.Builder setRemoveTarget(int value)

The ID of a target to remove from this stream.

int32 remove_target = 3;

Parameter
NameDescription
valueint

The removeTarget to set.

Returns
TypeDescription
ListenRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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