Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocument

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDocument.



5071
5072
5073
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5071

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

Instance Attribute Details

#acl_info ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentAclInfo

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

Returns:



5012
5013
5014
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5012

def acl_info
  @acl_info
end

#content ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentContent

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

Returns:



5017
5018
5019
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5017

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


5023
5024
5025
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5023

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) 


5030
5031
5032
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5030

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) 


5037
5038
5039
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5037

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) 


5043
5044
5045
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5043

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) 


5051
5052
5053
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5051

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) 


5058
5059
5060
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5058

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) 


5063
5064
5065
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5063

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


5069
5070
5071
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5069

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5076

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