Class: Google::Cloud::DiscoveryEngine::V1::UpdateDocumentRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/document_service.rb

Overview

Request message for DocumentService.UpdateDocument method.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_missing ⇒ ::Boolean

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



158
159
160
161
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 158

class UpdateDocumentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#document ⇒ ::Google::Cloud::DiscoveryEngine::V1::Document

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



158
159
160
161
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 158

class UpdateDocumentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_mask ⇒ ::Google::Protobuf::FieldMask

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



158
159
160
161
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 158

class UpdateDocumentRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end