com.google.firestore.v1

Class CreateDocumentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.CreateDocumentRequest

All Implemented Interfaces:

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

public final class CreateDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateDocumentRequestOrBuilder

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

Protobuf type google.firestore.v1.CreateDocumentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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	COLLECTION_ID_FIELD_NUMBER
static int	DOCUMENT_FIELD_NUMBER
static int	DOCUMENT_ID_FIELD_NUMBER
static int	MASK_FIELD_NUMBER
static int	PARENT_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	equals(Object obj)
String	getCollectionId() Required.
com.google.protobuf.ByteString	getCollectionIdBytes() Required.
static CreateDocumentRequest	getDefaultInstance()
CreateDocumentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document	getDocument() Required.
String	getDocumentId() The client-assigned document ID to use for this document.
com.google.protobuf.ByteString	getDocumentIdBytes() The client-assigned document ID to use for this document.
DocumentOrBuilder	getDocumentOrBuilder() Required.
DocumentMask	getMask() The fields to return.
DocumentMaskOrBuilder	getMaskOrBuilder() The fields to return.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<CreateDocumentRequest>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasDocument() Required.
int	hashCode()
boolean	hasMask() The fields to return.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static CreateDocumentRequest.Builder	newBuilder()
static CreateDocumentRequest.Builder	newBuilder(CreateDocumentRequest prototype)
CreateDocumentRequest.Builder	newBuilderForType()
protected CreateDocumentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CreateDocumentRequest	parseDelimitedFrom(InputStream input)
static CreateDocumentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateDocumentRequest	parseFrom(byte[] data)
static CreateDocumentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateDocumentRequest	parseFrom(ByteBuffer data)
static CreateDocumentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateDocumentRequest	parseFrom(com.google.protobuf.ByteString data)
static CreateDocumentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static CreateDocumentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CreateDocumentRequest	parseFrom(InputStream input)
static CreateDocumentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CreateDocumentRequest>	parser()
CreateDocumentRequest.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, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

COLLECTION_ID_FIELD_NUMBER

public static final int COLLECTION_ID_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER

See Also:

Constant Field Values

MASK_FIELD_NUMBER

public static final int MASK_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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getParent

public String getParent()

 Required. The parent resource. For example:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
 

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

Specified by:

getParent in interface CreateDocumentRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource. For example:
 `projects/{project_id}/databases/{database_id}/documents` or
 `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
 

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

Specified by:

getParentBytes in interface CreateDocumentRequestOrBuilder

Returns:

The bytes for parent.

getCollectionId

public String getCollectionId()

 Required. The collection ID, relative to `parent`, to list. For example:
 `chatrooms`.
 

string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCollectionId in interface CreateDocumentRequestOrBuilder

Returns:

The collectionId.

getCollectionIdBytes

public com.google.protobuf.ByteString getCollectionIdBytes()

 Required. The collection ID, relative to `parent`, to list. For example:
 `chatrooms`.
 

string collection_id = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getCollectionIdBytes in interface CreateDocumentRequestOrBuilder

Returns:

The bytes for collectionId.

getDocumentId

public String getDocumentId()

 The client-assigned document ID to use for this document.
 Optional. If not specified, an ID will be assigned by the service.
 

string document_id = 3;

Specified by:

getDocumentId in interface CreateDocumentRequestOrBuilder

Returns:

The documentId.

getDocumentIdBytes

public com.google.protobuf.ByteString getDocumentIdBytes()

 The client-assigned document ID to use for this document.
 Optional. If not specified, an ID will be assigned by the service.
 

string document_id = 3;

Specified by:

getDocumentIdBytes in interface CreateDocumentRequestOrBuilder

Returns:

The bytes for documentId.

hasDocument

public boolean hasDocument()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasDocument in interface CreateDocumentRequestOrBuilder

Returns:

Whether the document field is set.

getDocument

public Document getDocument()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDocument in interface CreateDocumentRequestOrBuilder

Returns:

The document.

getDocumentOrBuilder

public DocumentOrBuilder getDocumentOrBuilder()

 Required. The document to create. `name` must not be set.
 

.google.firestore.v1.Document document = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDocumentOrBuilder in interface CreateDocumentRequestOrBuilder

hasMask

public boolean hasMask()

 The fields to return. If not set, returns all fields.
 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
 

.google.firestore.v1.DocumentMask mask = 5;

Specified by:

hasMask in interface CreateDocumentRequestOrBuilder

Returns:

Whether the mask field is set.

getMask

public DocumentMask getMask()

 The fields to return. If not set, returns all fields.
 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
 

.google.firestore.v1.DocumentMask mask = 5;

Specified by:

getMask in interface CreateDocumentRequestOrBuilder

Returns:

The mask.

getMaskOrBuilder

public DocumentMaskOrBuilder getMaskOrBuilder()

 The fields to return. If not set, returns all fields.
 If the document has a field that is not present in this mask, that field
 will not be returned in the response.
 

.google.firestore.v1.DocumentMask mask = 5;

Specified by:

getMaskOrBuilder in interface CreateDocumentRequestOrBuilder

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 CreateDocumentRequest parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CreateDocumentRequest parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static CreateDocumentRequest parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public CreateDocumentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CreateDocumentRequest.Builder newBuilder()

newBuilder

public static CreateDocumentRequest.Builder newBuilder(CreateDocumentRequest prototype)

toBuilder

public CreateDocumentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CreateDocumentRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<CreateDocumentRequest> 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 CreateDocumentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder