Class: Google::Firestore::V1beta1::CreateDocumentRequest

Inherits:

Object

• Object
• Google::Firestore::V1beta1::CreateDocumentRequest

Defined in:

lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

Overview

The request for Firestore::CreateDocument.

Instance Attribute Summary

• #collection_id ⇒ String

  The collection ID, relative to +parent+, to list.

• #document ⇒ Google::Firestore::V1beta1::Document

  The document to create.

• #document_id ⇒ String

  The client-assigned document ID to use for this document.

• #mask ⇒ Google::Firestore::V1beta1::DocumentMask

  The fields to return.

• #parent ⇒ String

  The parent resource.

Instance Attribute Details

#collection_id ⇒ String

Returns The collection ID, relative to +parent+, to list. For example: +chatrooms+.

Returns:

• (String) —

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

# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 116

class CreateDocumentRequest; end

#document ⇒ Google::Firestore::V1beta1::Document

Returns The document to create. +name+ must not be set.

Returns:

• (Google::Firestore::V1beta1::Document) —

  The document to create. +name+ must not be set.

# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 116

class CreateDocumentRequest; end

#document_id ⇒ String

Returns The client-assigned document ID to use for this document.

Optional. If not specified, an ID will be assigned by the service.

Returns:

• (String) —

  The client-assigned document ID to use for this document.

  Optional. If not specified, an ID will be assigned by the service.

# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 116

class CreateDocumentRequest; end

#mask ⇒ Google::Firestore::V1beta1::DocumentMask

Returns 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.

Returns:

• (Google::Firestore::V1beta1::DocumentMask) —

  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.

# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 116

class CreateDocumentRequest; end

#parent ⇒ String

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

Returns:

• (String) —

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

# File 'lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb', line 116

class CreateDocumentRequest; end