Documentation ¶
Index ¶
- Variables
- func RegisterRecommenderServer(s *grpc.Server, srv RecommenderServer)
- type CostProjection
- func (*CostProjection) Descriptor() ([]byte, []int)deprecated
- func (x *CostProjection) GetCost() *money.Money
- func (x *CostProjection) GetDuration() *durationpb.Duration
- func (*CostProjection) ProtoMessage()
- func (x *CostProjection) ProtoReflect() protoreflect.Message
- func (x *CostProjection) Reset()
- func (x *CostProjection) String() string
- type GetInsightRequest
- type GetRecommendationRequest
- func (*GetRecommendationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetRecommendationRequest) GetName() string
- func (*GetRecommendationRequest) ProtoMessage()
- func (x *GetRecommendationRequest) ProtoReflect() protoreflect.Message
- func (x *GetRecommendationRequest) Reset()
- func (x *GetRecommendationRequest) String() string
- type Impact
- func (*Impact) Descriptor() ([]byte, []int)deprecated
- func (x *Impact) GetCategory() Impact_Category
- func (x *Impact) GetCostProjection() *CostProjection
- func (m *Impact) GetProjection() isImpact_Projection
- func (*Impact) ProtoMessage()
- func (x *Impact) ProtoReflect() protoreflect.Message
- func (x *Impact) Reset()
- func (x *Impact) String() string
- type Impact_Category
- func (Impact_Category) Descriptor() protoreflect.EnumDescriptor
- func (x Impact_Category) Enum() *Impact_Category
- func (Impact_Category) EnumDescriptor() ([]byte, []int)deprecated
- func (x Impact_Category) Number() protoreflect.EnumNumber
- func (x Impact_Category) String() string
- func (Impact_Category) Type() protoreflect.EnumType
- type Impact_CostProjection
- type Insight
- func (*Insight) Descriptor() ([]byte, []int)deprecated
- func (x *Insight) GetAssociatedRecommendations() []*Insight_RecommendationReference
- func (x *Insight) GetCategory() Insight_Category
- func (x *Insight) GetContent() *structpb.Struct
- func (x *Insight) GetDescription() string
- func (x *Insight) GetEtag() string
- func (x *Insight) GetInsightSubtype() string
- func (x *Insight) GetLastRefreshTime() *timestamppb.Timestamp
- func (x *Insight) GetName() string
- func (x *Insight) GetObservationPeriod() *durationpb.Duration
- func (x *Insight) GetStateInfo() *InsightStateInfo
- func (x *Insight) GetTargetResources() []string
- func (*Insight) ProtoMessage()
- func (x *Insight) ProtoReflect() protoreflect.Message
- func (x *Insight) Reset()
- func (x *Insight) String() string
- type InsightStateInfo
- func (*InsightStateInfo) Descriptor() ([]byte, []int)deprecated
- func (x *InsightStateInfo) GetState() InsightStateInfo_State
- func (x *InsightStateInfo) GetStateMetadata() map[string]string
- func (*InsightStateInfo) ProtoMessage()
- func (x *InsightStateInfo) ProtoReflect() protoreflect.Message
- func (x *InsightStateInfo) Reset()
- func (x *InsightStateInfo) String() string
- type InsightStateInfo_State
- func (InsightStateInfo_State) Descriptor() protoreflect.EnumDescriptor
- func (x InsightStateInfo_State) Enum() *InsightStateInfo_State
- func (InsightStateInfo_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x InsightStateInfo_State) Number() protoreflect.EnumNumber
- func (x InsightStateInfo_State) String() string
- func (InsightStateInfo_State) Type() protoreflect.EnumType
- type Insight_Category
- func (Insight_Category) Descriptor() protoreflect.EnumDescriptor
- func (x Insight_Category) Enum() *Insight_Category
- func (Insight_Category) EnumDescriptor() ([]byte, []int)deprecated
- func (x Insight_Category) Number() protoreflect.EnumNumber
- func (x Insight_Category) String() string
- func (Insight_Category) Type() protoreflect.EnumType
- type Insight_RecommendationReference
- func (*Insight_RecommendationReference) Descriptor() ([]byte, []int)deprecated
- func (x *Insight_RecommendationReference) GetRecommendation() string
- func (*Insight_RecommendationReference) ProtoMessage()
- func (x *Insight_RecommendationReference) ProtoReflect() protoreflect.Message
- func (x *Insight_RecommendationReference) Reset()
- func (x *Insight_RecommendationReference) String() string
- type ListInsightsRequest
- func (*ListInsightsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListInsightsRequest) GetFilter() string
- func (x *ListInsightsRequest) GetPageSize() int32
- func (x *ListInsightsRequest) GetPageToken() string
- func (x *ListInsightsRequest) GetParent() string
- func (*ListInsightsRequest) ProtoMessage()
- func (x *ListInsightsRequest) ProtoReflect() protoreflect.Message
- func (x *ListInsightsRequest) Reset()
- func (x *ListInsightsRequest) String() string
- type ListInsightsResponse
- func (*ListInsightsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListInsightsResponse) GetInsights() []*Insight
- func (x *ListInsightsResponse) GetNextPageToken() string
- func (*ListInsightsResponse) ProtoMessage()
- func (x *ListInsightsResponse) ProtoReflect() protoreflect.Message
- func (x *ListInsightsResponse) Reset()
- func (x *ListInsightsResponse) String() string
- type ListRecommendationsRequest
- func (*ListRecommendationsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListRecommendationsRequest) GetFilter() string
- func (x *ListRecommendationsRequest) GetPageSize() int32
- func (x *ListRecommendationsRequest) GetPageToken() string
- func (x *ListRecommendationsRequest) GetParent() string
- func (*ListRecommendationsRequest) ProtoMessage()
- func (x *ListRecommendationsRequest) ProtoReflect() protoreflect.Message
- func (x *ListRecommendationsRequest) Reset()
- func (x *ListRecommendationsRequest) String() string
- type ListRecommendationsResponse
- func (*ListRecommendationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListRecommendationsResponse) GetNextPageToken() string
- func (x *ListRecommendationsResponse) GetRecommendations() []*Recommendation
- func (*ListRecommendationsResponse) ProtoMessage()
- func (x *ListRecommendationsResponse) ProtoReflect() protoreflect.Message
- func (x *ListRecommendationsResponse) Reset()
- func (x *ListRecommendationsResponse) String() string
- type MarkInsightAcceptedRequest
- func (*MarkInsightAcceptedRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MarkInsightAcceptedRequest) GetEtag() string
- func (x *MarkInsightAcceptedRequest) GetName() string
- func (x *MarkInsightAcceptedRequest) GetStateMetadata() map[string]string
- func (*MarkInsightAcceptedRequest) ProtoMessage()
- func (x *MarkInsightAcceptedRequest) ProtoReflect() protoreflect.Message
- func (x *MarkInsightAcceptedRequest) Reset()
- func (x *MarkInsightAcceptedRequest) String() string
- type MarkRecommendationClaimedRequest
- func (*MarkRecommendationClaimedRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MarkRecommendationClaimedRequest) GetEtag() string
- func (x *MarkRecommendationClaimedRequest) GetName() string
- func (x *MarkRecommendationClaimedRequest) GetStateMetadata() map[string]string
- func (*MarkRecommendationClaimedRequest) ProtoMessage()
- func (x *MarkRecommendationClaimedRequest) ProtoReflect() protoreflect.Message
- func (x *MarkRecommendationClaimedRequest) Reset()
- func (x *MarkRecommendationClaimedRequest) String() string
- type MarkRecommendationFailedRequest
- func (*MarkRecommendationFailedRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MarkRecommendationFailedRequest) GetEtag() string
- func (x *MarkRecommendationFailedRequest) GetName() string
- func (x *MarkRecommendationFailedRequest) GetStateMetadata() map[string]string
- func (*MarkRecommendationFailedRequest) ProtoMessage()
- func (x *MarkRecommendationFailedRequest) ProtoReflect() protoreflect.Message
- func (x *MarkRecommendationFailedRequest) Reset()
- func (x *MarkRecommendationFailedRequest) String() string
- type MarkRecommendationSucceededRequest
- func (*MarkRecommendationSucceededRequest) Descriptor() ([]byte, []int)deprecated
- func (x *MarkRecommendationSucceededRequest) GetEtag() string
- func (x *MarkRecommendationSucceededRequest) GetName() string
- func (x *MarkRecommendationSucceededRequest) GetStateMetadata() map[string]string
- func (*MarkRecommendationSucceededRequest) ProtoMessage()
- func (x *MarkRecommendationSucceededRequest) ProtoReflect() protoreflect.Message
- func (x *MarkRecommendationSucceededRequest) Reset()
- func (x *MarkRecommendationSucceededRequest) String() string
- type Operation
- func (*Operation) Descriptor() ([]byte, []int)deprecated
- func (x *Operation) GetAction() string
- func (x *Operation) GetPath() string
- func (x *Operation) GetPathFilters() map[string]*structpb.Value
- func (m *Operation) GetPathValue() isOperation_PathValue
- func (x *Operation) GetPathValueMatchers() map[string]*ValueMatcher
- func (x *Operation) GetResource() string
- func (x *Operation) GetResourceType() string
- func (x *Operation) GetSourcePath() string
- func (x *Operation) GetSourceResource() string
- func (x *Operation) GetValue() *structpb.Value
- func (x *Operation) GetValueMatcher() *ValueMatcher
- func (*Operation) ProtoMessage()
- func (x *Operation) ProtoReflect() protoreflect.Message
- func (x *Operation) Reset()
- func (x *Operation) String() string
- type OperationGroup
- type Operation_Value
- type Operation_ValueMatcher
- type Recommendation
- func (*Recommendation) Descriptor() ([]byte, []int)deprecated
- func (x *Recommendation) GetAdditionalImpact() []*Impact
- func (x *Recommendation) GetAssociatedInsights() []*Recommendation_InsightReference
- func (x *Recommendation) GetContent() *RecommendationContent
- func (x *Recommendation) GetDescription() string
- func (x *Recommendation) GetEtag() string
- func (x *Recommendation) GetLastRefreshTime() *timestamppb.Timestamp
- func (x *Recommendation) GetName() string
- func (x *Recommendation) GetPrimaryImpact() *Impact
- func (x *Recommendation) GetRecommenderSubtype() string
- func (x *Recommendation) GetStateInfo() *RecommendationStateInfo
- func (*Recommendation) ProtoMessage()
- func (x *Recommendation) ProtoReflect() protoreflect.Message
- func (x *Recommendation) Reset()
- func (x *Recommendation) String() string
- type RecommendationContent
- func (*RecommendationContent) Descriptor() ([]byte, []int)deprecated
- func (x *RecommendationContent) GetOperationGroups() []*OperationGroup
- func (*RecommendationContent) ProtoMessage()
- func (x *RecommendationContent) ProtoReflect() protoreflect.Message
- func (x *RecommendationContent) Reset()
- func (x *RecommendationContent) String() string
- type RecommendationStateInfo
- func (*RecommendationStateInfo) Descriptor() ([]byte, []int)deprecated
- func (x *RecommendationStateInfo) GetState() RecommendationStateInfo_State
- func (x *RecommendationStateInfo) GetStateMetadata() map[string]string
- func (*RecommendationStateInfo) ProtoMessage()
- func (x *RecommendationStateInfo) ProtoReflect() protoreflect.Message
- func (x *RecommendationStateInfo) Reset()
- func (x *RecommendationStateInfo) String() string
- type RecommendationStateInfo_State
- func (RecommendationStateInfo_State) Descriptor() protoreflect.EnumDescriptor
- func (x RecommendationStateInfo_State) Enum() *RecommendationStateInfo_State
- func (RecommendationStateInfo_State) EnumDescriptor() ([]byte, []int)deprecated
- func (x RecommendationStateInfo_State) Number() protoreflect.EnumNumber
- func (x RecommendationStateInfo_State) String() string
- func (RecommendationStateInfo_State) Type() protoreflect.EnumType
- type Recommendation_InsightReference
- func (*Recommendation_InsightReference) Descriptor() ([]byte, []int)deprecated
- func (x *Recommendation_InsightReference) GetInsight() string
- func (*Recommendation_InsightReference) ProtoMessage()
- func (x *Recommendation_InsightReference) ProtoReflect() protoreflect.Message
- func (x *Recommendation_InsightReference) Reset()
- func (x *Recommendation_InsightReference) String() string
- type RecommenderClient
- type RecommenderServer
- type UnimplementedRecommenderServer
- func (*UnimplementedRecommenderServer) GetInsight(context.Context, *GetInsightRequest) (*Insight, error)
- func (*UnimplementedRecommenderServer) GetRecommendation(context.Context, *GetRecommendationRequest) (*Recommendation, error)
- func (*UnimplementedRecommenderServer) ListInsights(context.Context, *ListInsightsRequest) (*ListInsightsResponse, error)
- func (*UnimplementedRecommenderServer) ListRecommendations(context.Context, *ListRecommendationsRequest) (*ListRecommendationsResponse, error)
- func (*UnimplementedRecommenderServer) MarkInsightAccepted(context.Context, *MarkInsightAcceptedRequest) (*Insight, error)
- func (*UnimplementedRecommenderServer) MarkRecommendationClaimed(context.Context, *MarkRecommendationClaimedRequest) (*Recommendation, error)
- func (*UnimplementedRecommenderServer) MarkRecommendationFailed(context.Context, *MarkRecommendationFailedRequest) (*Recommendation, error)
- func (*UnimplementedRecommenderServer) MarkRecommendationSucceeded(context.Context, *MarkRecommendationSucceededRequest) (*Recommendation, error)
- type ValueMatcher
- func (*ValueMatcher) Descriptor() ([]byte, []int)deprecated
- func (m *ValueMatcher) GetMatchVariant() isValueMatcher_MatchVariant
- func (x *ValueMatcher) GetMatchesPattern() string
- func (*ValueMatcher) ProtoMessage()
- func (x *ValueMatcher) ProtoReflect() protoreflect.Message
- func (x *ValueMatcher) Reset()
- func (x *ValueMatcher) String() string
- type ValueMatcher_MatchesPattern
Constants ¶
This section is empty.
Variables ¶
var ( Insight_Category_name = map[int32]string{ 0: "CATEGORY_UNSPECIFIED", 1: "COST", 2: "SECURITY", 3: "PERFORMANCE", 4: "MANAGEABILITY", } Insight_Category_value = map[string]int32{ "CATEGORY_UNSPECIFIED": 0, "COST": 1, "SECURITY": 2, "PERFORMANCE": 3, "MANAGEABILITY": 4, } )
Enum value maps for Insight_Category.
var ( InsightStateInfo_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "ACTIVE", 2: "ACCEPTED", 3: "DISMISSED", } InsightStateInfo_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "ACTIVE": 1, "ACCEPTED": 2, "DISMISSED": 3, } )
Enum value maps for InsightStateInfo_State.
var ( Impact_Category_name = map[int32]string{ 0: "CATEGORY_UNSPECIFIED", 1: "COST", 2: "SECURITY", 3: "PERFORMANCE", 4: "MANAGEABILITY", } Impact_Category_value = map[string]int32{ "CATEGORY_UNSPECIFIED": 0, "COST": 1, "SECURITY": 2, "PERFORMANCE": 3, "MANAGEABILITY": 4, } )
Enum value maps for Impact_Category.
var ( RecommendationStateInfo_State_name = map[int32]string{ 0: "STATE_UNSPECIFIED", 1: "ACTIVE", 6: "CLAIMED", 3: "SUCCEEDED", 4: "FAILED", 5: "DISMISSED", } RecommendationStateInfo_State_value = map[string]int32{ "STATE_UNSPECIFIED": 0, "ACTIVE": 1, "CLAIMED": 6, "SUCCEEDED": 3, "FAILED": 4, "DISMISSED": 5, } )
Enum value maps for RecommendationStateInfo_State.
var File_google_cloud_recommender_v1_insight_proto protoreflect.FileDescriptor
var File_google_cloud_recommender_v1_recommendation_proto protoreflect.FileDescriptor
var File_google_cloud_recommender_v1_recommender_service_proto protoreflect.FileDescriptor
Functions ¶
func RegisterRecommenderServer ¶
func RegisterRecommenderServer(s *grpc.Server, srv RecommenderServer)
Types ¶
type CostProjection ¶
type CostProjection struct { // 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. 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"` // contains filtered or unexported fields }
Contains metadata about how much money a recommendation can save or incur.
func (*CostProjection) Descriptor
deprecated
func (*CostProjection) Descriptor() ([]byte, []int)
Deprecated: Use CostProjection.ProtoReflect.Descriptor instead.
func (*CostProjection) GetCost ¶
func (x *CostProjection) GetCost() *money.Money
func (*CostProjection) GetDuration ¶
func (x *CostProjection) GetDuration() *durationpb.Duration
func (*CostProjection) ProtoMessage ¶
func (*CostProjection) ProtoMessage()
func (*CostProjection) ProtoReflect ¶
func (x *CostProjection) ProtoReflect() protoreflect.Message
func (*CostProjection) Reset ¶
func (x *CostProjection) Reset()
func (*CostProjection) String ¶
func (x *CostProjection) String() string
type GetInsightRequest ¶
type GetInsightRequest struct { // Required. Name of the insight. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Request to the `GetInsight` method.
func (*GetInsightRequest) Descriptor
deprecated
func (*GetInsightRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetInsightRequest.ProtoReflect.Descriptor instead.
func (*GetInsightRequest) GetName ¶
func (x *GetInsightRequest) GetName() string
func (*GetInsightRequest) ProtoMessage ¶
func (*GetInsightRequest) ProtoMessage()
func (*GetInsightRequest) ProtoReflect ¶
func (x *GetInsightRequest) ProtoReflect() protoreflect.Message
func (*GetInsightRequest) Reset ¶
func (x *GetInsightRequest) Reset()
func (*GetInsightRequest) String ¶
func (x *GetInsightRequest) String() string
type GetRecommendationRequest ¶
type GetRecommendationRequest struct { // Required. Name of the recommendation. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
Request to the `GetRecommendation` method.
func (*GetRecommendationRequest) Descriptor
deprecated
func (*GetRecommendationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRecommendationRequest.ProtoReflect.Descriptor instead.
func (*GetRecommendationRequest) GetName ¶
func (x *GetRecommendationRequest) GetName() string
func (*GetRecommendationRequest) ProtoMessage ¶
func (*GetRecommendationRequest) ProtoMessage()
func (*GetRecommendationRequest) ProtoReflect ¶
func (x *GetRecommendationRequest) ProtoReflect() protoreflect.Message
func (*GetRecommendationRequest) Reset ¶
func (x *GetRecommendationRequest) Reset()
func (*GetRecommendationRequest) String ¶
func (x *GetRecommendationRequest) String() string
type Impact ¶
type Impact struct { // Category that is being targeted. Category Impact_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 Projection isImpact_Projection `protobuf_oneof:"projection"` // contains filtered or unexported fields }
Contains the impact a recommendation can have for a given category.
func (*Impact) Descriptor
deprecated
func (*Impact) GetCategory ¶
func (x *Impact) GetCategory() Impact_Category
func (*Impact) GetCostProjection ¶
func (x *Impact) GetCostProjection() *CostProjection
func (*Impact) GetProjection ¶
func (m *Impact) GetProjection() isImpact_Projection
func (*Impact) ProtoMessage ¶
func (*Impact) ProtoMessage()
func (*Impact) ProtoReflect ¶
func (x *Impact) ProtoReflect() protoreflect.Message
type Impact_Category ¶
type Impact_Category int32
The category of the impact.
const ( // Default unspecified category. Don't use directly. Impact_CATEGORY_UNSPECIFIED Impact_Category = 0 // Indicates a potential increase or decrease in cost. Impact_COST Impact_Category = 1 // Indicates a potential increase or decrease in security. Impact_SECURITY Impact_Category = 2 // Indicates a potential increase or decrease in performance. Impact_PERFORMANCE Impact_Category = 3 // Indicates a potential increase or decrease in manageability. Impact_MANAGEABILITY Impact_Category = 4 )
func (Impact_Category) Descriptor ¶
func (Impact_Category) Descriptor() protoreflect.EnumDescriptor
func (Impact_Category) Enum ¶
func (x Impact_Category) Enum() *Impact_Category
func (Impact_Category) EnumDescriptor
deprecated
func (Impact_Category) EnumDescriptor() ([]byte, []int)
Deprecated: Use Impact_Category.Descriptor instead.
func (Impact_Category) Number ¶
func (x Impact_Category) Number() protoreflect.EnumNumber
func (Impact_Category) String ¶
func (x Impact_Category) String() string
func (Impact_Category) Type ¶
func (Impact_Category) Type() protoreflect.EnumType
type Impact_CostProjection ¶
type Impact_CostProjection struct { // Use with CategoryType.COST CostProjection *CostProjection `protobuf:"bytes,100,opt,name=cost_projection,json=costProjection,proto3,oneof"` }
type Insight ¶
type Insight struct { // Name of the insight. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Free-form human readable summary in English. The maximum length is 500 // characters. Description string `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. InsightSubtype string `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. Category Insight_Category `protobuf:"varint,7,opt,name=category,proto3,enum=google.cloud.recommender.v1.Insight_Category" json:"category,omitempty"` // Fingerprint of the Insight. Provides optimistic locking when updating // states. Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"` // Recommendations derived from this insight. AssociatedRecommendations []*Insight_RecommendationReference `` /* 136-byte string literal not displayed */ // contains filtered or unexported fields }
An insight along with the information used to derive the insight. The insight may have associated recomendations as well.
func (*Insight) Descriptor
deprecated
func (*Insight) GetAssociatedRecommendations ¶
func (x *Insight) GetAssociatedRecommendations() []*Insight_RecommendationReference
func (*Insight) GetCategory ¶
func (x *Insight) GetCategory() Insight_Category
func (*Insight) GetContent ¶
func (*Insight) GetDescription ¶
func (*Insight) GetInsightSubtype ¶
func (*Insight) GetLastRefreshTime ¶
func (x *Insight) GetLastRefreshTime() *timestamppb.Timestamp
func (*Insight) GetObservationPeriod ¶
func (x *Insight) GetObservationPeriod() *durationpb.Duration
func (*Insight) GetStateInfo ¶
func (x *Insight) GetStateInfo() *InsightStateInfo
func (*Insight) GetTargetResources ¶
func (*Insight) ProtoMessage ¶
func (*Insight) ProtoMessage()
func (*Insight) ProtoReflect ¶
func (x *Insight) ProtoReflect() protoreflect.Message
type InsightStateInfo ¶
type InsightStateInfo struct { // Insight state. State InsightStateInfo_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. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // contains filtered or unexported fields }
Information related to insight state.
func (*InsightStateInfo) Descriptor
deprecated
func (*InsightStateInfo) Descriptor() ([]byte, []int)
Deprecated: Use InsightStateInfo.ProtoReflect.Descriptor instead.
func (*InsightStateInfo) GetState ¶
func (x *InsightStateInfo) GetState() InsightStateInfo_State
func (*InsightStateInfo) GetStateMetadata ¶
func (x *InsightStateInfo) GetStateMetadata() map[string]string
func (*InsightStateInfo) ProtoMessage ¶
func (*InsightStateInfo) ProtoMessage()
func (*InsightStateInfo) ProtoReflect ¶
func (x *InsightStateInfo) ProtoReflect() protoreflect.Message
func (*InsightStateInfo) Reset ¶
func (x *InsightStateInfo) Reset()
func (*InsightStateInfo) String ¶
func (x *InsightStateInfo) String() string
type InsightStateInfo_State ¶
type InsightStateInfo_State int32
Represents insight state.
const ( // Unspecified state. InsightStateInfo_STATE_UNSPECIFIED InsightStateInfo_State = 0 // Insight is active. Content for ACTIVE insights can be updated by Google. // ACTIVE insights can be marked DISMISSED OR ACCEPTED. InsightStateInfo_ACTIVE InsightStateInfo_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_ACCEPTED InsightStateInfo_State = 2 // Insight is dismissed. Content for DISMISSED insights can be updated by // Google. DISMISSED insights can be marked as ACTIVE. InsightStateInfo_DISMISSED InsightStateInfo_State = 3 )
func (InsightStateInfo_State) Descriptor ¶
func (InsightStateInfo_State) Descriptor() protoreflect.EnumDescriptor
func (InsightStateInfo_State) Enum ¶
func (x InsightStateInfo_State) Enum() *InsightStateInfo_State
func (InsightStateInfo_State) EnumDescriptor
deprecated
func (InsightStateInfo_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use InsightStateInfo_State.Descriptor instead.
func (InsightStateInfo_State) Number ¶
func (x InsightStateInfo_State) Number() protoreflect.EnumNumber
func (InsightStateInfo_State) String ¶
func (x InsightStateInfo_State) String() string
func (InsightStateInfo_State) Type ¶
func (InsightStateInfo_State) Type() protoreflect.EnumType
type Insight_Category ¶
type Insight_Category int32
Insight category.
const ( // Unspecified category. Insight_CATEGORY_UNSPECIFIED Insight_Category = 0 // The insight is related to cost. Insight_COST Insight_Category = 1 // The insight is related to security. Insight_SECURITY Insight_Category = 2 // The insight is related to performance. Insight_PERFORMANCE Insight_Category = 3 // This insight is related to manageability. Insight_MANAGEABILITY Insight_Category = 4 )
func (Insight_Category) Descriptor ¶
func (Insight_Category) Descriptor() protoreflect.EnumDescriptor
func (Insight_Category) Enum ¶
func (x Insight_Category) Enum() *Insight_Category
func (Insight_Category) EnumDescriptor
deprecated
func (Insight_Category) EnumDescriptor() ([]byte, []int)
Deprecated: Use Insight_Category.Descriptor instead.
func (Insight_Category) Number ¶
func (x Insight_Category) Number() protoreflect.EnumNumber
func (Insight_Category) String ¶
func (x Insight_Category) String() string
func (Insight_Category) Type ¶
func (Insight_Category) Type() protoreflect.EnumType
type Insight_RecommendationReference ¶
type Insight_RecommendationReference struct { // Recommendation resource name, e.g. // projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] Recommendation string `protobuf:"bytes,1,opt,name=recommendation,proto3" json:"recommendation,omitempty"` // contains filtered or unexported fields }
Reference to an associated recommendation.
func (*Insight_RecommendationReference) Descriptor
deprecated
func (*Insight_RecommendationReference) Descriptor() ([]byte, []int)
Deprecated: Use Insight_RecommendationReference.ProtoReflect.Descriptor instead.
func (*Insight_RecommendationReference) GetRecommendation ¶
func (x *Insight_RecommendationReference) GetRecommendation() string
func (*Insight_RecommendationReference) ProtoMessage ¶
func (*Insight_RecommendationReference) ProtoMessage()
func (*Insight_RecommendationReference) ProtoReflect ¶
func (x *Insight_RecommendationReference) ProtoReflect() protoreflect.Message
func (*Insight_RecommendationReference) Reset ¶
func (x *Insight_RecommendationReference) Reset()
func (*Insight_RecommendationReference) String ¶
func (x *Insight_RecommendationReference) String() string
type ListInsightsRequest ¶
type ListInsightsRequest struct { // Required. The container resource on which to execute the request. // Acceptable formats: // // 1. // "projects/[PROJECT_NUMBER]/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.) Parent string `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. PageSize int32 `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. PageToken string `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: state // Eg: `state:"DISMISSED" or state:"ACTIVE" Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"` // contains filtered or unexported fields }
Request for the `ListInsights` method.
func (*ListInsightsRequest) Descriptor
deprecated
func (*ListInsightsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListInsightsRequest.ProtoReflect.Descriptor instead.
func (*ListInsightsRequest) GetFilter ¶
func (x *ListInsightsRequest) GetFilter() string
func (*ListInsightsRequest) GetPageSize ¶
func (x *ListInsightsRequest) GetPageSize() int32
func (*ListInsightsRequest) GetPageToken ¶
func (x *ListInsightsRequest) GetPageToken() string
func (*ListInsightsRequest) GetParent ¶
func (x *ListInsightsRequest) GetParent() string
func (*ListInsightsRequest) ProtoMessage ¶
func (*ListInsightsRequest) ProtoMessage()
func (*ListInsightsRequest) ProtoReflect ¶
func (x *ListInsightsRequest) ProtoReflect() protoreflect.Message
func (*ListInsightsRequest) Reset ¶
func (x *ListInsightsRequest) Reset()
func (*ListInsightsRequest) String ¶
func (x *ListInsightsRequest) String() string
type ListInsightsResponse ¶
type ListInsightsResponse struct { // 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. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
Response to the `ListInsights` method.
func (*ListInsightsResponse) Descriptor
deprecated
func (*ListInsightsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListInsightsResponse.ProtoReflect.Descriptor instead.
func (*ListInsightsResponse) GetInsights ¶
func (x *ListInsightsResponse) GetInsights() []*Insight
func (*ListInsightsResponse) GetNextPageToken ¶
func (x *ListInsightsResponse) GetNextPageToken() string
func (*ListInsightsResponse) ProtoMessage ¶
func (*ListInsightsResponse) ProtoMessage()
func (*ListInsightsResponse) ProtoReflect ¶
func (x *ListInsightsResponse) ProtoReflect() protoreflect.Message
func (*ListInsightsResponse) Reset ¶
func (x *ListInsightsResponse) Reset()
func (*ListInsightsResponse) String ¶
func (x *ListInsightsResponse) String() string
type ListRecommendationsRequest ¶
type ListRecommendationsRequest struct { // Required. The container resource on which to execute the request. // Acceptable formats: // // 1. // "projects/[PROJECT_NUMBER]/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. Parent string `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. PageSize int32 `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. PageToken string `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 // Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" Filter string `protobuf:"bytes,5,opt,name=filter,proto3" json:"filter,omitempty"` // contains filtered or unexported fields }
Request for the `ListRecommendations` method.
func (*ListRecommendationsRequest) Descriptor
deprecated
func (*ListRecommendationsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRecommendationsRequest.ProtoReflect.Descriptor instead.
func (*ListRecommendationsRequest) GetFilter ¶
func (x *ListRecommendationsRequest) GetFilter() string
func (*ListRecommendationsRequest) GetPageSize ¶
func (x *ListRecommendationsRequest) GetPageSize() int32
func (*ListRecommendationsRequest) GetPageToken ¶
func (x *ListRecommendationsRequest) GetPageToken() string
func (*ListRecommendationsRequest) GetParent ¶
func (x *ListRecommendationsRequest) GetParent() string
func (*ListRecommendationsRequest) ProtoMessage ¶
func (*ListRecommendationsRequest) ProtoMessage()
func (*ListRecommendationsRequest) ProtoReflect ¶
func (x *ListRecommendationsRequest) ProtoReflect() protoreflect.Message
func (*ListRecommendationsRequest) Reset ¶
func (x *ListRecommendationsRequest) Reset()
func (*ListRecommendationsRequest) String ¶
func (x *ListRecommendationsRequest) String() string
type ListRecommendationsResponse ¶
type ListRecommendationsResponse struct { // 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. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
Response to the `ListRecommendations` method.
func (*ListRecommendationsResponse) Descriptor
deprecated
func (*ListRecommendationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListRecommendationsResponse.ProtoReflect.Descriptor instead.
func (*ListRecommendationsResponse) GetNextPageToken ¶
func (x *ListRecommendationsResponse) GetNextPageToken() string
func (*ListRecommendationsResponse) GetRecommendations ¶
func (x *ListRecommendationsResponse) GetRecommendations() []*Recommendation
func (*ListRecommendationsResponse) ProtoMessage ¶
func (*ListRecommendationsResponse) ProtoMessage()
func (*ListRecommendationsResponse) ProtoReflect ¶
func (x *ListRecommendationsResponse) ProtoReflect() protoreflect.Message
func (*ListRecommendationsResponse) Reset ¶
func (x *ListRecommendationsResponse) Reset()
func (*ListRecommendationsResponse) String ¶
func (x *ListRecommendationsResponse) String() string
type MarkInsightAcceptedRequest ¶
type MarkInsightAcceptedRequest struct { // Required. Name of the insight. Name string `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. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // Required. Fingerprint of the Insight. Provides optimistic locking. Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
Request for the `MarkInsightAccepted` method.
func (*MarkInsightAcceptedRequest) Descriptor
deprecated
func (*MarkInsightAcceptedRequest) Descriptor() ([]byte, []int)
Deprecated: Use MarkInsightAcceptedRequest.ProtoReflect.Descriptor instead.
func (*MarkInsightAcceptedRequest) GetEtag ¶
func (x *MarkInsightAcceptedRequest) GetEtag() string
func (*MarkInsightAcceptedRequest) GetName ¶
func (x *MarkInsightAcceptedRequest) GetName() string
func (*MarkInsightAcceptedRequest) GetStateMetadata ¶
func (x *MarkInsightAcceptedRequest) GetStateMetadata() map[string]string
func (*MarkInsightAcceptedRequest) ProtoMessage ¶
func (*MarkInsightAcceptedRequest) ProtoMessage()
func (*MarkInsightAcceptedRequest) ProtoReflect ¶
func (x *MarkInsightAcceptedRequest) ProtoReflect() protoreflect.Message
func (*MarkInsightAcceptedRequest) Reset ¶
func (x *MarkInsightAcceptedRequest) Reset()
func (*MarkInsightAcceptedRequest) String ¶
func (x *MarkInsightAcceptedRequest) String() string
type MarkRecommendationClaimedRequest ¶
type MarkRecommendationClaimedRequest struct { // Required. Name of the recommendation. Name string `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}$/. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // Required. Fingerprint of the Recommendation. Provides optimistic locking. Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
Request for the `MarkRecommendationClaimed` Method.
func (*MarkRecommendationClaimedRequest) Descriptor
deprecated
func (*MarkRecommendationClaimedRequest) Descriptor() ([]byte, []int)
Deprecated: Use MarkRecommendationClaimedRequest.ProtoReflect.Descriptor instead.
func (*MarkRecommendationClaimedRequest) GetEtag ¶
func (x *MarkRecommendationClaimedRequest) GetEtag() string
func (*MarkRecommendationClaimedRequest) GetName ¶
func (x *MarkRecommendationClaimedRequest) GetName() string
func (*MarkRecommendationClaimedRequest) GetStateMetadata ¶
func (x *MarkRecommendationClaimedRequest) GetStateMetadata() map[string]string
func (*MarkRecommendationClaimedRequest) ProtoMessage ¶
func (*MarkRecommendationClaimedRequest) ProtoMessage()
func (*MarkRecommendationClaimedRequest) ProtoReflect ¶
func (x *MarkRecommendationClaimedRequest) ProtoReflect() protoreflect.Message
func (*MarkRecommendationClaimedRequest) Reset ¶
func (x *MarkRecommendationClaimedRequest) Reset()
func (*MarkRecommendationClaimedRequest) String ¶
func (x *MarkRecommendationClaimedRequest) String() string
type MarkRecommendationFailedRequest ¶
type MarkRecommendationFailedRequest struct { // Required. Name of the recommendation. Name string `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}$/. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // Required. Fingerprint of the Recommendation. Provides optimistic locking. Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
Request for the `MarkRecommendationFailed` Method.
func (*MarkRecommendationFailedRequest) Descriptor
deprecated
func (*MarkRecommendationFailedRequest) Descriptor() ([]byte, []int)
Deprecated: Use MarkRecommendationFailedRequest.ProtoReflect.Descriptor instead.
func (*MarkRecommendationFailedRequest) GetEtag ¶
func (x *MarkRecommendationFailedRequest) GetEtag() string
func (*MarkRecommendationFailedRequest) GetName ¶
func (x *MarkRecommendationFailedRequest) GetName() string
func (*MarkRecommendationFailedRequest) GetStateMetadata ¶
func (x *MarkRecommendationFailedRequest) GetStateMetadata() map[string]string
func (*MarkRecommendationFailedRequest) ProtoMessage ¶
func (*MarkRecommendationFailedRequest) ProtoMessage()
func (*MarkRecommendationFailedRequest) ProtoReflect ¶
func (x *MarkRecommendationFailedRequest) ProtoReflect() protoreflect.Message
func (*MarkRecommendationFailedRequest) Reset ¶
func (x *MarkRecommendationFailedRequest) Reset()
func (*MarkRecommendationFailedRequest) String ¶
func (x *MarkRecommendationFailedRequest) String() string
type MarkRecommendationSucceededRequest ¶
type MarkRecommendationSucceededRequest struct { // Required. Name of the recommendation. Name string `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}$/. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // Required. Fingerprint of the Recommendation. Provides optimistic locking. Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"` // contains filtered or unexported fields }
Request for the `MarkRecommendationSucceeded` Method.
func (*MarkRecommendationSucceededRequest) Descriptor
deprecated
func (*MarkRecommendationSucceededRequest) Descriptor() ([]byte, []int)
Deprecated: Use MarkRecommendationSucceededRequest.ProtoReflect.Descriptor instead.
func (*MarkRecommendationSucceededRequest) GetEtag ¶
func (x *MarkRecommendationSucceededRequest) GetEtag() string
func (*MarkRecommendationSucceededRequest) GetName ¶
func (x *MarkRecommendationSucceededRequest) GetName() string
func (*MarkRecommendationSucceededRequest) GetStateMetadata ¶
func (x *MarkRecommendationSucceededRequest) GetStateMetadata() map[string]string
func (*MarkRecommendationSucceededRequest) ProtoMessage ¶
func (*MarkRecommendationSucceededRequest) ProtoMessage()
func (*MarkRecommendationSucceededRequest) ProtoReflect ¶
func (x *MarkRecommendationSucceededRequest) ProtoReflect() protoreflect.Message
func (*MarkRecommendationSucceededRequest) Reset ¶
func (x *MarkRecommendationSucceededRequest) Reset()
func (*MarkRecommendationSucceededRequest) String ¶
func (x *MarkRecommendationSucceededRequest) String() string
type Operation ¶
type Operation struct { // Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', // 'copy', 'test' and custom operations. This field is case-insensitive and // always populated. Action string `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/Instance ResourceType string `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. Resource string `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. Path string `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 = <source> and resource_name = <target>. // This field is empty for all other values of `action`. SourceResource string `protobuf:"bytes,5,opt,name=source_resource,json=sourceResource,proto3" json:"source_resource,omitempty"` // Can be set with action 'copy' or 'move' to indicate the source field within // resource or source_resource, ignored if provided for other operation types. SourcePath string `protobuf:"bytes,6,opt,name=source_path,json=sourcePath,proto3" json:"source_path,omitempty"` // One of the fields in the following block will be set and intend to // describe a value for 'path' field. // // Types that are assignable to PathValue: // *Operation_Value // *Operation_ValueMatcher PathValue isOperation_PathValue `protobuf_oneof:"path_value"` // Set of filters to apply if `path` refers to array elements or nested array // elements in order to narrow down to a single unique element that is being // tested/modified. // This is intended to be an exact match per filter. To perform advanced // matching, use path_value_matchers. // // * Example: { // "/versions/*/name" : "it-123" // "/versions/*/targetSize/percent": 20 // } // * Example: { // "/bindings/*/role": "roles/owner" // "/bindings/*/condition" : null // } // * Example: { // "/bindings/*/role": "roles/owner" // "/bindings/*/members/*" : ["x@example.com", "y@example.com"] // } // When both path_filters and path_value_matchers are set, an implicit AND // must be performed. PathFilters map[string]*structpb.Value `` /* 182-byte string literal not displayed */ // Similar to path_filters, this contains set of filters to apply if `path` // field referes to array elements. This is meant to support value matching // beyond exact match. To perform exact match, use path_filters. // When both path_filters and path_value_matchers are set, an implicit AND // must be performed. PathValueMatchers map[string]*ValueMatcher `` /* 203-byte string literal not displayed */ // contains filtered or unexported fields }
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.
See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
func (*Operation) Descriptor
deprecated
func (*Operation) GetPathValue ¶
func (m *Operation) GetPathValue() isOperation_PathValue
func (*Operation) GetPathValueMatchers ¶
func (x *Operation) GetPathValueMatchers() map[string]*ValueMatcher
func (*Operation) GetResource ¶
func (*Operation) GetResourceType ¶
func (*Operation) GetSourcePath ¶
func (*Operation) GetSourceResource ¶
func (*Operation) GetValueMatcher ¶
func (x *Operation) GetValueMatcher() *ValueMatcher
func (*Operation) ProtoMessage ¶
func (*Operation) ProtoMessage()
func (*Operation) ProtoReflect ¶
func (x *Operation) ProtoReflect() protoreflect.Message
type OperationGroup ¶
type OperationGroup struct { // 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.
func (*OperationGroup) Descriptor
deprecated
func (*OperationGroup) Descriptor() ([]byte, []int)
Deprecated: Use OperationGroup.ProtoReflect.Descriptor instead.
func (*OperationGroup) GetOperations ¶
func (x *OperationGroup) GetOperations() []*Operation
func (*OperationGroup) ProtoMessage ¶
func (*OperationGroup) ProtoMessage()
func (*OperationGroup) ProtoReflect ¶
func (x *OperationGroup) ProtoReflect() protoreflect.Message
func (*OperationGroup) Reset ¶
func (x *OperationGroup) Reset()
func (*OperationGroup) String ¶
func (x *OperationGroup) String() string
type Operation_Value ¶
type Operation_Value struct { // 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"` }
type Operation_ValueMatcher ¶
type Operation_ValueMatcher struct { // 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"` }
type Recommendation ¶
type Recommendation struct { // Name of recommendation. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Free-form human readable summary in English. The maximum length is 500 // characters. Description string `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" RecommenderSubtype string `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"` // 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. Etag string `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"` // 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
func (*Recommendation) Descriptor
deprecated
func (*Recommendation) Descriptor() ([]byte, []int)
Deprecated: Use Recommendation.ProtoReflect.Descriptor instead.
func (*Recommendation) GetAdditionalImpact ¶
func (x *Recommendation) GetAdditionalImpact() []*Impact
func (*Recommendation) GetAssociatedInsights ¶
func (x *Recommendation) GetAssociatedInsights() []*Recommendation_InsightReference
func (*Recommendation) GetContent ¶
func (x *Recommendation) GetContent() *RecommendationContent
func (*Recommendation) GetDescription ¶
func (x *Recommendation) GetDescription() string
func (*Recommendation) GetEtag ¶
func (x *Recommendation) GetEtag() string
func (*Recommendation) GetLastRefreshTime ¶
func (x *Recommendation) GetLastRefreshTime() *timestamppb.Timestamp
func (*Recommendation) GetName ¶
func (x *Recommendation) GetName() string
func (*Recommendation) GetPrimaryImpact ¶
func (x *Recommendation) GetPrimaryImpact() *Impact
func (*Recommendation) GetRecommenderSubtype ¶
func (x *Recommendation) GetRecommenderSubtype() string
func (*Recommendation) GetStateInfo ¶
func (x *Recommendation) GetStateInfo() *RecommendationStateInfo
func (*Recommendation) ProtoMessage ¶
func (*Recommendation) ProtoMessage()
func (*Recommendation) ProtoReflect ¶
func (x *Recommendation) ProtoReflect() protoreflect.Message
func (*Recommendation) Reset ¶
func (x *Recommendation) Reset()
func (*Recommendation) String ¶
func (x *Recommendation) String() string
type RecommendationContent ¶
type RecommendationContent struct { // 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"` // contains filtered or unexported fields }
Contains what resources are changing and how they are changing.
func (*RecommendationContent) Descriptor
deprecated
func (*RecommendationContent) Descriptor() ([]byte, []int)
Deprecated: Use RecommendationContent.ProtoReflect.Descriptor instead.
func (*RecommendationContent) GetOperationGroups ¶
func (x *RecommendationContent) GetOperationGroups() []*OperationGroup
func (*RecommendationContent) ProtoMessage ¶
func (*RecommendationContent) ProtoMessage()
func (*RecommendationContent) ProtoReflect ¶
func (x *RecommendationContent) ProtoReflect() protoreflect.Message
func (*RecommendationContent) Reset ¶
func (x *RecommendationContent) Reset()
func (*RecommendationContent) String ¶
func (x *RecommendationContent) String() string
type RecommendationStateInfo ¶
type RecommendationStateInfo struct { // The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED. State RecommendationStateInfo_State `` /* 127-byte string literal not displayed */ // A map of metadata for the state, provided by user or automations systems. StateMetadata map[string]string `` /* 188-byte string literal not displayed */ // contains filtered or unexported fields }
Information for state. Contains state and metadata.
func (*RecommendationStateInfo) Descriptor
deprecated
func (*RecommendationStateInfo) Descriptor() ([]byte, []int)
Deprecated: Use RecommendationStateInfo.ProtoReflect.Descriptor instead.
func (*RecommendationStateInfo) GetState ¶
func (x *RecommendationStateInfo) GetState() RecommendationStateInfo_State
func (*RecommendationStateInfo) GetStateMetadata ¶
func (x *RecommendationStateInfo) GetStateMetadata() map[string]string
func (*RecommendationStateInfo) ProtoMessage ¶
func (*RecommendationStateInfo) ProtoMessage()
func (*RecommendationStateInfo) ProtoReflect ¶
func (x *RecommendationStateInfo) ProtoReflect() protoreflect.Message
func (*RecommendationStateInfo) Reset ¶
func (x *RecommendationStateInfo) Reset()
func (*RecommendationStateInfo) String ¶
func (x *RecommendationStateInfo) String() string
type RecommendationStateInfo_State ¶
type RecommendationStateInfo_State int32
Represents Recommendation State.
const ( // Default state. Don't use directly. RecommendationStateInfo_STATE_UNSPECIFIED RecommendationStateInfo_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_ACTIVE RecommendationStateInfo_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_CLAIMED RecommendationStateInfo_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_SUCCEEDED RecommendationStateInfo_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_FAILED RecommendationStateInfo_State = 4 // Recommendation is in dismissed state. Recommendation content can be // updated by Google. // // DISMISSED recommendations can be marked as ACTIVE. RecommendationStateInfo_DISMISSED RecommendationStateInfo_State = 5 )
func (RecommendationStateInfo_State) Descriptor ¶
func (RecommendationStateInfo_State) Descriptor() protoreflect.EnumDescriptor
func (RecommendationStateInfo_State) Enum ¶
func (x RecommendationStateInfo_State) Enum() *RecommendationStateInfo_State
func (RecommendationStateInfo_State) EnumDescriptor
deprecated
func (RecommendationStateInfo_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use RecommendationStateInfo_State.Descriptor instead.
func (RecommendationStateInfo_State) Number ¶
func (x RecommendationStateInfo_State) Number() protoreflect.EnumNumber
func (RecommendationStateInfo_State) String ¶
func (x RecommendationStateInfo_State) String() string
func (RecommendationStateInfo_State) Type ¶
func (RecommendationStateInfo_State) Type() protoreflect.EnumType
type Recommendation_InsightReference ¶
type Recommendation_InsightReference struct { // Insight resource name, e.g. // projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] Insight string `protobuf:"bytes,1,opt,name=insight,proto3" json:"insight,omitempty"` // contains filtered or unexported fields }
Reference to an associated insight.
func (*Recommendation_InsightReference) Descriptor
deprecated
func (*Recommendation_InsightReference) Descriptor() ([]byte, []int)
Deprecated: Use Recommendation_InsightReference.ProtoReflect.Descriptor instead.
func (*Recommendation_InsightReference) GetInsight ¶
func (x *Recommendation_InsightReference) GetInsight() string
func (*Recommendation_InsightReference) ProtoMessage ¶
func (*Recommendation_InsightReference) ProtoMessage()
func (*Recommendation_InsightReference) ProtoReflect ¶
func (x *Recommendation_InsightReference) ProtoReflect() protoreflect.Message
func (*Recommendation_InsightReference) Reset ¶
func (x *Recommendation_InsightReference) Reset()
func (*Recommendation_InsightReference) String ¶
func (x *Recommendation_InsightReference) String() string
type RecommenderClient ¶
type RecommenderClient interface { // Lists insights for a Cloud project. Requires the recommender.*.list IAM // permission for the specified insight type. ListInsights(ctx context.Context, in *ListInsightsRequest, opts ...grpc.CallOption) (*ListInsightsResponse, error) // Gets the requested insight. Requires the recommender.*.get IAM permission // for the specified insight type. GetInsight(ctx context.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(ctx context.Context, in *MarkInsightAcceptedRequest, opts ...grpc.CallOption) (*Insight, error) // Lists recommendations for a Cloud project. Requires the recommender.*.list // IAM permission for the specified recommender. ListRecommendations(ctx context.Context, in *ListRecommendationsRequest, opts ...grpc.CallOption) (*ListRecommendationsResponse, error) // Gets the requested recommendation. Requires the recommender.*.get // IAM permission for the specified recommender. GetRecommendation(ctx context.Context, in *GetRecommendationRequest, 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(ctx context.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(ctx context.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(ctx context.Context, in *MarkRecommendationFailedRequest, opts ...grpc.CallOption) (*Recommendation, error) }
RecommenderClient is the client API for Recommender service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewRecommenderClient ¶
func NewRecommenderClient(cc grpc.ClientConnInterface) RecommenderClient
type RecommenderServer ¶
type RecommenderServer interface { // Lists insights for a Cloud project. 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 a Cloud project. 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) // 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) }
RecommenderServer is the server API for Recommender service.
type UnimplementedRecommenderServer ¶
type UnimplementedRecommenderServer struct { }
UnimplementedRecommenderServer can be embedded to have forward compatible implementations.
func (*UnimplementedRecommenderServer) GetInsight ¶
func (*UnimplementedRecommenderServer) GetInsight(context.Context, *GetInsightRequest) (*Insight, error)
func (*UnimplementedRecommenderServer) GetRecommendation ¶
func (*UnimplementedRecommenderServer) GetRecommendation(context.Context, *GetRecommendationRequest) (*Recommendation, error)
func (*UnimplementedRecommenderServer) ListInsights ¶
func (*UnimplementedRecommenderServer) ListInsights(context.Context, *ListInsightsRequest) (*ListInsightsResponse, error)
func (*UnimplementedRecommenderServer) ListRecommendations ¶
func (*UnimplementedRecommenderServer) ListRecommendations(context.Context, *ListRecommendationsRequest) (*ListRecommendationsResponse, error)
func (*UnimplementedRecommenderServer) MarkInsightAccepted ¶
func (*UnimplementedRecommenderServer) MarkInsightAccepted(context.Context, *MarkInsightAcceptedRequest) (*Insight, error)
func (*UnimplementedRecommenderServer) MarkRecommendationClaimed ¶
func (*UnimplementedRecommenderServer) MarkRecommendationClaimed(context.Context, *MarkRecommendationClaimedRequest) (*Recommendation, error)
func (*UnimplementedRecommenderServer) MarkRecommendationFailed ¶
func (*UnimplementedRecommenderServer) MarkRecommendationFailed(context.Context, *MarkRecommendationFailedRequest) (*Recommendation, error)
func (*UnimplementedRecommenderServer) MarkRecommendationSucceeded ¶
func (*UnimplementedRecommenderServer) MarkRecommendationSucceeded(context.Context, *MarkRecommendationSucceededRequest) (*Recommendation, error)
type ValueMatcher ¶
type ValueMatcher struct { // Types that are assignable to MatchVariant: // *ValueMatcher_MatchesPattern MatchVariant isValueMatcher_MatchVariant `protobuf_oneof:"match_variant"` // contains filtered or unexported fields }
Contains various matching options for values for a GCP resource field.
func (*ValueMatcher) Descriptor
deprecated
func (*ValueMatcher) Descriptor() ([]byte, []int)
Deprecated: Use ValueMatcher.ProtoReflect.Descriptor instead.
func (*ValueMatcher) GetMatchVariant ¶
func (m *ValueMatcher) GetMatchVariant() isValueMatcher_MatchVariant
func (*ValueMatcher) GetMatchesPattern ¶
func (x *ValueMatcher) GetMatchesPattern() string
func (*ValueMatcher) ProtoMessage ¶
func (*ValueMatcher) ProtoMessage()
func (*ValueMatcher) ProtoReflect ¶
func (x *ValueMatcher) ProtoReflect() protoreflect.Message
func (*ValueMatcher) Reset ¶
func (x *ValueMatcher) Reset()
func (*ValueMatcher) String ¶
func (x *ValueMatcher) String() string
type ValueMatcher_MatchesPattern ¶
type ValueMatcher_MatchesPattern struct { // 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::FullMatch MatchesPattern string `protobuf:"bytes,1,opt,name=matches_pattern,json=matchesPattern,proto3,oneof"` }