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.



2523
2524
2525
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2523

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

Instance Attribute Details

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

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

Returns:



2476
2477
2478
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2476

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


2482
2483
2484
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2482

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) 


2489
2490
2491
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2489

def id
  @id
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) 


2495
2496
2497
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2495

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) 


2503
2504
2505
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2503

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) 


2510
2511
2512
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2510

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) 


2515
2516
2517
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2515

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


2521
2522
2523
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2521

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2528

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