com.google.firestore.v1

Class BatchWriteRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.BatchWriteRequest

All Implemented Interfaces:

BatchWriteRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class BatchWriteRequest
extends com.google.protobuf.GeneratedMessageV3
implements BatchWriteRequestOrBuilder

 The request for [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].
 

Protobuf type google.firestore.v1.BatchWriteRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchWriteRequest.Builder The request for [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABASE_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	WRITES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels associated with this batch write.
boolean	equals(Object obj)
String	getDatabase() Required.
com.google.protobuf.ByteString	getDatabaseBytes() Required.
static BatchWriteRequest	getDefaultInstance()
BatchWriteRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels associated with this batch write.
Map<String,String>	getLabelsMap() Labels associated with this batch write.
String	getLabelsOrDefault(String key, String defaultValue) Labels associated with this batch write.
String	getLabelsOrThrow(String key) Labels associated with this batch write.
com.google.protobuf.Parser<BatchWriteRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
Write	getWrites(int index) The writes to apply.
int	getWritesCount() The writes to apply.
List<Write>	getWritesList() The writes to apply.
WriteOrBuilder	getWritesOrBuilder(int index) The writes to apply.
List<? extends WriteOrBuilder>	getWritesOrBuilderList() The writes to apply.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static BatchWriteRequest.Builder	newBuilder()
static BatchWriteRequest.Builder	newBuilder(BatchWriteRequest prototype)
BatchWriteRequest.Builder	newBuilderForType()
protected BatchWriteRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BatchWriteRequest	parseDelimitedFrom(InputStream input)
static BatchWriteRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchWriteRequest	parseFrom(byte[] data)
static BatchWriteRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchWriteRequest	parseFrom(ByteBuffer data)
static BatchWriteRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchWriteRequest	parseFrom(com.google.protobuf.ByteString data)
static BatchWriteRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchWriteRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static BatchWriteRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BatchWriteRequest	parseFrom(InputStream input)
static BatchWriteRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BatchWriteRequest>	parser()
BatchWriteRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER

See Also:

Constant Field Values

WRITES_FIELD_NUMBER

public static final int WRITES_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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];

Specified by:

getDatabase in interface BatchWriteRequestOrBuilder

Returns:

The database.

getDatabaseBytes

public com.google.protobuf.ByteString getDatabaseBytes()

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

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

Specified by:

getDatabaseBytes in interface BatchWriteRequestOrBuilder

Returns:

The bytes for database.

getWritesList

public List<Write> getWritesList()

 The writes to apply.
 Method does not apply writes atomically and does not guarantee ordering.
 Each write succeeds or fails independently. You cannot write to the same
 document more than once per request.
 

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

Specified by:

getWritesList in interface BatchWriteRequestOrBuilder

getWritesOrBuilderList

public List<? extends WriteOrBuilder> getWritesOrBuilderList()

 The writes to apply.
 Method does not apply writes atomically and does not guarantee ordering.
 Each write succeeds or fails independently. You cannot write to the same
 document more than once per request.
 

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

Specified by:

getWritesOrBuilderList in interface BatchWriteRequestOrBuilder

getWritesCount

public int getWritesCount()

 The writes to apply.
 Method does not apply writes atomically and does not guarantee ordering.
 Each write succeeds or fails independently. You cannot write to the same
 document more than once per request.
 

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

Specified by:

getWritesCount in interface BatchWriteRequestOrBuilder

getWrites

public Write getWrites(int index)

 The writes to apply.
 Method does not apply writes atomically and does not guarantee ordering.
 Each write succeeds or fails independently. You cannot write to the same
 document more than once per request.
 

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

Specified by:

getWrites in interface BatchWriteRequestOrBuilder

getWritesOrBuilder

public WriteOrBuilder getWritesOrBuilder(int index)

 The writes to apply.
 Method does not apply writes atomically and does not guarantee ordering.
 Each write succeeds or fails independently. You cannot write to the same
 document more than once per request.
 

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

Specified by:

getWritesOrBuilder in interface BatchWriteRequestOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: BatchWriteRequestOrBuilder

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsCount in interface BatchWriteRequestOrBuilder

containsLabels

public boolean containsLabels(String key)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

containsLabels in interface BatchWriteRequestOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface BatchWriteRequestOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsMap in interface BatchWriteRequestOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsOrDefault in interface BatchWriteRequestOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsOrThrow in interface BatchWriteRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BatchWriteRequest parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BatchWriteRequest parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static BatchWriteRequest parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchWriteRequest parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static BatchWriteRequest parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static BatchWriteRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static BatchWriteRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public BatchWriteRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BatchWriteRequest.Builder newBuilder()

newBuilder

public static BatchWriteRequest.Builder newBuilder(BatchWriteRequest prototype)

toBuilder

public BatchWriteRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BatchWriteRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BatchWriteRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<BatchWriteRequest> parser()

getParserForType

public com.google.protobuf.Parser<BatchWriteRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BatchWriteRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder