Class: Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Recommendation

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

Returns a new instance of GoogleCloudRecommenderV1beta1Recommendation.



668
669
670
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 668

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

Instance Attribute Details

#additional_impact ⇒ Array<Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Impact>

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:



599
600
601
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 599

def additional_impact
  @additional_impact
end

#associated_insights ⇒ Array<Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1RecommendationInsightReference>

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

Returns:



604
605
606
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 604

def associated_insights
  @associated_insights
end

#content ⇒ Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1RecommendationContent

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

Returns:



609
610
611
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 609

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) 


615
616
617
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 615

def description
  @description
end

#etag ⇒ String

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

Returns:

  • (String) 


621
622
623
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 621

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) 


627
628
629
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 627

def last_refresh_time
  @last_refresh_time
end

#name ⇒ String

Name of recommendation. Corresponds to the JSON property name

Returns:

  • (String) 


632
633
634
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 632

def name
  @name
end

#primary_impact ⇒ Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Impact

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

Returns:



637
638
639
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 637

def primary_impact
  @primary_impact
end

#priority ⇒ String

Recommendation's priority. Corresponds to the JSON property priority

Returns:

  • (String) 


642
643
644
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 642

def priority
  @priority
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) 


653
654
655
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 653

def recommender_subtype
  @recommender_subtype
end

#state_info ⇒ Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1RecommendationStateInfo

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

Returns:



658
659
660
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 658

def state_info
  @state_info
end

#xor_group_id ⇒ String

Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. Corresponds to the JSON property xorGroupId

Returns:

  • (String) 


666
667
668
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 666

def xor_group_id
  @xor_group_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'lib/google/apis/recommender_v1beta1/classes.rb', line 673

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)
  @priority = args[:priority] if args.key?(:priority)
  @recommender_subtype = args[:recommender_subtype] if args.key?(:recommender_subtype)
  @state_info = args[:state_info] if args.key?(:state_info)
  @xor_group_id = args[:xor_group_id] if args.key?(:xor_group_id)
end