Package com.google.cloud.recommender.v1
Interface RecommendationOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Recommendation
,Recommendation.Builder
public interface RecommendationOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Impact
getAdditionalImpact(int index)
Optional set of additional impact that this recommendation may have when trying to optimize for the primary category.int
getAdditionalImpactCount()
Optional set of additional impact that this recommendation may have when trying to optimize for the primary category.List<Impact>
getAdditionalImpactList()
Optional set of additional impact that this recommendation may have when trying to optimize for the primary category.ImpactOrBuilder
getAdditionalImpactOrBuilder(int index)
Optional set of additional impact that this recommendation may have when trying to optimize for the primary category.List<? extends ImpactOrBuilder>
getAdditionalImpactOrBuilderList()
Optional set of additional impact that this recommendation may have when trying to optimize for the primary category.Recommendation.InsightReference
getAssociatedInsights(int index)
Insights that led to this recommendation.int
getAssociatedInsightsCount()
Insights that led to this recommendation.List<Recommendation.InsightReference>
getAssociatedInsightsList()
Insights that led to this recommendation.Recommendation.InsightReferenceOrBuilder
getAssociatedInsightsOrBuilder(int index)
Insights that led to this recommendation.List<? extends Recommendation.InsightReferenceOrBuilder>
getAssociatedInsightsOrBuilderList()
Insights that led to this recommendation.RecommendationContent
getContent()
Content of the recommendation describing recommended changes to resources.RecommendationContentOrBuilder
getContentOrBuilder()
Content of the recommendation describing recommended changes to resources.String
getDescription()
Free-form human readable summary in English.com.google.protobuf.ByteString
getDescriptionBytes()
Free-form human readable summary in English.String
getEtag()
Fingerprint of the Recommendation.com.google.protobuf.ByteString
getEtagBytes()
Fingerprint of the Recommendation.com.google.protobuf.Timestamp
getLastRefreshTime()
Last time this recommendation was refreshed by the system that created it in the first place.com.google.protobuf.TimestampOrBuilder
getLastRefreshTimeOrBuilder()
Last time this recommendation was refreshed by the system that created it in the first place.String
getName()
Name of recommendation.com.google.protobuf.ByteString
getNameBytes()
Name of recommendation.Impact
getPrimaryImpact()
The primary impact that this recommendation can have while trying to optimize for one category.ImpactOrBuilder
getPrimaryImpactOrBuilder()
The primary impact that this recommendation can have while trying to optimize for one category.Recommendation.Priority
getPriority()
Recommendation's priority.int
getPriorityValue()
Recommendation's priority.String
getRecommenderSubtype()
Contains an identifier for a subtype of recommendations produced for the same recommender.com.google.protobuf.ByteString
getRecommenderSubtypeBytes()
Contains an identifier for a subtype of recommendations produced for the same recommender.RecommendationStateInfo
getStateInfo()
Information for state.RecommendationStateInfoOrBuilder
getStateInfoOrBuilder()
Information for state.String
getXorGroupId()
Corresponds to a mutually exclusive group ID within a recommender.com.google.protobuf.ByteString
getXorGroupIdBytes()
Corresponds to a mutually exclusive group ID within a recommender.boolean
hasContent()
Content of the recommendation describing recommended changes to resources.boolean
hasLastRefreshTime()
Last time this recommendation was refreshed by the system that created it in the first place.boolean
hasPrimaryImpact()
The primary impact that this recommendation can have while trying to optimize for one category.boolean
hasStateInfo()
Information for state.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
String getName()
Name of recommendation.
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()
Name of recommendation.
string name = 1;
- Returns:
- The bytes for name.
-
getDescription
String getDescription()
Free-form human readable summary in English. The maximum length is 500 characters.
string description = 2;
- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
Free-form human readable summary in English. The maximum length is 500 characters.
string description = 2;
- Returns:
- The bytes for description.
-
getRecommenderSubtype
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:
- The recommenderSubtype.
-
getRecommenderSubtypeBytes
com.google.protobuf.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:
- The bytes for recommenderSubtype.
-
hasLastRefreshTime
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:
- Whether the lastRefreshTime field is set.
-
getLastRefreshTime
com.google.protobuf.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:
- The lastRefreshTime.
-
getLastRefreshTimeOrBuilder
com.google.protobuf.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;
-
hasPrimaryImpact
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:
- Whether the primaryImpact field is set.
-
getPrimaryImpact
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:
- The primaryImpact.
-
getPrimaryImpactOrBuilder
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;
-
getAdditionalImpactList
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;
-
getAdditionalImpact
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;
-
getAdditionalImpactCount
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;
-
getAdditionalImpactOrBuilderList
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;
-
getAdditionalImpactOrBuilder
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;
-
getPriorityValue
int getPriorityValue()
Recommendation's priority.
.google.cloud.recommender.v1.Recommendation.Priority priority = 17;
- Returns:
- The enum numeric value on the wire for priority.
-
getPriority
Recommendation.Priority getPriority()
Recommendation's priority.
.google.cloud.recommender.v1.Recommendation.Priority priority = 17;
- Returns:
- The priority.
-
hasContent
boolean hasContent()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;
- Returns:
- Whether the content field is set.
-
getContent
RecommendationContent getContent()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;
- Returns:
- The content.
-
getContentOrBuilder
RecommendationContentOrBuilder getContentOrBuilder()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;
-
hasStateInfo
boolean hasStateInfo()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;
- Returns:
- Whether the stateInfo field is set.
-
getStateInfo
RecommendationStateInfo getStateInfo()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;
- Returns:
- The stateInfo.
-
getStateInfoOrBuilder
RecommendationStateInfoOrBuilder getStateInfoOrBuilder()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;
-
getEtag
String getEtag()
Fingerprint of the Recommendation. Provides optimistic locking when updating states.
string etag = 11;
- Returns:
- The etag.
-
getEtagBytes
com.google.protobuf.ByteString getEtagBytes()
Fingerprint of the Recommendation. Provides optimistic locking when updating states.
string etag = 11;
- Returns:
- The bytes for etag.
-
getAssociatedInsightsList
List<Recommendation.InsightReference> getAssociatedInsightsList()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
-
getAssociatedInsights
Recommendation.InsightReference getAssociatedInsights(int index)
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
-
getAssociatedInsightsCount
int getAssociatedInsightsCount()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
-
getAssociatedInsightsOrBuilderList
List<? extends Recommendation.InsightReferenceOrBuilder> getAssociatedInsightsOrBuilderList()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
-
getAssociatedInsightsOrBuilder
Recommendation.InsightReferenceOrBuilder getAssociatedInsightsOrBuilder(int index)
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
-
getXorGroupId
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:
- The xorGroupId.
-
getXorGroupIdBytes
com.google.protobuf.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:
- The bytes for xorGroupId.
-
-