Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::CreateDocumentRequest (v1.2.0)

Version 1.2.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::CreateDocumentRequest.

Request message for DocumentService.CreateDocument method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#document

def document() -> ::Google::Cloud::DiscoveryEngine::V1::Document

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Document) — Required. The Document to create.

#document=

def document=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Document

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Document) — Required. The Document to create.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Document) — Required. The Document to create.

#document_id

def document_id() -> ::String

Returns

• (::String) — Required. The ID to use for the Document, which becomes the final component of the Document.name.

  If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#document_id=

def document_id=(value) -> ::String

Parameter

• value (::String) — Required. The ID to use for the Document, which becomes the final component of the Document.name.

  If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

• (::String) — Required. The ID to use for the Document, which becomes the final component of the Document.name.

  If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

  This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

  This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

#parent

def parent() -> ::String

Returns

• (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns

• (::String) — Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.