Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Document

Returns a new instance of GoogleCloudDiscoveryengineV1Document.



4391
4392
4393
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4391

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

Returns:



4332
4333
4334
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4332

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

Returns:

  • (Hash<String,Object>) 


4338
4339
4340
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4338

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

Returns:

  • (String) 


4345
4346
4347
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4345

def id
  @id
end

#index_status ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1DocumentIndexStatus

Index status of the document. Corresponds to the JSON property indexStatus

Returns:



4350
4351
4352
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4350

def index_status
  @index_status
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

Returns:

  • (String) 


4357
4358
4359
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4357

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

Returns:

  • (String) 


4363
4364
4365
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4363

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 propertyname`

Returns:

  • (String) 


4371
4372
4373
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4371

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

Returns:

  • (String) 


4378
4379
4380
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4378

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

Returns:

  • (String) 


4383
4384
4385
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4383

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

Returns:

  • (Hash<String,Object>) 


4389
4390
4391
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4389

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4396

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_status = args[:index_status] if args.key?(:index_status)
  @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