Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Document captures all raw metadata information of items to be recommended or searched.
Instance Attribute Summary collapse
-
#content ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentContent
Unstructured data linked to this document.
-
#derived_struct_data ⇒ Hash<String,Object>
Output only.
-
#id ⇒ String
Immutable.
-
#index_time ⇒ String
Output only.
-
#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) ⇒ GoogleCloudDiscoveryengineV1Document
constructor
A new instance of GoogleCloudDiscoveryengineV1Document.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Document
Returns a new instance of GoogleCloudDiscoveryengineV1Document.
3335 3336 3337 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3335 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentContent
Unstructured data linked to this document.
Corresponds to the JSON property content
3281 3282 3283 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3281 def content @content end |
#derived_struct_data ⇒ Hash<String,Object>
Output only. This field is OUTPUT_ONLY. It contains derived data that are not
in the original input document.
Corresponds to the JSON property derivedStructData
3287 3288 3289 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3287 def derived_struct_data @derived_struct_data end |
#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
3294 3295 3296 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3294 def id @id end |
#index_time ⇒ String
Output only. The last time the document was indexed. If this field is set, the
document could be returned in search results. This field is OUTPUT_ONLY. If
this field is not populated, it means the document has never been indexed.
Corresponds to the JSON property indexTime
3301 3302 3303 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3301 def index_time @index_time 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
3307 3308 3309 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3307 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`
3315 3316 3317 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3315 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
3322 3323 3324 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3322 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
3327 3328 3329 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3327 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
3333 3334 3335 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3333 def struct_data @struct_data end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3340 def update!(**args) @content = args[:content] if args.key?(:content) @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data) @id = args[:id] if args.key?(:id) @index_time = args[:index_time] if args.key?(:index_time) @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 |