Package cloud.google.com/go/recommender/apiv1/recommenderpb (v1.13.6)
Stay organized with collections
Save and categorize content based on your preferences.
Recommender_ServiceDesc is the grpc.ServiceDesc for Recommender service.
It's only intended for direct use with grpc.RegisterService,
and not to be introspected or modified (even as a copy)
typeCostProjectionstruct{// An approximate projection on amount saved or amount incurred. Negative cost// units indicate cost savings and positive cost units indicate increase.// See google.type.Money documentation for positive/negative units.//// A user's permissions may affect whether the cost is computed using list// prices or custom contract prices.Cost*money.Money`protobuf:"bytes,1,opt,name=cost,proto3" json:"cost,omitempty"`// Duration for which this cost applies.Duration*durationpb.Duration`protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`// The approximate cost savings in the billing account's local currency.CostInLocalCurrency*money.Money`protobuf:"bytes,3,opt,name=cost_in_local_currency,json=costInLocalCurrency,proto3" json:"cost_in_local_currency,omitempty"`// contains filtered or unexported fields}
Contains metadata about how much money a recommendation can save or incur.
typeGetInsightRequeststruct{// Required. Name of the insight.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// contains filtered or unexported fields}
typeGetInsightTypeConfigRequeststruct{// Required. Name of the InsightTypeConfig to get.//// Acceptable formats://// * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`//// * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`//// * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`//// * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// contains filtered or unexported fields}
typeGetRecommendationRequeststruct{// Required. Name of the recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// contains filtered or unexported fields}
typeGetRecommenderConfigRequeststruct{// Required. Name of the Recommendation Config to get.//// Acceptable formats://// * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`//// * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`//// * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`//// * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// contains filtered or unexported fields}
typeImpactstruct{// Category that is being targeted.CategoryImpact_Category`protobuf:"varint,1,opt,name=category,proto3,enum=google.cloud.recommender.v1.Impact_Category" json:"category,omitempty"`// Contains projections (if any) for this category.//// Types that are assignable to Projection://// *Impact_CostProjection// *Impact_SecurityProjection// *Impact_SustainabilityProjection// *Impact_ReliabilityProjectionProjectionisImpact_Projection`protobuf_oneof:"projection"`// contains filtered or unexported fields}
Contains the impact a recommendation can have for a given category.
const(// Default unspecified category. Don't use directly.Impact_CATEGORY_UNSPECIFIEDImpact_Category=0// Indicates a potential increase or decrease in cost.Impact_COSTImpact_Category=1// Indicates a potential increase or decrease in security.Impact_SECURITYImpact_Category=2// Indicates a potential increase or decrease in performance.Impact_PERFORMANCEImpact_Category=3// Indicates a potential increase or decrease in manageability.Impact_MANAGEABILITYImpact_Category=4// Indicates a potential increase or decrease in sustainability.Impact_SUSTAINABILITYImpact_Category=5// Indicates a potential increase or decrease in reliability.Impact_RELIABILITYImpact_Category=6)
typeImpact_CostProjectionstruct{// Use with CategoryType.COSTCostProjection*CostProjection`protobuf:"bytes,100,opt,name=cost_projection,json=costProjection,proto3,oneof"`}
Impact_ReliabilityProjection
typeImpact_ReliabilityProjectionstruct{// Use with CategoryType.RELIABILITYReliabilityProjection*ReliabilityProjection`protobuf:"bytes,103,opt,name=reliability_projection,json=reliabilityProjection,proto3,oneof"`}
Impact_SecurityProjection
typeImpact_SecurityProjectionstruct{// Use with CategoryType.SECURITYSecurityProjection*SecurityProjection`protobuf:"bytes,101,opt,name=security_projection,json=securityProjection,proto3,oneof"`}
Impact_SustainabilityProjection
typeImpact_SustainabilityProjectionstruct{// Use with CategoryType.SUSTAINABILITYSustainabilityProjection*SustainabilityProjection`protobuf:"bytes,102,opt,name=sustainability_projection,json=sustainabilityProjection,proto3,oneof"`}
Insight
typeInsightstruct{// Name of the insight.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Free-form human readable summary in English. The maximum length is 500// characters.Descriptionstring`protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`// Fully qualified resource names that this insight is targeting.TargetResources[]string`protobuf:"bytes,9,rep,name=target_resources,json=targetResources,proto3" json:"target_resources,omitempty"`// Insight subtype. Insight content schema will be stable for a given subtype.InsightSubtypestring`protobuf:"bytes,10,opt,name=insight_subtype,json=insightSubtype,proto3" json:"insight_subtype,omitempty"`// A struct of custom fields to explain the insight.// Example: "grantedPermissionsCount": "1000"Content*structpb.Struct`protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`// Timestamp of the latest data used to generate the insight.LastRefreshTime*timestamppb.Timestamp`protobuf:"bytes,4,opt,name=last_refresh_time,json=lastRefreshTime,proto3" json:"last_refresh_time,omitempty"`// Observation period that led to the insight. The source data used to// generate the insight ends at last_refresh_time and begins at// (last_refresh_time - observation_period).ObservationPeriod*durationpb.Duration`protobuf:"bytes,5,opt,name=observation_period,json=observationPeriod,proto3" json:"observation_period,omitempty"`// Information state and metadata.StateInfo*InsightStateInfo`protobuf:"bytes,6,opt,name=state_info,json=stateInfo,proto3" json:"state_info,omitempty"`// Category being targeted by the insight.CategoryInsight_Category`protobuf:"varint,7,opt,name=category,proto3,enum=google.cloud.recommender.v1.Insight_Category" json:"category,omitempty"`// Insight's severity.SeverityInsight_Severity`protobuf:"varint,15,opt,name=severity,proto3,enum=google.cloud.recommender.v1.Insight_Severity" json:"severity,omitempty"`// Fingerprint of the Insight. Provides optimistic locking when updating// states.Etagstring`protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`// Recommendations derived from this insight.AssociatedRecommendations[]*Insight_RecommendationReference`protobuf:"bytes,8,rep,name=associated_recommendations,json=associatedRecommendations,proto3" json:"associated_recommendations,omitempty"`// contains filtered or unexported fields}
An insight along with the information used to derive the insight. The insight
may have associated recommendations as well.
typeInsightStateInfostruct{// Insight state.StateInsightStateInfo_State`protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.recommender.v1.InsightStateInfo_State" json:"state,omitempty"`// A map of metadata for the state, provided by user or automations systems.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// contains filtered or unexported fields}
const(// Unspecified state.InsightStateInfo_STATE_UNSPECIFIEDInsightStateInfo_State=0// Insight is active. Content for ACTIVE insights can be updated by Google.// ACTIVE insights can be marked DISMISSED OR ACCEPTED.InsightStateInfo_ACTIVEInsightStateInfo_State=1// Some action has been taken based on this insight. Insights become// accepted when a recommendation derived from the insight has been marked// CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked// ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED// insights can only be marked ACCEPTED (which may update state metadata).InsightStateInfo_ACCEPTEDInsightStateInfo_State=2// Insight is dismissed. Content for DISMISSED insights can be updated by// Google. DISMISSED insights can be marked as ACTIVE.InsightStateInfo_DISMISSEDInsightStateInfo_State=3)
typeInsightTypeConfigstruct{// Name of insight type config.// Eg,// projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/configNamestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// InsightTypeGenerationConfig which configures the generation of// insights for this insight type.InsightTypeGenerationConfig*InsightTypeGenerationConfig`protobuf:"bytes,2,opt,name=insight_type_generation_config,json=insightTypeGenerationConfig,proto3" json:"insight_type_generation_config,omitempty"`// Fingerprint of the InsightTypeConfig. Provides optimistic locking when// updating.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// Last time when the config was updated.UpdateTime*timestamppb.Timestamp`protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`// Output only. Immutable. The revision ID of the config.// A new revision is committed whenever the config is changed in any way.// The format is an 8-character hexadecimal string.RevisionIdstring`protobuf:"bytes,5,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`// Allows clients to store small amounts of arbitrary data. Annotations must// follow the Kubernetes syntax.// The total size of all keys and values combined is limited to 256k.// Key can have 2 segments: prefix (optional) and name (required),// separated by a slash (/).// Prefix must be a DNS subdomain.// Name must be 63 characters or less, begin and end with alphanumerics,// with dashes (-), underscores (_), dots (.), and alphanumerics between.Annotationsmap[string]string`protobuf:"bytes,6,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// A user-settable field to provide a human-readable name to be used in user// interfaces.DisplayNamestring`protobuf:"bytes,7,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`// contains filtered or unexported fields}
typeInsightTypeGenerationConfigstruct{// Parameters for this InsightTypeGenerationConfig. These configs can be used// by or are applied to all subtypes.Params*structpb.Struct`protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`// contains filtered or unexported fields}
A configuration to customize the generation of insights.
Eg, customizing the lookback period considered when generating a
insight.
const(// Unspecified category.Insight_CATEGORY_UNSPECIFIEDInsight_Category=0// The insight is related to cost.Insight_COSTInsight_Category=1// The insight is related to security.Insight_SECURITYInsight_Category=2// The insight is related to performance.Insight_PERFORMANCEInsight_Category=3// This insight is related to manageability.Insight_MANAGEABILITYInsight_Category=4// The insight is related to sustainability.Insight_SUSTAINABILITYInsight_Category=5// This insight is related to reliability.Insight_RELIABILITYInsight_Category=6)
const(// Insight has unspecified severity.Insight_SEVERITY_UNSPECIFIEDInsight_Severity=0// Insight has low severity.Insight_LOWInsight_Severity=1// Insight has medium severity.Insight_MEDIUMInsight_Severity=2// Insight has high severity.Insight_HIGHInsight_Severity=3// Insight has critical severity.Insight_CRITICALInsight_Severity=4)
typeListInsightsRequeststruct{// Required. The container resource on which to execute the request.// Acceptable formats://// * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`//// * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`//// * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`//// * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`//// * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`//// LOCATION here refers to GCP Locations:// https://cloud.google.com/about/locations/// INSIGHT_TYPE_ID refers to supported insight types:// https://cloud.google.com/recommender/docs/insights/insight-types.Parentstring`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// Optional. The maximum number of results to return from this request.// Non-positive values are ignored. If not specified, the server will// determine the number of results to return.PageSizeint32`protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`// Optional. If present, retrieves the next batch of results from the// preceding call to this method. `page_token` must be the value of// `next_page_token` from the previous response. The values of other method// parameters must be identical to those in the previous call.PageTokenstring`protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`// Optional. Filter expression to restrict the insights returned. Supported// filter fields://// * `stateInfo.state`//// * `insightSubtype`//// * `severity`//// * `targetResources`//// Examples://// * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`//// * `insightSubtype = PERMISSIONS_USAGE`//// * `severity = CRITICAL OR severity = HIGH`//// * `targetResources :// //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`//// * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`//// The max allowed filter length is 500 characters.//// (These expressions are based on the filter language described at// https://google.aip.dev/160)Filterstring`protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`// contains filtered or unexported fields}
typeListInsightsResponsestruct{// The set of insights for the `parent` resource.Insights[]*Insight`protobuf:"bytes,1,rep,name=insights,proto3" json:"insights,omitempty"`// A token that can be used to request the next page of results. This field is// empty if there are no additional results.NextPageTokenstring`protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`// contains filtered or unexported fields}
typeListRecommendationsRequeststruct{// Required. The container resource on which to execute the request.// Acceptable formats://// * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`//// * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`//// * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`//// * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`//// * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`//// LOCATION here refers to GCP Locations:// https://cloud.google.com/about/locations/// RECOMMENDER_ID refers to supported recommenders:// https://cloud.google.com/recommender/docs/recommenders.Parentstring`protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`// Optional. The maximum number of results to return from this request.// Non-positive values are ignored. If not specified, the server will// determine the number of results to return.PageSizeint32`protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`// Optional. If present, retrieves the next batch of results from the// preceding call to this method. `page_token` must be the value of// `next_page_token` from the previous response. The values of other method// parameters must be identical to those in the previous call.PageTokenstring`protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`// Filter expression to restrict the recommendations returned. Supported// filter fields://// * `state_info.state`//// * `recommenderSubtype`//// * `priority`//// * `targetResources`//// Examples://// * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`//// * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`//// * `priority = P1 OR priority = P2`//// * `targetResources :// //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`//// * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`//// The max allowed filter length is 500 characters.//// (These expressions are based on the filter language described at// https://google.aip.dev/160)Filterstring`protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"`// contains filtered or unexported fields}
typeListRecommendationsResponsestruct{// The set of recommendations for the `parent` resource.Recommendations[]*Recommendation`protobuf:"bytes,1,rep,name=recommendations,proto3" json:"recommendations,omitempty"`// A token that can be used to request the next page of results. This field is// empty if there are no additional results.NextPageTokenstring`protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`// contains filtered or unexported fields}
typeMarkInsightAcceptedRequeststruct{// Required. Name of the insight.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Optional. State properties user wish to include with this state. Full// replace of the current state_metadata.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// Required. Fingerprint of the Insight. Provides optimistic locking.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// contains filtered or unexported fields}
typeMarkRecommendationClaimedRequeststruct{// Required. Name of the recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// State properties to include with this state. Overwrites any existing// `state_metadata`.// Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// Required. Fingerprint of the Recommendation. Provides optimistic locking.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// contains filtered or unexported fields}
typeMarkRecommendationDismissedRequeststruct{// Required. Name of the recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Fingerprint of the Recommendation. Provides optimistic locking.Etagstring`protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`// contains filtered or unexported fields}
Request for the MarkRecommendationDismissed Method.
typeMarkRecommendationFailedRequeststruct{// Required. Name of the recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// State properties to include with this state. Overwrites any existing// `state_metadata`.// Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// Required. Fingerprint of the Recommendation. Provides optimistic locking.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// contains filtered or unexported fields}
typeMarkRecommendationSucceededRequeststruct{// Required. Name of the recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// State properties to include with this state. Overwrites any existing// `state_metadata`.// Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// Required. Fingerprint of the Recommendation. Provides optimistic locking.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// contains filtered or unexported fields}
Request for the MarkRecommendationSucceeded Method.
typeOperationstruct{// Type of this operation. Contains one of 'add', 'remove', 'replace', 'move',// 'copy', 'test' and custom operations. This field is case-insensitive and// always populated.Actionstring`protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`// Type of GCP resource being modified/tested. This field is always populated.// Example: cloudresourcemanager.googleapis.com/Project,// compute.googleapis.com/InstanceResourceTypestring`protobuf:"bytes,2,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`// Contains the fully qualified resource name. This field is always populated.// ex: //cloudresourcemanager.googleapis.com/projects/foo.Resourcestring`protobuf:"bytes,3,opt,name=resource,proto3" json:"resource,omitempty"`// Path to the target field being operated on. If the operation is at the// resource level, then path should be "/". This field is always populated.Pathstring`protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`// Can be set with action 'copy' to copy resource configuration across// different resources of the same type. Example: A resource clone can be// done via action = 'copy', path = "/", from = "/",// source_resource = and resource_name =
Contains an operation for a resource loosely based on the JSON-PATCH format
with support for:
Custom filters for describing partial array patch.
Extended path values for describing nested arrays.
Custom fields for describing the resource for which the operation is being
described.
Allows extension to custom operations not natively supported by RFC6902.
typeOperationGroupstruct{// List of operations across one or more resources that belong to this group.// Loosely based on RFC6902 and should be performed in the order they appear.Operations[]*Operation`protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`// contains filtered or unexported fields}
Group of operations that need to be performed atomically.
typeOperation_Valuestruct{// Value for the `path` field. Will be set for actions:'add'/'replace'.// Maybe set for action: 'test'. Either this or `value_matcher` will be set// for 'test' operation. An exact match must be performed.Value*structpb.Value`protobuf:"bytes,7,opt,name=value,proto3,oneof"`}
Operation_ValueMatcher
typeOperation_ValueMatcherstruct{// Can be set for action 'test' for advanced matching for the value of// 'path' field. Either this or `value` will be set for 'test' operation.ValueMatcher*ValueMatcher`protobuf:"bytes,10,opt,name=value_matcher,json=valueMatcher,proto3,oneof"`}
Recommendation
typeRecommendationstruct{// Name of recommendation.Namestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// Free-form human readable summary in English. The maximum length is 500// characters.Descriptionstring`protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`// 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"RecommenderSubtypestring`protobuf:"bytes,12,opt,name=recommender_subtype,json=recommenderSubtype,proto3" json:"recommender_subtype,omitempty"`// Last time this recommendation was refreshed by the system that created it// in the first place.LastRefreshTime*timestamppb.Timestamp`protobuf:"bytes,4,opt,name=last_refresh_time,json=lastRefreshTime,proto3" json:"last_refresh_time,omitempty"`// The primary impact that this recommendation can have while trying to// optimize for one category.PrimaryImpact*Impact`protobuf:"bytes,5,opt,name=primary_impact,json=primaryImpact,proto3" json:"primary_impact,omitempty"`// Optional set of additional impact that this recommendation may have when// trying to optimize for the primary category. These may be positive// or negative.AdditionalImpact[]*Impact`protobuf:"bytes,6,rep,name=additional_impact,json=additionalImpact,proto3" json:"additional_impact,omitempty"`// Recommendation's priority.PriorityRecommendation_Priority`protobuf:"varint,17,opt,name=priority,proto3,enum=google.cloud.recommender.v1.Recommendation_Priority" json:"priority,omitempty"`// Content of the recommendation describing recommended changes to resources.Content*RecommendationContent`protobuf:"bytes,7,opt,name=content,proto3" json:"content,omitempty"`// Information for state. Contains state and metadata.StateInfo*RecommendationStateInfo`protobuf:"bytes,10,opt,name=state_info,json=stateInfo,proto3" json:"state_info,omitempty"`// Fingerprint of the Recommendation. Provides optimistic locking when// updating states.Etagstring`protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`// Insights that led to this recommendation.AssociatedInsights[]*Recommendation_InsightReference`protobuf:"bytes,14,rep,name=associated_insights,json=associatedInsights,proto3" json:"associated_insights,omitempty"`// 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.XorGroupIdstring`protobuf:"bytes,18,opt,name=xor_group_id,json=xorGroupId,proto3" json:"xor_group_id,omitempty"`// contains filtered or unexported fields}
A recommendation along with a suggested action. E.g., a rightsizing
recommendation for an underutilized VM, IAM role recommendations, etc
typeRecommendationContentstruct{// Operations to one or more Google Cloud resources grouped in such a way// that, all operations within one group are expected to be performed// atomically and in an order.OperationGroups[]*OperationGroup`protobuf:"bytes,2,rep,name=operation_groups,json=operationGroups,proto3" json:"operation_groups,omitempty"`// Condensed overview information about the recommendation.Overview*structpb.Struct`protobuf:"bytes,3,opt,name=overview,proto3" json:"overview,omitempty"`// contains filtered or unexported fields}
Contains what resources are changing and how they are changing.
typeRecommendationStateInfostruct{// The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.StateRecommendationStateInfo_State`protobuf:"varint,1,opt,name=state,proto3,enum=google.cloud.recommender.v1.RecommendationStateInfo_State" json:"state,omitempty"`// A map of metadata for the state, provided by user or automations systems.StateMetadatamap[string]string`protobuf:"bytes,2,rep,name=state_metadata,json=stateMetadata,proto3" json:"state_metadata,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// contains filtered or unexported fields}
Information for state. Contains state and metadata.
const(// Default state. Don't use directly.RecommendationStateInfo_STATE_UNSPECIFIEDRecommendationStateInfo_State=0// Recommendation is active and can be applied. Recommendations content can// be updated by Google.//// ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.RecommendationStateInfo_ACTIVERecommendationStateInfo_State=1// Recommendation is in claimed state. Recommendations content is// immutable and cannot be updated by Google.//// CLAIMED recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.RecommendationStateInfo_CLAIMEDRecommendationStateInfo_State=6// Recommendation is in succeeded state. Recommendations content is// immutable and cannot be updated by Google.//// SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.RecommendationStateInfo_SUCCEEDEDRecommendationStateInfo_State=3// Recommendation is in failed state. Recommendations content is immutable// and cannot be updated by Google.//// FAILED recommendations can be marked as SUCCEEDED, or FAILED.RecommendationStateInfo_FAILEDRecommendationStateInfo_State=4// Recommendation is in dismissed state. Recommendation content can be// updated by Google.//// DISMISSED recommendations can be marked as ACTIVE.RecommendationStateInfo_DISMISSEDRecommendationStateInfo_State=5)
typeRecommenderClientinterface{// Lists insights for the specified Cloud Resource. Requires the// recommender.*.list IAM permission for the specified insight type.ListInsights(ctxcontext.Context,in*ListInsightsRequest,opts...grpc.CallOption)(*ListInsightsResponse,error)// Gets the requested insight. Requires the recommender.*.get IAM permission// for the specified insight type.GetInsight(ctxcontext.Context,in*GetInsightRequest,opts...grpc.CallOption)(*Insight,error)// Marks the Insight State as Accepted. Users can use this method to// indicate to the Recommender API that they have applied some action based// on the insight. This stops the insight content from being updated.//// MarkInsightAccepted can be applied to insights in ACTIVE state. Requires// the recommender.*.update IAM permission for the specified insight.MarkInsightAccepted(ctxcontext.Context,in*MarkInsightAcceptedRequest,opts...grpc.CallOption)(*Insight,error)// Lists recommendations for the specified Cloud Resource. Requires the// recommender.*.list IAM permission for the specified recommender.ListRecommendations(ctxcontext.Context,in*ListRecommendationsRequest,opts...grpc.CallOption)(*ListRecommendationsResponse,error)// Gets the requested recommendation. Requires the recommender.*.get// IAM permission for the specified recommender.GetRecommendation(ctxcontext.Context,in*GetRecommendationRequest,opts...grpc.CallOption)(*Recommendation,error)// Mark the Recommendation State as Dismissed. Users can use this method to// indicate to the Recommender API that an ACTIVE recommendation has to// be marked back as DISMISSED.//// MarkRecommendationDismissed can be applied to recommendations in ACTIVE// state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationDismissed(ctxcontext.Context,in*MarkRecommendationDismissedRequest,opts...grpc.CallOption)(*Recommendation,error)// Marks the Recommendation State as Claimed. Users can use this method to// indicate to the Recommender API that they are starting to apply the// recommendation themselves. This stops the recommendation content from being// updated. Associated insights are frozen and placed in the ACCEPTED state.//// MarkRecommendationClaimed can be applied to recommendations in CLAIMED,// SUCCEEDED, FAILED, or ACTIVE state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationClaimed(ctxcontext.Context,in*MarkRecommendationClaimedRequest,opts...grpc.CallOption)(*Recommendation,error)// Marks the Recommendation State as Succeeded. Users can use this method to// indicate to the Recommender API that they have applied the recommendation// themselves, and the operation was successful. This stops the recommendation// content from being updated. Associated insights are frozen and placed in// the ACCEPTED state.//// MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,// CLAIMED, SUCCEEDED, or FAILED state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationSucceeded(ctxcontext.Context,in*MarkRecommendationSucceededRequest,opts...grpc.CallOption)(*Recommendation,error)// Marks the Recommendation State as Failed. Users can use this method to// indicate to the Recommender API that they have applied the recommendation// themselves, and the operation failed. This stops the recommendation content// from being updated. Associated insights are frozen and placed in the// ACCEPTED state.//// MarkRecommendationFailed can be applied to recommendations in ACTIVE,// CLAIMED, SUCCEEDED, or FAILED state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationFailed(ctxcontext.Context,in*MarkRecommendationFailedRequest,opts...grpc.CallOption)(*Recommendation,error)// Gets the requested Recommender Config. There is only one instance of the// config for each Recommender.GetRecommenderConfig(ctxcontext.Context,in*GetRecommenderConfigRequest,opts...grpc.CallOption)(*RecommenderConfig,error)// Updates a Recommender Config. This will create a new revision of the// config.UpdateRecommenderConfig(ctxcontext.Context,in*UpdateRecommenderConfigRequest,opts...grpc.CallOption)(*RecommenderConfig,error)// Gets the requested InsightTypeConfig. There is only one instance of the// config for each InsightType.GetInsightTypeConfig(ctxcontext.Context,in*GetInsightTypeConfigRequest,opts...grpc.CallOption)(*InsightTypeConfig,error)// Updates an InsightTypeConfig change. This will create a new revision of the// config.UpdateInsightTypeConfig(ctxcontext.Context,in*UpdateInsightTypeConfigRequest,opts...grpc.CallOption)(*InsightTypeConfig,error)}
RecommenderClient is the client API for Recommender service.
typeRecommenderConfigstruct{// Name of recommender config.// Eg,// projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/configNamestring`protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`// RecommenderGenerationConfig which configures the Generation of// recommendations for this recommender.RecommenderGenerationConfig*RecommenderGenerationConfig`protobuf:"bytes,2,opt,name=recommender_generation_config,json=recommenderGenerationConfig,proto3" json:"recommender_generation_config,omitempty"`// Fingerprint of the RecommenderConfig. Provides optimistic locking when// updating.Etagstring`protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`// Last time when the config was updated.UpdateTime*timestamppb.Timestamp`protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`// Output only. Immutable. The revision ID of the config.// A new revision is committed whenever the config is changed in any way.// The format is an 8-character hexadecimal string.RevisionIdstring`protobuf:"bytes,5,opt,name=revision_id,json=revisionId,proto3" json:"revision_id,omitempty"`// Allows clients to store small amounts of arbitrary data. Annotations must// follow the Kubernetes syntax.// The total size of all keys and values combined is limited to 256k.// Key can have 2 segments: prefix (optional) and name (required),// separated by a slash (/).// Prefix must be a DNS subdomain.// Name must be 63 characters or less, begin and end with alphanumerics,// with dashes (-), underscores (_), dots (.), and alphanumerics between.Annotationsmap[string]string`protobuf:"bytes,6,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`// A user-settable field to provide a human-readable name to be used in user// interfaces.DisplayNamestring`protobuf:"bytes,7,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`// contains filtered or unexported fields}
typeRecommenderGenerationConfigstruct{// Parameters for this RecommenderGenerationConfig. These configs can be used// by or are applied to all subtypes.Params*structpb.Struct`protobuf:"bytes,1,opt,name=params,proto3" json:"params,omitempty"`// contains filtered or unexported fields}
A Configuration to customize the generation of recommendations.
Eg, customizing the lookback period considered when generating a
recommendation.
typeRecommenderServerinterface{// Lists insights for the specified Cloud Resource. Requires the// recommender.*.list IAM permission for the specified insight type.ListInsights(context.Context,*ListInsightsRequest)(*ListInsightsResponse,error)// Gets the requested insight. Requires the recommender.*.get IAM permission// for the specified insight type.GetInsight(context.Context,*GetInsightRequest)(*Insight,error)// Marks the Insight State as Accepted. Users can use this method to// indicate to the Recommender API that they have applied some action based// on the insight. This stops the insight content from being updated.//// MarkInsightAccepted can be applied to insights in ACTIVE state. Requires// the recommender.*.update IAM permission for the specified insight.MarkInsightAccepted(context.Context,*MarkInsightAcceptedRequest)(*Insight,error)// Lists recommendations for the specified Cloud Resource. Requires the// recommender.*.list IAM permission for the specified recommender.ListRecommendations(context.Context,*ListRecommendationsRequest)(*ListRecommendationsResponse,error)// Gets the requested recommendation. Requires the recommender.*.get// IAM permission for the specified recommender.GetRecommendation(context.Context,*GetRecommendationRequest)(*Recommendation,error)// Mark the Recommendation State as Dismissed. Users can use this method to// indicate to the Recommender API that an ACTIVE recommendation has to// be marked back as DISMISSED.//// MarkRecommendationDismissed can be applied to recommendations in ACTIVE// state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationDismissed(context.Context,*MarkRecommendationDismissedRequest)(*Recommendation,error)// Marks the Recommendation State as Claimed. Users can use this method to// indicate to the Recommender API that they are starting to apply the// recommendation themselves. This stops the recommendation content from being// updated. Associated insights are frozen and placed in the ACCEPTED state.//// MarkRecommendationClaimed can be applied to recommendations in CLAIMED,// SUCCEEDED, FAILED, or ACTIVE state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationClaimed(context.Context,*MarkRecommendationClaimedRequest)(*Recommendation,error)// Marks the Recommendation State as Succeeded. Users can use this method to// indicate to the Recommender API that they have applied the recommendation// themselves, and the operation was successful. This stops the recommendation// content from being updated. Associated insights are frozen and placed in// the ACCEPTED state.//// MarkRecommendationSucceeded can be applied to recommendations in ACTIVE,// CLAIMED, SUCCEEDED, or FAILED state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationSucceeded(context.Context,*MarkRecommendationSucceededRequest)(*Recommendation,error)// Marks the Recommendation State as Failed. Users can use this method to// indicate to the Recommender API that they have applied the recommendation// themselves, and the operation failed. This stops the recommendation content// from being updated. Associated insights are frozen and placed in the// ACCEPTED state.//// MarkRecommendationFailed can be applied to recommendations in ACTIVE,// CLAIMED, SUCCEEDED, or FAILED state.//// Requires the recommender.*.update IAM permission for the specified// recommender.MarkRecommendationFailed(context.Context,*MarkRecommendationFailedRequest)(*Recommendation,error)// Gets the requested Recommender Config. There is only one instance of the// config for each Recommender.GetRecommenderConfig(context.Context,*GetRecommenderConfigRequest)(*RecommenderConfig,error)// Updates a Recommender Config. This will create a new revision of the// config.UpdateRecommenderConfig(context.Context,*UpdateRecommenderConfigRequest)(*RecommenderConfig,error)// Gets the requested InsightTypeConfig. There is only one instance of the// config for each InsightType.GetInsightTypeConfig(context.Context,*GetInsightTypeConfigRequest)(*InsightTypeConfig,error)// Updates an InsightTypeConfig change. This will create a new revision of the// config.UpdateInsightTypeConfig(context.Context,*UpdateInsightTypeConfigRequest)(*InsightTypeConfig,error)}
RecommenderServer is the server API for Recommender service.
All implementations should embed UnimplementedRecommenderServer
for forward compatibility
ReliabilityProjection
typeReliabilityProjectionstruct{// Reliability risks mitigated by this recommendation.Risks[]ReliabilityProjection_RiskType`protobuf:"varint,1,rep,packed,name=risks,proto3,enum=google.cloud.recommender.v1.ReliabilityProjection_RiskType" json:"risks,omitempty"`// Per-recommender projection.Details*structpb.Struct`protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`// contains filtered or unexported fields}
Contains information on the impact of a reliability recommendation.
typeSecurityProjectionstruct{// Additional security impact details that is provided by the recommender.Details*structpb.Struct`protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`// contains filtered or unexported fields}
Contains various ways of describing the impact on Security.
typeSustainabilityProjectionstruct{// Carbon Footprint generated in kg of CO2 equivalent.// Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e).KgCO2Efloat64`protobuf:"fixed64,1,opt,name=kg_c_o2e,json=kgCO2e,proto3" json:"kg_c_o2e,omitempty"`// Duration for which this sustainability applies.Duration*durationpb.Duration`protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`// contains filtered or unexported fields}
Contains metadata about how much sustainability a recommendation can save or
incur.
typeUnsafeRecommenderServerinterface{// contains filtered or unexported methods}
UnsafeRecommenderServer may be embedded to opt out of forward compatibility for this service.
Use of this interface is not recommended, as added methods to RecommenderServer will
result in compilation errors.
UpdateInsightTypeConfigRequest
typeUpdateInsightTypeConfigRequeststruct{// Required. The InsightTypeConfig to update.InsightTypeConfig*InsightTypeConfig`protobuf:"bytes,1,opt,name=insight_type_config,json=insightTypeConfig,proto3" json:"insight_type_config,omitempty"`// The list of fields to be updated.UpdateMask*fieldmaskpb.FieldMask`protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`// If true, validate the request and preview the change, but do not actually// update it.ValidateOnlybool`protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`// contains filtered or unexported fields}
typeUpdateRecommenderConfigRequeststruct{// Required. The RecommenderConfig to update.RecommenderConfig*RecommenderConfig`protobuf:"bytes,1,opt,name=recommender_config,json=recommenderConfig,proto3" json:"recommender_config,omitempty"`// The list of fields to be updated.UpdateMask*fieldmaskpb.FieldMask`protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`// If true, validate the request and preview the change, but do not actually// update it.ValidateOnlybool`protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`// contains filtered or unexported fields}
typeValueMatcherstruct{// Types that are assignable to MatchVariant://// *ValueMatcher_MatchesPatternMatchVariantisValueMatcher_MatchVariant`protobuf_oneof:"match_variant"`// contains filtered or unexported fields}
Contains various matching options for values for a GCP resource field.
typeValueMatcher_MatchesPatternstruct{// To be used for full regex matching. The regular expression is using the// Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be// used with RE2::FullMatchMatchesPatternstring`protobuf:"bytes,1,opt,name=matches_pattern,json=matchesPattern,proto3,oneof"`}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
