Class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Insight

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/recommender_v1/classes.rb,
generated/google/apis/recommender_v1/representations.rb,
generated/google/apis/recommender_v1/representations.rb

Overview

An insight along with the information used to derive the insight. The insight may have associated recomendations as well.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1Insight

Returns a new instance of GoogleCloudRecommenderV1Insight.



139
140
141
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 139

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

Instance Attribute Details

#associated_recommendations ⇒ Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightRecommendationReference>

Recommendations derived from this insight. Corresponds to the JSON property associatedRecommendations

Returns:



83
84
85
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 83

def associated_recommendations
  @associated_recommendations
end

#category ⇒ String

Category being targeted by the insight. Corresponds to the JSON property category

Returns:

  • (String) 


88
89
90
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 88

def category
  @category
end

#content ⇒ Hash<String,Object>

A struct of custom fields to explain the insight. Example: " grantedPermissionsCount": "1000" Corresponds to the JSON property content

Returns:

  • (Hash<String,Object>) 


94
95
96
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 94

def content
  @content
end

#description ⇒ String

Free-form human readable summary in English. The maximum length is 500 characters. Corresponds to the JSON property description

Returns:

  • (String) 


100
101
102
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 100

def description
  @description
end

#etag ⇒ String

Fingerprint of the Insight. Provides optimistic locking when updating states. Corresponds to the JSON property etag

Returns:

  • (String) 


105
106
107
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 105

def etag
  @etag
end

#insight_subtype ⇒ String

Insight subtype. Insight content schema will be stable for a given subtype. Corresponds to the JSON property insightSubtype

Returns:

  • (String) 


110
111
112
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 110

def insight_subtype
  @insight_subtype
end

#last_refresh_time ⇒ String

Timestamp of the latest data used to generate the insight. Corresponds to the JSON property lastRefreshTime

Returns:

  • (String) 


115
116
117
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 115

def last_refresh_time
  @last_refresh_time
end

#name ⇒ String

Name of the insight. Corresponds to the JSON property name

Returns:

  • (String) 


120
121
122
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 120

def name
  @name
end

#observation_period ⇒ String

Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period). Corresponds to the JSON property observationPeriod

Returns:

  • (String) 


127
128
129
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 127

def observation_period
  @observation_period
end

#state_info ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1InsightStateInfo

Information related to insight state. Corresponds to the JSON property stateInfo

Returns:



132
133
134
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 132

def state_info
  @state_info
end

#target_resources ⇒ Array<String>

Fully qualified resource names that this insight is targeting. Corresponds to the JSON property targetResources

Returns:

  • (Array<String>) 


137
138
139
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 137

def target_resources
  @target_resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 144

def update!(**args)
  @associated_recommendations = args[:associated_recommendations] if args.key?(:associated_recommendations)
  @category = args[:category] if args.key?(:category)
  @content = args[:content] if args.key?(:content)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @insight_subtype = args[:insight_subtype] if args.key?(:insight_subtype)
  @last_refresh_time = args[:last_refresh_time] if args.key?(:last_refresh_time)
  @name = args[:name] if args.key?(:name)
  @observation_period = args[:observation_period] if args.key?(:observation_period)
  @state_info = args[:state_info] if args.key?(:state_info)
  @target_resources = args[:target_resources] if args.key?(:target_resources)
end