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.



2714
2715
2716
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2714

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:



2660
2661
2662
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2660

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>) 


2666
2667
2668
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2666

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) 


2673
2674
2675
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2673

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

Returns:

  • (String) 


2680
2681
2682
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2680

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) 


2686
2687
2688
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2686

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) 


2694
2695
2696
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2694

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) 


2701
2702
2703
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2701

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) 


2706
2707
2708
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2706

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>) 


2712
2713
2714
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2712

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2719

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