Class ListenRequest.Builder (3.30.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListenRequest.Builder

Implements

ListenRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListenRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListenRequest build()

Returns
Type	Description
`ListenRequest`

buildPartial()

public ListenRequest buildPartial()

Returns
Type	Description
`ListenRequest`

clear()

public ListenRequest.Builder clear()

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAddTarget()

public ListenRequest.Builder clearAddTarget()

A target to add to this stream.

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

Returns
Type	Description
`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
Type	Description
`ListenRequest.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListenRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public ListenRequest.Builder clearLabels()

Returns
Type	Description
`ListenRequest.Builder`

clearOneof(Descriptors.OneofDescriptor oneof)

public ListenRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRemoveTarget()

public ListenRequest.Builder clearRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
Type	Description
`ListenRequest.Builder`	This builder for chaining.

clearTargetChange()

public ListenRequest.Builder clearTargetChange()

Returns
Type	Description
`ListenRequest.Builder`

clone()

public ListenRequest.Builder clone()

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getAddTarget()

public Target getAddTarget()

A target to add to this stream.

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

Returns
Type	Description
`Target`	The addTarget.

getAddTargetBuilder()

public Target.Builder getAddTargetBuilder()

A target to add to this stream.

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

Returns
Type	Description
`Target.Builder`

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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`

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getRemoveTarget()

public int getRemoveTarget()

The ID of a target to remove from this stream.

int32 remove_target = 3;

Returns
Type	Description
`int`	The removeTarget.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeAddTarget(Target value)

public ListenRequest.Builder mergeAddTarget(Target value)

A target to add to this stream.

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

Parameter
Name	Description
`value`	`Target`

Returns
Type	Description
`ListenRequest.Builder`

mergeFrom(ListenRequest other)

public ListenRequest.Builder mergeFrom(ListenRequest other)

Parameter
Name	Description
`other`	`ListenRequest`

Returns
Type	Description
`ListenRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListenRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ListenRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListenRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`values`	`Map<String,String>`

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

Returns
Type	Description
`ListenRequest.Builder`

removeLabels(String key)

public ListenRequest.Builder removeLabels(String key)

Labels associated with this target change.

map<string, string> labels = 4;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`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
Name	Description
`value`	`Target`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`Target.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`String` The database to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for database to set.

Returns
Type	Description
`ListenRequest.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListenRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRemoveTarget(int value)

public ListenRequest.Builder setRemoveTarget(int value)

The ID of a target to remove from this stream.

int32 remove_target = 3;

Parameter
Name	Description
`value`	`int` The removeTarget to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListenRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ListenRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)