Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Document captures all raw metadata information of items to be recommended or searched.
Instance Attribute Summary collapse
-
#id ⇒ String
Immutable.
-
#json_data ⇒ String
The JSON string representation of the document.
-
#name ⇒ String
Immutable.
-
#parent_document_id ⇒ String
The identifier of the parent document.
-
#schema_id ⇒ String
The identifier of the schema located in the same data store.
-
#struct_data ⇒ Hash<String,Object>
The structured JSON data for the document.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocument
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaDocument.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocument
Returns a new instance of GoogleCloudDiscoveryengineV1alphaDocument.
427 428 429 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 427 def initialize(**args) update!(**args) end |
Instance Attribute Details
#id ⇒ String
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63
characters.
Corresponds to the JSON property id
393 394 395 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 393 def id @id end |
#json_data ⇒ String
The JSON string representation of the document. It should conform to the
registered schema or an INVALID_ARGUMENT error is thrown.
Corresponds to the JSON property jsonData
399 400 401 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 399 def json_data @json_data end |
#name ⇒ String
Immutable. The full resource name of the document. Format: projects/
project/
locations/
location/collections/
collection/dataStores/
data_store/branches/
branch/documents/
document_id`. This field must be a UTF-8 encoded string
with a length limit of 1024 characters.
Corresponds to the JSON property
name`
407 408 409 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 407 def name @name end |
#parent_document_id ⇒ String
The identifier of the parent document. Currently supports at most two level
document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.
Corresponds to the JSON property parentDocumentId
414 415 416 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 414 def parent_document_id @parent_document_id end |
#schema_id ⇒ String
The identifier of the schema located in the same data store.
Corresponds to the JSON property schemaId
419 420 421 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 419 def schema_id @schema_id end |
#struct_data ⇒ Hash<String,Object>
The structured JSON data for the document. It should conform to the registered
schema or an INVALID_ARGUMENT error is thrown.
Corresponds to the JSON property structData
425 426 427 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 425 def struct_data @struct_data end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
432 433 434 435 436 437 438 439 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 432 def update!(**args) @id = args[:id] if args.key?(:id) @json_data = args[:json_data] if args.key?(:json_data) @name = args[:name] if args.key?(:name) @parent_document_id = args[:parent_document_id] if args.key?(:parent_document_id) @schema_id = args[:schema_id] if args.key?(:schema_id) @struct_data = args[:struct_data] if args.key?(:struct_data) end |