Class: Google::Cloud::DiscoveryEngine::V1::CreateDocumentRequest

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.CreateDocument method.

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Required. The Document to create.

Returns:



129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 129

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

#document_id ⇒ ::String

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



129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 129

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

#parent ⇒ ::String

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



129
130
131
132
 
# File 'proto_docs/google/cloud/discoveryengine/v1/document_service.rb', line 129

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