Class WriteRequest.Builder

public static final class WriteRequest.Builder extends GeneratedMessageV3.Builder<WriteRequest.Builder> implements WriteRequestOrBuilder

The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

Protobuf type google.firestore.v1.WriteRequest

Methods

addAllWrites(Iterable<? extends Write> values)

public WriteRequest.Builder addAllWrites(Iterable<? extends Write> values)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
valuesIterable<? extends com.google.firestore.v1.Write>
Returns
TypeDescription
WriteRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addWrites(Write value)

public WriteRequest.Builder addWrites(Write value)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
valueWrite
Returns
TypeDescription
WriteRequest.Builder

addWrites(Write.Builder builderForValue)

public WriteRequest.Builder addWrites(Write.Builder builderForValue)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
builderForValueWrite.Builder
Returns
TypeDescription
WriteRequest.Builder

addWrites(int index, Write value)

public WriteRequest.Builder addWrites(int index, Write value)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameters
NameDescription
indexint
valueWrite
Returns
TypeDescription
WriteRequest.Builder

addWrites(int index, Write.Builder builderForValue)

public WriteRequest.Builder addWrites(int index, Write.Builder builderForValue)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameters
NameDescription
indexint
builderForValueWrite.Builder
Returns
TypeDescription
WriteRequest.Builder

addWritesBuilder()

public Write.Builder addWritesBuilder()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
Write.Builder

addWritesBuilder(int index)

public Write.Builder addWritesBuilder(int index)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Write.Builder

build()

public WriteRequest build()
Returns
TypeDescription
WriteRequest

buildPartial()

public WriteRequest buildPartial()
Returns
TypeDescription
WriteRequest

clear()

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

clearDatabase()

public WriteRequest.Builder clearDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

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

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStreamId()

public WriteRequest.Builder clearStreamId()

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

string stream_id = 2;

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

clearStreamToken()

public WriteRequest.Builder clearStreamToken()

A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.

bytes stream_token = 4;

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

clearWrites()

public WriteRequest.Builder clearWrites()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
WriteRequest.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Labels associated with this write request.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

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}. This is only required in the first message.

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

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public WriteRequest getDefaultInstanceForType()
Returns
TypeDescription
WriteRequest

getDescriptor()

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

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 write request.

map<string, string> labels = 5;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels associated with this write request.

map<string, string> labels = 5;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels associated with this write request.

map<string, string> labels = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels associated with this write request.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getStreamId()

public String getStreamId()

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

string stream_id = 2;

Returns
TypeDescription
String

The streamId.

getStreamIdBytes()

public ByteString getStreamIdBytes()

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

string stream_id = 2;

Returns
TypeDescription
ByteString

The bytes for streamId.

getStreamToken()

public ByteString getStreamToken()

A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.

bytes stream_token = 4;

Returns
TypeDescription
ByteString

The streamToken.

getWrites(int index)

public Write getWrites(int index)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Write

getWritesBuilder(int index)

public Write.Builder getWritesBuilder(int index)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Write.Builder

getWritesBuilderList()

public List<Write.Builder> getWritesBuilderList()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
List<Builder>

getWritesCount()

public int getWritesCount()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
int

getWritesList()

public List<Write> getWritesList()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
List<Write>

getWritesOrBuilder(int index)

public WriteOrBuilder getWritesOrBuilder(int index)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
WriteOrBuilder

getWritesOrBuilderList()

public List<? extends WriteOrBuilder> getWritesOrBuilderList()

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Returns
TypeDescription
List<? extends com.google.firestore.v1.WriteOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(WriteRequest other)

public WriteRequest.Builder mergeFrom(WriteRequest other)
Parameter
NameDescription
otherWriteRequest
Returns
TypeDescription
WriteRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

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

Labels associated with this write request.

map<string, string> labels = 5;

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

putLabels(String key, String value)

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

Labels associated with this write request.

map<string, string> labels = 5;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
WriteRequest.Builder

removeLabels(String key)

public WriteRequest.Builder removeLabels(String key)

Labels associated with this write request.

map<string, string> labels = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
WriteRequest.Builder

removeWrites(int index)

public WriteRequest.Builder removeWrites(int index)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
WriteRequest.Builder

setDatabase(String value)

public WriteRequest.Builder setDatabase(String value)

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

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

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public WriteRequest.Builder setDatabaseBytes(ByteString value)

Required. The database name. In the format: projects/{project_id}/databases/{database_id}. This is only required in the first message.

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

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setStreamId(String value)

public WriteRequest.Builder setStreamId(String value)

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

string stream_id = 2;

Parameter
NameDescription
valueString

The streamId to set.

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

setStreamIdBytes(ByteString value)

public WriteRequest.Builder setStreamIdBytes(ByteString value)

The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.

string stream_id = 2;

Parameter
NameDescription
valueByteString

The bytes for streamId to set.

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

setStreamToken(ByteString value)

public WriteRequest.Builder setStreamToken(ByteString value)

A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the stream_id field. Leave this field unset when creating a new stream.

bytes stream_token = 4;

Parameter
NameDescription
valueByteString

The streamToken to set.

Returns
TypeDescription
WriteRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setWrites(int index, Write value)

public WriteRequest.Builder setWrites(int index, Write value)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameters
NameDescription
indexint
valueWrite
Returns
TypeDescription
WriteRequest.Builder

setWrites(int index, Write.Builder builderForValue)

public WriteRequest.Builder setWrites(int index, Write.Builder builderForValue)

The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests.

repeated .google.firestore.v1.Write writes = 3;

Parameters
NameDescription
indexint
builderForValueWrite.Builder
Returns
TypeDescription
WriteRequest.Builder