Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::UpdateDocumentRequest (v0.12.0)

Version latest

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::UpdateDocumentRequest.

Request message for DocumentService.UpdateDocument method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#allow_missing

def allow_missing() -> ::Boolean

Returns

• (::Boolean) — If set to true and the Document is not found, a new Document is be created.

#allow_missing=

def allow_missing=(value) -> ::Boolean

Parameter

• value (::Boolean) — If set to true and the Document is not found, a new Document is be created.

Returns

• (::Boolean) — If set to true and the Document is not found, a new Document is be created.

#document

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

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Document) — Required. The document to update/create.

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

  If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

#document=

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

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Document) — Required. The document to update/create.

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

  If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Document) — Required. The document to update/create.

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

  If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

#update_mask

def update_mask() -> ::Google::Protobuf::FieldMask

Returns

• (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

#update_mask=

def update_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

• value (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.

Returns

• (::Google::Protobuf::FieldMask) — Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.