Class Recommendation.Builder (2.56.0) 

public static final class Recommendation.Builder extends GeneratedMessageV3.Builder<Recommendation.Builder> implements RecommendationOrBuilder

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

Protobuf type google.cloud.recommender.v1.Recommendation

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Recommendation.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAdditionalImpact(Impact value)

public Recommendation.Builder addAdditionalImpact(Impact value)

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
value Impact
Returns
Type Description
Recommendation.Builder

addAdditionalImpact(Impact.Builder builderForValue)

public Recommendation.Builder addAdditionalImpact(Impact.Builder builderForValue)

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
builderForValue Impact.Builder
Returns
Type Description
Recommendation.Builder

addAdditionalImpact(int index, Impact value)

public Recommendation.Builder addAdditionalImpact(int index, Impact value)

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;

Parameters
Name Description
index int
value Impact
Returns
Type Description
Recommendation.Builder

addAdditionalImpact(int index, Impact.Builder builderForValue)

public Recommendation.Builder addAdditionalImpact(int index, Impact.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Impact.Builder
Returns
Type Description
Recommendation.Builder

addAdditionalImpactBuilder()

public Impact.Builder addAdditionalImpactBuilder()

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
Impact.Builder

addAdditionalImpactBuilder(int index)

public Impact.Builder addAdditionalImpactBuilder(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.Builder

addAllAdditionalImpact(Iterable<? extends Impact> values)

public Recommendation.Builder addAllAdditionalImpact(Iterable<? extends Impact> values)

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
values Iterable<? extends com.google.cloud.recommender.v1.Impact>
Returns
Type Description
Recommendation.Builder

addAllAssociatedInsights(Iterable<? extends Recommendation.InsightReference> values)

public Recommendation.Builder addAllAssociatedInsights(Iterable<? extends Recommendation.InsightReference> values)

Insights that led to this recommendation.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.recommender.v1.Recommendation.InsightReference>
Returns
Type Description
Recommendation.Builder

addAssociatedInsights(Recommendation.InsightReference value)

public Recommendation.Builder addAssociatedInsights(Recommendation.InsightReference value)

Insights that led to this recommendation.

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

Parameter
Name Description
value Recommendation.InsightReference
Returns
Type Description
Recommendation.Builder

addAssociatedInsights(Recommendation.InsightReference.Builder builderForValue)

public Recommendation.Builder addAssociatedInsights(Recommendation.InsightReference.Builder builderForValue)

Insights that led to this recommendation.

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

Parameter
Name Description
builderForValue Recommendation.InsightReference.Builder
Returns
Type Description
Recommendation.Builder

addAssociatedInsights(int index, Recommendation.InsightReference value)

public Recommendation.Builder addAssociatedInsights(int index, Recommendation.InsightReference value)

Insights that led to this recommendation.

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

Parameters
Name Description
index int
value Recommendation.InsightReference
Returns
Type Description
Recommendation.Builder

addAssociatedInsights(int index, Recommendation.InsightReference.Builder builderForValue)

public Recommendation.Builder addAssociatedInsights(int index, Recommendation.InsightReference.Builder builderForValue)

Insights that led to this recommendation.

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

Parameters
Name Description
index int
builderForValue Recommendation.InsightReference.Builder
Returns
Type Description
Recommendation.Builder

addAssociatedInsightsBuilder()

public Recommendation.InsightReference.Builder addAssociatedInsightsBuilder()

Insights that led to this recommendation.

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

Returns
Type Description
Recommendation.InsightReference.Builder

addAssociatedInsightsBuilder(int index)

public Recommendation.InsightReference.Builder addAssociatedInsightsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Recommendation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Recommendation.Builder
Overrides

build()

public Recommendation build()
Returns
Type Description
Recommendation

buildPartial()

public Recommendation buildPartial()
Returns
Type Description
Recommendation

clear()

public Recommendation.Builder clear()
Returns
Type Description
Recommendation.Builder
Overrides

clearAdditionalImpact()

public Recommendation.Builder clearAdditionalImpact()

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
Recommendation.Builder

clearAssociatedInsights()

public Recommendation.Builder clearAssociatedInsights()

Insights that led to this recommendation.

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

Returns
Type Description
Recommendation.Builder

clearContent()

public Recommendation.Builder clearContent()

Content of the recommendation describing recommended changes to resources.

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

Returns
Type Description
Recommendation.Builder

clearDescription()

public Recommendation.Builder clearDescription()

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

string description = 2;

Returns
Type Description
Recommendation.Builder

This builder for chaining.

clearEtag()

public Recommendation.Builder clearEtag()

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

string etag = 11;

Returns
Type Description
Recommendation.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Recommendation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Recommendation.Builder
Overrides

clearLastRefreshTime()

public Recommendation.Builder clearLastRefreshTime()

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
Recommendation.Builder

clearName()

public Recommendation.Builder clearName()

Name of recommendation.

string name = 1;

Returns
Type Description
Recommendation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Recommendation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Recommendation.Builder
Overrides

clearPrimaryImpact()

public Recommendation.Builder clearPrimaryImpact()

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
Recommendation.Builder

clearPriority()

public Recommendation.Builder clearPriority()

Recommendation's priority.

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

Returns
Type Description
Recommendation.Builder

This builder for chaining.

clearRecommenderSubtype()

public Recommendation.Builder clearRecommenderSubtype()

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
Recommendation.Builder

This builder for chaining.

clearStateInfo()

public Recommendation.Builder clearStateInfo()

Information for state. Contains state and metadata.

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

Returns
Type Description
Recommendation.Builder

clearXorGroupId()

public Recommendation.Builder clearXorGroupId()

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
Recommendation.Builder

This builder for chaining.

clone()

public Recommendation.Builder clone()
Returns
Type Description
Recommendation.Builder
Overrides

getAdditionalImpact(int index)

public 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

getAdditionalImpactBuilder(int index)

public Impact.Builder getAdditionalImpactBuilder(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.Builder

getAdditionalImpactBuilderList()

public List<Impact.Builder> getAdditionalImpactBuilderList()

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<Builder>

getAdditionalImpactCount()

public 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 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 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 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 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

getAssociatedInsightsBuilder(int index)

public Recommendation.InsightReference.Builder getAssociatedInsightsBuilder(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.Builder

getAssociatedInsightsBuilderList()

public List<Recommendation.InsightReference.Builder> getAssociatedInsightsBuilderList()

Insights that led to this recommendation.

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

Returns
Type Description
List<Builder>

getAssociatedInsightsCount()

public int getAssociatedInsightsCount()

Insights that led to this recommendation.

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

Returns
Type Description
int

getAssociatedInsightsList()

public 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 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 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 RecommendationContent getContent()

Content of the recommendation describing recommended changes to resources.

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

Returns
Type Description
RecommendationContent

The content.

getContentBuilder()

public RecommendationContent.Builder getContentBuilder()

Content of the recommendation describing recommended changes to resources.

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

Returns
Type Description
RecommendationContent.Builder

getContentOrBuilder()

public RecommendationContentOrBuilder getContentOrBuilder()

Content of the recommendation describing recommended changes to resources.

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

Returns
Type Description
RecommendationContentOrBuilder

getDefaultInstanceForType()

public Recommendation getDefaultInstanceForType()
Returns
Type Description
Recommendation

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public String getEtag()

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

string etag = 11;

Returns
Type Description
String

The etag.

getEtagBytes()

public 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 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.

getLastRefreshTimeBuilder()

public Timestamp.Builder getLastRefreshTimeBuilder()

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
Builder

getLastRefreshTimeOrBuilder()

public 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 String getName()

Name of recommendation.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of recommendation.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getPrimaryImpact()

public 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.

getPrimaryImpactBuilder()

public Impact.Builder getPrimaryImpactBuilder()

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.Builder

getPrimaryImpactOrBuilder()

public 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 Recommendation.Priority getPriority()

Recommendation's priority.

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

Returns
Type Description
Recommendation.Priority

The priority.

getPriorityValue()

public 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 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 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 RecommendationStateInfo getStateInfo()

Information for state. Contains state and metadata.

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

Returns
Type Description
RecommendationStateInfo

The stateInfo.

getStateInfoBuilder()

public RecommendationStateInfo.Builder getStateInfoBuilder()

Information for state. Contains state and metadata.

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

Returns
Type Description
RecommendationStateInfo.Builder

getStateInfoOrBuilder()

public RecommendationStateInfoOrBuilder getStateInfoOrBuilder()

Information for state. Contains state and metadata.

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

Returns
Type Description
RecommendationStateInfoOrBuilder

getXorGroupId()

public 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContent(RecommendationContent value)

public Recommendation.Builder mergeContent(RecommendationContent value)

Content of the recommendation describing recommended changes to resources.

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

Parameter
Name Description
value RecommendationContent
Returns
Type Description
Recommendation.Builder

mergeFrom(Recommendation other)

public Recommendation.Builder mergeFrom(Recommendation other)
Parameter
Name Description
other Recommendation
Returns
Type Description
Recommendation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Recommendation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Recommendation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Recommendation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Recommendation.Builder
Overrides

mergeLastRefreshTime(Timestamp value)

public Recommendation.Builder mergeLastRefreshTime(Timestamp value)

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

.google.protobuf.Timestamp last_refresh_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Recommendation.Builder

mergePrimaryImpact(Impact value)

public Recommendation.Builder mergePrimaryImpact(Impact value)

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

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

Parameter
Name Description
value Impact
Returns
Type Description
Recommendation.Builder

mergeStateInfo(RecommendationStateInfo value)

public Recommendation.Builder mergeStateInfo(RecommendationStateInfo value)

Information for state. Contains state and metadata.

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

Parameter
Name Description
value RecommendationStateInfo
Returns
Type Description
Recommendation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Recommendation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Recommendation.Builder
Overrides

removeAdditionalImpact(int index)

public Recommendation.Builder removeAdditionalImpact(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
Recommendation.Builder

removeAssociatedInsights(int index)

public Recommendation.Builder removeAssociatedInsights(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.Builder

setAdditionalImpact(int index, Impact value)

public Recommendation.Builder setAdditionalImpact(int index, Impact value)

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;

Parameters
Name Description
index int
value Impact
Returns
Type Description
Recommendation.Builder

setAdditionalImpact(int index, Impact.Builder builderForValue)

public Recommendation.Builder setAdditionalImpact(int index, Impact.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Impact.Builder
Returns
Type Description
Recommendation.Builder

setAssociatedInsights(int index, Recommendation.InsightReference value)

public Recommendation.Builder setAssociatedInsights(int index, Recommendation.InsightReference value)

Insights that led to this recommendation.

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

Parameters
Name Description
index int
value Recommendation.InsightReference
Returns
Type Description
Recommendation.Builder

setAssociatedInsights(int index, Recommendation.InsightReference.Builder builderForValue)

public Recommendation.Builder setAssociatedInsights(int index, Recommendation.InsightReference.Builder builderForValue)

Insights that led to this recommendation.

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

Parameters
Name Description
index int
builderForValue Recommendation.InsightReference.Builder
Returns
Type Description
Recommendation.Builder

setContent(RecommendationContent value)

public Recommendation.Builder setContent(RecommendationContent value)

Content of the recommendation describing recommended changes to resources.

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

Parameter
Name Description
value RecommendationContent
Returns
Type Description
Recommendation.Builder

setContent(RecommendationContent.Builder builderForValue)

public Recommendation.Builder setContent(RecommendationContent.Builder builderForValue)

Content of the recommendation describing recommended changes to resources.

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

Parameter
Name Description
builderForValue RecommendationContent.Builder
Returns
Type Description
Recommendation.Builder

setDescription(String value)

public Recommendation.Builder setDescription(String value)

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

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Recommendation.Builder setDescriptionBytes(ByteString value)

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

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setEtag(String value)

public Recommendation.Builder setEtag(String value)

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

string etag = 11;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Recommendation.Builder setEtagBytes(ByteString value)

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

string etag = 11;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Recommendation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Recommendation.Builder
Overrides

setLastRefreshTime(Timestamp value)

public Recommendation.Builder setLastRefreshTime(Timestamp value)

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

.google.protobuf.Timestamp last_refresh_time = 4;

Parameter
Name Description
value Timestamp
Returns
Type Description
Recommendation.Builder

setLastRefreshTime(Timestamp.Builder builderForValue)

public Recommendation.Builder setLastRefreshTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp last_refresh_time = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Recommendation.Builder

setName(String value)

public Recommendation.Builder setName(String value)

Name of recommendation.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Recommendation.Builder setNameBytes(ByteString value)

Name of recommendation.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setPrimaryImpact(Impact value)

public Recommendation.Builder setPrimaryImpact(Impact value)

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

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

Parameter
Name Description
value Impact
Returns
Type Description
Recommendation.Builder

setPrimaryImpact(Impact.Builder builderForValue)

public Recommendation.Builder setPrimaryImpact(Impact.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Impact.Builder
Returns
Type Description
Recommendation.Builder

setPriority(Recommendation.Priority value)

public Recommendation.Builder setPriority(Recommendation.Priority value)

Recommendation's priority.

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

Parameter
Name Description
value Recommendation.Priority

The priority to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setPriorityValue(int value)

public Recommendation.Builder setPriorityValue(int value)

Recommendation's priority.

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

Parameter
Name Description
value int

The enum numeric value on the wire for priority to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setRecommenderSubtype(String value)

public Recommendation.Builder setRecommenderSubtype(String value)

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;

Parameter
Name Description
value String

The recommenderSubtype to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setRecommenderSubtypeBytes(ByteString value)

public Recommendation.Builder setRecommenderSubtypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for recommenderSubtype to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Recommendation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Recommendation.Builder
Overrides

setStateInfo(RecommendationStateInfo value)

public Recommendation.Builder setStateInfo(RecommendationStateInfo value)

Information for state. Contains state and metadata.

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

Parameter
Name Description
value RecommendationStateInfo
Returns
Type Description
Recommendation.Builder

setStateInfo(RecommendationStateInfo.Builder builderForValue)

public Recommendation.Builder setStateInfo(RecommendationStateInfo.Builder builderForValue)

Information for state. Contains state and metadata.

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

Parameter
Name Description
builderForValue RecommendationStateInfo.Builder
Returns
Type Description
Recommendation.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Recommendation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Recommendation.Builder
Overrides

setXorGroupId(String value)

public Recommendation.Builder setXorGroupId(String value)

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;

Parameter
Name Description
value String

The xorGroupId to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.

setXorGroupIdBytes(ByteString value)

public Recommendation.Builder setXorGroupIdBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for xorGroupId to set.
Returns
Type Description
Recommendation.Builder

This builder for chaining.