Class: Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Insight

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/recommender_v1beta1/classes.rb,
generated/google/apis/recommender_v1beta1/representations.rb,
generated/google/apis/recommender_v1beta1/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1beta1Insight

Returns a new instance of GoogleCloudRecommenderV1beta1Insight.



143
144
145
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 143

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

Instance Attribute Details

#associated_recommendations ⇒ Array<Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1InsightRecommendationReference>

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

Returns:



83
84
85
 
# File 'generated/google/apis/recommender_v1beta1/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_v1beta1/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_v1beta1/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_v1beta1/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) 


106
107
108
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 106

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) 


111
112
113
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 111

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) 


116
117
118
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 116

def last_refresh_time
  @last_refresh_time
end

#name ⇒ String

Name of the insight.

  • A project insight is represented as projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] /insights/[insight_id] Corresponds to the JSON property name

Returns:

  • (String) 


124
125
126
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 124

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) 


131
132
133
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 131

def observation_period
  @observation_period
end

#state_info ⇒ Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1InsightStateInfo

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

Returns:



136
137
138
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 136

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


141
142
143
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 141

def target_resources
  @target_resources
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'generated/google/apis/recommender_v1beta1/classes.rb', line 148

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