public final class Recommendation extends com.google.protobuf.GeneratedMessageV3 implements RecommendationOrBuilder
A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etcProtobuf type
google.cloud.recommender.v1.Recommendation| Modifier and Type | Class and Description |
|---|---|
static class |
Recommendation.Builder
A recommendation along with a suggested action.
|
static class |
Recommendation.InsightReference
Reference to an associated insight.
|
static interface |
Recommendation.InsightReferenceOrBuilder |
static class |
Recommendation.Priority
Recommendation priority levels.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ADDITIONAL_IMPACT_FIELD_NUMBER |
static int |
ASSOCIATED_INSIGHTS_FIELD_NUMBER |
static int |
CONTENT_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
LAST_REFRESH_TIME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PRIMARY_IMPACT_FIELD_NUMBER |
static int |
PRIORITY_FIELD_NUMBER |
static int |
RECOMMENDER_SUBTYPE_FIELD_NUMBER |
static int |
STATE_INFO_FIELD_NUMBER |
static int |
XOR_GROUP_ID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
static Recommendation |
getDefaultInstance() |
Recommendation |
getDefaultInstanceForType() |
String |
getDescription()
Free-form human readable summary in English.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Free-form human readable summary in English.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<Recommendation> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Recommendation.Builder |
newBuilder() |
static Recommendation.Builder |
newBuilder(Recommendation prototype) |
Recommendation.Builder |
newBuilderForType() |
protected Recommendation.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Recommendation |
parseDelimitedFrom(InputStream input) |
static Recommendation |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Recommendation |
parseFrom(byte[] data) |
static Recommendation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Recommendation |
parseFrom(ByteBuffer data) |
static Recommendation |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Recommendation |
parseFrom(com.google.protobuf.ByteString data) |
static Recommendation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Recommendation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Recommendation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Recommendation |
parseFrom(InputStream input) |
static Recommendation |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Recommendation> |
parser() |
Recommendation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int RECOMMENDER_SUBTYPE_FIELD_NUMBER
public static final int LAST_REFRESH_TIME_FIELD_NUMBER
public static final int PRIMARY_IMPACT_FIELD_NUMBER
public static final int ADDITIONAL_IMPACT_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
public static final int STATE_INFO_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int ASSOCIATED_INSIGHTS_FIELD_NUMBER
public static final int XOR_GROUP_ID_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Name of recommendation.
string name = 1;getName in interface RecommendationOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Name of recommendation.
string name = 1;getNameBytes in interface RecommendationOrBuilderpublic String getDescription()
Free-form human readable summary in English. The maximum length is 500 characters.
string description = 2;getDescription in interface RecommendationOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Free-form human readable summary in English. The maximum length is 500 characters.
string description = 2;getDescriptionBytes in interface RecommendationOrBuilderpublic 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;getRecommenderSubtype in interface RecommendationOrBuilderpublic 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;getRecommenderSubtypeBytes in interface RecommendationOrBuilderpublic 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;hasLastRefreshTime in interface RecommendationOrBuilderpublic 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;getLastRefreshTime in interface RecommendationOrBuilderpublic 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;getLastRefreshTimeOrBuilder in interface RecommendationOrBuilderpublic 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;hasPrimaryImpact in interface RecommendationOrBuilderpublic 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;getPrimaryImpact in interface RecommendationOrBuilderpublic 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;getPrimaryImpactOrBuilder in interface RecommendationOrBuilderpublic 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;getAdditionalImpactList in interface RecommendationOrBuilderpublic 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;getAdditionalImpactOrBuilderList in interface RecommendationOrBuilderpublic 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;getAdditionalImpactCount in interface RecommendationOrBuilderpublic 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;getAdditionalImpact in interface RecommendationOrBuilderpublic 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;getAdditionalImpactOrBuilder in interface RecommendationOrBuilderpublic int getPriorityValue()
Recommendation's priority.
.google.cloud.recommender.v1.Recommendation.Priority priority = 17;getPriorityValue in interface RecommendationOrBuilderpublic Recommendation.Priority getPriority()
Recommendation's priority.
.google.cloud.recommender.v1.Recommendation.Priority priority = 17;getPriority in interface RecommendationOrBuilderpublic boolean hasContent()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;hasContent in interface RecommendationOrBuilderpublic RecommendationContent getContent()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;getContent in interface RecommendationOrBuilderpublic RecommendationContentOrBuilder getContentOrBuilder()
Content of the recommendation describing recommended changes to resources.
.google.cloud.recommender.v1.RecommendationContent content = 7;getContentOrBuilder in interface RecommendationOrBuilderpublic boolean hasStateInfo()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;hasStateInfo in interface RecommendationOrBuilderpublic RecommendationStateInfo getStateInfo()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;getStateInfo in interface RecommendationOrBuilderpublic RecommendationStateInfoOrBuilder getStateInfoOrBuilder()
Information for state. Contains state and metadata.
.google.cloud.recommender.v1.RecommendationStateInfo state_info = 10;getStateInfoOrBuilder in interface RecommendationOrBuilderpublic String getEtag()
Fingerprint of the Recommendation. Provides optimistic locking when updating states.
string etag = 11;getEtag in interface RecommendationOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Fingerprint of the Recommendation. Provides optimistic locking when updating states.
string etag = 11;getEtagBytes in interface RecommendationOrBuilderpublic List<Recommendation.InsightReference> getAssociatedInsightsList()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
getAssociatedInsightsList in interface RecommendationOrBuilderpublic List<? extends Recommendation.InsightReferenceOrBuilder> getAssociatedInsightsOrBuilderList()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
getAssociatedInsightsOrBuilderList in interface RecommendationOrBuilderpublic int getAssociatedInsightsCount()
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
getAssociatedInsightsCount in interface RecommendationOrBuilderpublic Recommendation.InsightReference getAssociatedInsights(int index)
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
getAssociatedInsights in interface RecommendationOrBuilderpublic Recommendation.InsightReferenceOrBuilder getAssociatedInsightsOrBuilder(int index)
Insights that led to this recommendation.
repeated .google.cloud.recommender.v1.Recommendation.InsightReference associated_insights = 14;
getAssociatedInsightsOrBuilder in interface RecommendationOrBuilderpublic 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;getXorGroupId in interface RecommendationOrBuilderpublic 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;getXorGroupIdBytes in interface RecommendationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Recommendation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Recommendation parseFrom(InputStream input) throws IOException
IOExceptionpublic static Recommendation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Recommendation parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Recommendation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Recommendation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Recommendation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Recommendation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Recommendation.Builder newBuilder()
public static Recommendation.Builder newBuilder(Recommendation prototype)
public Recommendation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Recommendation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Recommendation getDefaultInstance()
public static com.google.protobuf.Parser<Recommendation> parser()
public com.google.protobuf.Parser<Recommendation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Recommendation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.