Interface RecommendationOrBuilder (2.37.0)

Version 2.37.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.7
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.5

public interface RecommendationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAdditionalImpact(int index)

public abstract Impact getAdditionalImpact(int index)

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

repeated .google.cloud.recommender.v1.Impact additional_impact = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
Impact

getAdditionalImpactCount()

public abstract int getAdditionalImpactCount()

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

repeated .google.cloud.recommender.v1.Impact additional_impact = 6;

Returns
Type	Description
int

getAdditionalImpactList()

public abstract List<Impact> getAdditionalImpactList()

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

repeated .google.cloud.recommender.v1.Impact additional_impact = 6;

Returns
Type	Description
List<Impact>

getAdditionalImpactOrBuilder(int index)

public abstract ImpactOrBuilder getAdditionalImpactOrBuilder(int index)

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

repeated .google.cloud.recommender.v1.Impact additional_impact = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
ImpactOrBuilder

getAdditionalImpactOrBuilderList()

public abstract List<? extends ImpactOrBuilder> getAdditionalImpactOrBuilderList()

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

repeated .google.cloud.recommender.v1.Impact additional_impact = 6;

Returns
Type	Description
List<? extends com.google.cloud.recommender.v1.ImpactOrBuilder>

getAssociatedInsights(int index)

public abstract Recommendation.InsightReference getAssociatedInsights(int index)

Insights that led to this recommendation.

repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Recommendation.InsightReference

getAssociatedInsightsCount()

public abstract int getAssociatedInsightsCount()

Insights that led to this recommendation.

repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;

Returns
Type	Description
int

getAssociatedInsightsList()

public abstract List<Recommendation.InsightReference> getAssociatedInsightsList()

Insights that led to this recommendation.

repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;

Returns
Type	Description
List<InsightReference>

getAssociatedInsightsOrBuilder(int index)

public abstract Recommendation.InsightReferenceOrBuilder getAssociatedInsightsOrBuilder(int index)

Insights that led to this recommendation.

repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;

Parameter
Name	Description
index	int

Returns
Type	Description
Recommendation.InsightReferenceOrBuilder

getAssociatedInsightsOrBuilderList()

public abstract List<? extends Recommendation.InsightReferenceOrBuilder> getAssociatedInsightsOrBuilderList()

Insights that led to this recommendation.

repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;

Returns
Type	Description
List<? extends com.google.cloud.recommender.v1.Recommendation.InsightReferenceOrBuilder>

getContent()

public abstract RecommendationContent getContent()

Content of the recommendation describing recommended changes to resources.

.google.cloud.recommender.v1.RecommendationContent content = 7;

Returns
Type	Description
RecommendationContent	The content.

getContentOrBuilder()

public abstract RecommendationContentOrBuilder getContentOrBuilder()

Content of the recommendation describing recommended changes to resources.

.google.cloud.recommender.v1.RecommendationContent content = 7;

Returns
Type	Description
RecommendationContentOrBuilder

getDescription()

public abstract String getDescription()

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

string description = 2;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 2;

Returns
Type	Description
ByteString	The bytes for description.

getEtag()

public abstract String getEtag()

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

string etag = 11;

Returns
Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

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

string etag = 11;

Returns
Type	Description
ByteString	The bytes for etag.

getLastRefreshTime()

public abstract Timestamp getLastRefreshTime()

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

.google.protobuf.Timestamp last_refresh_time = 4;

Returns
Type	Description
Timestamp	The lastRefreshTime.

getLastRefreshTimeOrBuilder()

public abstract TimestampOrBuilder getLastRefreshTimeOrBuilder()

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

.google.protobuf.Timestamp last_refresh_time = 4;

Returns
Type	Description
TimestampOrBuilder

getName()

public abstract String getName()

Name of recommendation.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Name of recommendation.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getPrimaryImpact()

public abstract Impact getPrimaryImpact()

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

.google.cloud.recommender.v1.Impact primary_impact = 5;

Returns
Type	Description
Impact	The primaryImpact.

getPrimaryImpactOrBuilder()

public abstract ImpactOrBuilder getPrimaryImpactOrBuilder()

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

.google.cloud.recommender.v1.Impact primary_impact = 5;

Returns
Type	Description
ImpactOrBuilder

getPriority()

public abstract Recommendation.Priority getPriority()

Recommendation's priority.

.google.cloud.recommender.v1.Recommendation.Priority priority = 17;

Returns
Type	Description
Recommendation.Priority	The priority.

getPriorityValue()

public abstract int getPriorityValue()

Recommendation's priority.

.google.cloud.recommender.v1.Recommendation.Priority priority = 17;

Returns
Type	Description
int	The enum numeric value on the wire for priority.

getRecommenderSubtype()

public abstract String getRecommenderSubtype()

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"

string recommender_subtype = 12;

Returns
Type	Description
String	The recommenderSubtype.

getRecommenderSubtypeBytes()

public abstract ByteString getRecommenderSubtypeBytes()

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"

string recommender_subtype = 12;

Returns
Type	Description
ByteString	The bytes for recommenderSubtype.

getStateInfo()

public abstract RecommendationStateInfo getStateInfo()

Information for state. Contains state and metadata.

.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;

Returns
Type	Description
RecommendationStateInfo	The stateInfo.

getStateInfoOrBuilder()

public abstract RecommendationStateInfoOrBuilder getStateInfoOrBuilder()

Information for state. Contains state and metadata.

.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;

Returns
Type	Description
RecommendationStateInfoOrBuilder

getXorGroupId()

public abstract String getXorGroupId()

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.

string xor_group_id = 18;

Returns
Type	Description
String	The xorGroupId.

getXorGroupIdBytes()

public abstract ByteString getXorGroupIdBytes()

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.

string xor_group_id = 18;

Returns
Type	Description
ByteString	The bytes for xorGroupId.

hasContent()

public abstract boolean hasContent()

Content of the recommendation describing recommended changes to resources.

.google.cloud.recommender.v1.RecommendationContent content = 7;

Returns
Type	Description
boolean	Whether the content field is set.

hasLastRefreshTime()

public abstract boolean hasLastRefreshTime()

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

.google.protobuf.Timestamp last_refresh_time = 4;

Returns
Type	Description
boolean	Whether the lastRefreshTime field is set.

hasPrimaryImpact()

public abstract boolean hasPrimaryImpact()

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

.google.cloud.recommender.v1.Impact primary_impact = 5;

Returns
Type	Description
boolean	Whether the primaryImpact field is set.

hasStateInfo()

public abstract boolean hasStateInfo()

Information for state. Contains state and metadata.

.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;

Returns
Type	Description
boolean	Whether the stateInfo field is set.