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.



610
611
612
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 610

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

Instance Attribute Details

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


576
577
578
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 576

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) 


582
583
584
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 582

def json_data
  @json_data
end

#name ⇒ String

Immutable. The full resource name of the document. Format: projects/project/ locations/location/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) 


590
591
592
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 590

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) 


597
598
599
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 597

def parent_document_id
  @parent_document_id
end

#schema_id ⇒ String

Required. The identifier of the schema located in the same data store. Corresponds to the JSON property schemaId

Returns:

  • (String) 


602
603
604
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 602

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


608
609
610
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 608

def struct_data
  @struct_data
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



615
616
617
618
619
620
621
622
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 615

def update!(**args)
  @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