Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentInfo

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

Detailed document information associated with a user event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaDocumentInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaDocumentInfo.



789
790
791
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 789

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

Instance Attribute Details

#id ⇒ String

Required. The Document resource ID. Corresponds to the JSON property id

Returns:

  • (String) 


760
761
762
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 760

def id
  @id
end

#name ⇒ String

Required. The Document resource full name, of the form: projects/project_id/ locations/location/collections/collection_id/dataStores/data_store_id/ branches/branch_id/documents/document_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


767
768
769
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 767

def name
  @name
end

#promotion_ids ⇒ Array<String>

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. Corresponds to the JSON property promotionIds

Returns:

  • (Array<String>) 


773
774
775
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 773

def promotion_ids
  @promotion_ids
end

#quantity ⇒ Fixnum

Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types: * add-to-cart * purchase Corresponds to the JSON property quantity

Returns:

  • (Fixnum) 


781
782
783
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 781

def quantity
  @quantity
end

#uri ⇒ String

Required. The Document url - only allowed for DataStores with content_config PUBLIC_WEBSITE. Corresponds to the JSON property uri

Returns:

  • (String) 


787
788
789
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 787

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



794
795
796
797
798
799
800
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 794

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids)
  @quantity = args[:quantity] if args.key?(:quantity)
  @uri = args[:uri] if args.key?(:uri)
end