Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

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

Additional information of a recommendation engine.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

Returns a new instance of GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata.



1846
1847
1848
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1846

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

Instance Attribute Details

#data_state ⇒ String

Output only. The state of data requirements for this engine: DATA_OK and DATA_ERROR. Engine cannot be trained if the data is in DATA_ERROR state. Engine can have DATA_ERROR state even if serving state is ACTIVE: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training. Corresponds to the JSON property dataState

Returns:

  • (String) 


1823
1824
1825
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1823

def data_state
  @data_state
end

#last_tune_time ⇒ String

Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. Corresponds to the JSON property lastTuneTime

Returns:

  • (String) 


1829
1830
1831
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1829

def last_tune_time
  @last_tune_time
end

#serving_state ⇒ String

Output only. The serving state of the engine: ACTIVE, NOT_ACTIVE. Corresponds to the JSON property servingState

Returns:

  • (String) 


1834
1835
1836
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1834

def serving_state
  @serving_state
end

#tuning_operation ⇒ String

Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. Corresponds to the JSON property tuningOperation

Returns:

  • (String) 


1844
1845
1846
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1844

def tuning_operation
  @tuning_operation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1851
1852
1853
1854
1855
1856
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1851

def update!(**args)
  @data_state = args[:data_state] if args.key?(:data_state)
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
  @serving_state = args[:serving_state] if args.key?(:serving_state)
  @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
end