Class: Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Recommendation

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

A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommenderV1Recommendation

Returns a new instance of GoogleCloudRecommenderV1Recommendation.



549
550
551
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 549

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

Instance Attribute Details

#additional_impact ⇒ Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact>

Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. Corresponds to the JSON property additionalImpact

Returns:



493
494
495
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 493

def additional_impact
  @additional_impact
end

#associated_insights ⇒ Array<Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationInsightReference>

Insights that led to this recommendation. Corresponds to the JSON property associatedInsights

Returns:



498
499
500
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 498

def associated_insights
  @associated_insights
end

#content ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationContent

Contains what resources are changing and how they are changing. Corresponds to the JSON property content

Returns:



503
504
505
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 503

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) 


509
510
511
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 509

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


515
516
517
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 515

def etag
  @etag
end

#last_refresh_time ⇒ String

Last time this recommendation was refreshed by the system that created it in the first place. Corresponds to the JSON property lastRefreshTime

Returns:

  • (String) 


521
522
523
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 521

def last_refresh_time
  @last_refresh_time
end

#name ⇒ String

Name of recommendation. Corresponds to the JSON property name

Returns:

  • (String) 


526
527
528
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 526

def name
  @name
end

#primary_impact ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact

Contains the impact a recommendation can have for a given category. Corresponds to the JSON property primaryImpact

Returns:



531
532
533
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 531

def primary_impact
  @primary_impact
end

#recommender_subtype ⇒ String

Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to content or primary_impact.category are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google. iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/" REPLACE_ROLE" Corresponds to the JSON property recommenderSubtype

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 542

def recommender_subtype
  @recommender_subtype
end

#state_info ⇒ Google::Apis::RecommenderV1::GoogleCloudRecommenderV1RecommendationStateInfo

Information for state. Contains state and metadata. Corresponds to the JSON property stateInfo

Returns:



547
548
549
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 547

def state_info
  @state_info
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



554
555
556
557
558
559
560
561
562
563
564
565
 
# File 'generated/google/apis/recommender_v1/classes.rb', line 554

def update!(**args)
  @additional_impact = args[:additional_impact] if args.key?(:additional_impact)
  @associated_insights = args[:associated_insights] if args.key?(:associated_insights)
  @content = args[:content] if args.key?(:content)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @last_refresh_time = args[:last_refresh_time] if args.key?(:last_refresh_time)
  @name = args[:name] if args.key?(:name)
  @primary_impact = args[:primary_impact] if args.key?(:primary_impact)
  @recommender_subtype = args[:recommender_subtype] if args.key?(:recommender_subtype)
  @state_info = args[:state_info] if args.key?(:state_info)
end