Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocument

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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) ⇒ GoogleCloudDiscoveryengineV1betaDocument

Returns a new instance of GoogleCloudDiscoveryengineV1betaDocument.



24698
24699
24700
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24698

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#acl_info ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentAclInfo

ACL Information of the Document. Corresponds to the JSON property aclInfo

Returns:



24632
24633
24634
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24632

def acl_info
  @acl_info
end

#content ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentContent

Unstructured data linked to this document. Corresponds to the JSON property content

Returns:



24637
24638
24639
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24637

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


24643
24644
24645
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24643

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 128 characters. Corresponds to the JSON property id

Returns:

  • (String) 


24650
24651
24652
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24650

def id
  @id
end

#index_status ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaDocumentIndexStatus

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

Returns:



24655
24656
24657
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24655

def index_status
  @index_status
end

#index_time ⇒ String

Output only. The time when the document was last indexed. If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours. If this field is not populated, it means the document has never been indexed. Corresponds to the JSON property indexTime

Returns:

  • (String) 


24664
24665
24666
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24664

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) 


24670
24671
24672
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24670

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) 


24678
24679
24680
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24678

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) 


24685
24686
24687
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24685

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) 


24690
24691
24692
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24690

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


24696
24697
24698
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24696

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24703
24704
24705
24706
24707
24708
24709
24710
24711
24712
24713
24714
24715
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24703

def update!(**args)
  @acl_info = args[:acl_info] if args.key?(:acl_info)
  @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