Google Cloud Recommender v1 API - Class Recommendation (3.5.0)

public sealed class Recommendation : IMessage<Recommendation>, IEquatable<Recommendation>, IDeepCloneable<Recommendation>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Recommender v1 API class Recommendation.

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

Inheritance

object > Recommendation

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

Recommendation()

public Recommendation()

Recommendation(Recommendation)

public Recommendation(Recommendation other)
Parameter
NameDescription
otherRecommendation

Properties

AdditionalImpact

public RepeatedField<Impact> AdditionalImpact { get; }

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

Property Value
TypeDescription
RepeatedFieldImpact

AssociatedInsights

public RepeatedField<Recommendation.Types.InsightReference> AssociatedInsights { get; }

Insights that led to this recommendation.

Property Value
TypeDescription
RepeatedFieldRecommendationTypesInsightReference

Content

public RecommendationContent Content { get; set; }

Content of the recommendation describing recommended changes to resources.

Property Value
TypeDescription
RecommendationContent

Description

public string Description { get; set; }

Free-form human readable summary in English. The maximum length is 500 characters.

Property Value
TypeDescription
string

Etag

public string Etag { get; set; }

Fingerprint of the Recommendation. Provides optimistic locking when updating states.

Property Value
TypeDescription
string

LastRefreshTime

public Timestamp LastRefreshTime { get; set; }

Last time this recommendation was refreshed by the system that created it in the first place.

Property Value
TypeDescription
Timestamp

Name

public string Name { get; set; }

Name of recommendation.

Property Value
TypeDescription
string

PrimaryImpact

public Impact PrimaryImpact { get; set; }

The primary impact that this recommendation can have while trying to optimize for one category.

Property Value
TypeDescription
Impact

Priority

public Recommendation.Types.Priority Priority { get; set; }

Recommendation's priority.

Property Value
TypeDescription
RecommendationTypesPriority

RecommendationName

public RecommendationName RecommendationName { get; set; }

RecommendationName-typed view over the Name resource name property.

Property Value
TypeDescription
RecommendationName

RecommenderSubtype

public string RecommenderSubtype { get; set; }

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"

Property Value
TypeDescription
string

StateInfo

public RecommendationStateInfo StateInfo { get; set; }

Information for state. Contains state and metadata.

Property Value
TypeDescription
RecommendationStateInfo

XorGroupId

public string XorGroupId { get; set; }

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.

Property Value
TypeDescription
string