Class: Google::Cloud::DiscoveryEngine::V1beta::UpdateDocumentRequest

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1beta::UpdateDocumentRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb

Overview

Request message for DocumentService.UpdateDocument method.

Instance Attribute Summary

• #allow_missing ⇒ ::Boolean

  If set to true, and the Document is not found, a new Document will be created.

• #document ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Document

  Required.

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

  Indicates which fields in the provided imported 'document' to update.

Instance Attribute Details

#allow_missing ⇒ ::Boolean

Returns If set to true, and the Document is not found, a new Document will be created.

Returns:

• (::Boolean) —

  If set to true, and the Document is not found, a new Document will be created.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb', line 159

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

#document ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::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:

• (::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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb', line 159

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, will by default update all fields.

Returns:

• (::Google::Protobuf::FieldMask) —

  Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb', line 159

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