Package cloud.google.com/go/recommender/apiv1/recommenderpb (v1.13.5)

Variables

Insight_Category_name, Insight_Category_value

var (
	Insight_Category_name = map[int32]string{
		0: "CATEGORY_UNSPECIFIED",
		1: "COST",
		2: "SECURITY",
		3: "PERFORMANCE",
		4: "MANAGEABILITY",
		5: "SUSTAINABILITY",
		6: "RELIABILITY",
	}
	Insight_Category_value = map[string]int32{
		"CATEGORY_UNSPECIFIED": 0,
		"COST":                 1,
		"SECURITY":             2,
		"PERFORMANCE":          3,
		"MANAGEABILITY":        4,
		"SUSTAINABILITY":       5,
		"RELIABILITY":          6,
	}
)

Enum value maps for Insight_Category.

Insight_Severity_name, Insight_Severity_value

var (
	Insight_Severity_name = map[int32]string{
		0: "SEVERITY_UNSPECIFIED",
		1: "LOW",
		2: "MEDIUM",
		3: "HIGH",
		4: "CRITICAL",
	}
	Insight_Severity_value = map[string]int32{
		"SEVERITY_UNSPECIFIED": 0,
		"LOW":                  1,
		"MEDIUM":               2,
		"HIGH":                 3,
		"CRITICAL":             4,
	}
)

Enum value maps for Insight_Severity.

InsightStateInfo_State_name, InsightStateInfo_State_value

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.

Recommendation_Priority_name, Recommendation_Priority_value

var (
	Recommendation_Priority_name = map[int32]string{
		0: "PRIORITY_UNSPECIFIED",
		1: "P4",
		2: "P3",
		3: "P2",
		4: "P1",
	}
	Recommendation_Priority_value = map[string]int32{
		"PRIORITY_UNSPECIFIED": 0,
		"P4":                   1,
		"P3":                   2,
		"P2":                   3,
		"P1":                   4,
	}
)

Enum value maps for Recommendation_Priority.

ReliabilityProjection_RiskType_name, ReliabilityProjection_RiskType_value

var (
	ReliabilityProjection_RiskType_name = map[int32]string{
		0: "RISK_TYPE_UNSPECIFIED",
		1: "SERVICE_DISRUPTION",
		2: "DATA_LOSS",
		3: "ACCESS_DENY",
	}
	ReliabilityProjection_RiskType_value = map[string]int32{
		"RISK_TYPE_UNSPECIFIED": 0,
		"SERVICE_DISRUPTION":    1,
		"DATA_LOSS":             2,
		"ACCESS_DENY":           3,
	}
)

Enum value maps for ReliabilityProjection_RiskType.

Impact_Category_name, Impact_Category_value

var (
	Impact_Category_name = map[int32]string{
		0: "CATEGORY_UNSPECIFIED",
		1: "COST",
		2: "SECURITY",
		3: "PERFORMANCE",
		4: "MANAGEABILITY",
		5: "SUSTAINABILITY",
		6: "RELIABILITY",
	}
	Impact_Category_value = map[string]int32{
		"CATEGORY_UNSPECIFIED": 0,
		"COST":                 1,
		"SECURITY":             2,
		"PERFORMANCE":          3,
		"MANAGEABILITY":        4,
		"SUSTAINABILITY":       5,
		"RELIABILITY":          6,
	}
)

Enum value maps for Impact_Category.

RecommendationStateInfo_State_name, RecommendationStateInfo_State_value

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.

File_google_cloud_recommender_v1_insight_proto

var File_google_cloud_recommender_v1_insight_proto protoreflect.FileDescriptor

File_google_cloud_recommender_v1_insight_type_config_proto

var File_google_cloud_recommender_v1_insight_type_config_proto protoreflect.FileDescriptor

File_google_cloud_recommender_v1_recommendation_proto

var File_google_cloud_recommender_v1_recommendation_proto protoreflect.FileDescriptor

File_google_cloud_recommender_v1_recommender_config_proto

var File_google_cloud_recommender_v1_recommender_config_proto protoreflect.FileDescriptor

File_google_cloud_recommender_v1_recommender_service_proto

var File_google_cloud_recommender_v1_recommender_service_proto protoreflect.FileDescriptor

Functions

func RegisterRecommenderServer

func RegisterRecommenderServer(s *grpc.Server, srv RecommenderServer)

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

func (*CostProjection) Descriptor

func (*CostProjection) Descriptor() ([]byte, []int)

Deprecated: Use CostProjection.ProtoReflect.Descriptor instead.

func (*CostProjection) GetCost

func (x *CostProjection) GetCost() *money.Money

func (*CostProjection) GetCostInLocalCurrency

func (x *CostProjection) GetCostInLocalCurrency() *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

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

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

GetInsightTypeConfigRequest

type GetInsightTypeConfigRequest struct {

	// 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`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the GetInsightTypeConfig` method.

func (*GetInsightTypeConfigRequest) Descriptor

func (*GetInsightTypeConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetInsightTypeConfigRequest.ProtoReflect.Descriptor instead.

func (*GetInsightTypeConfigRequest) GetName

func (x *GetInsightTypeConfigRequest) GetName() string

func (*GetInsightTypeConfigRequest) ProtoMessage

func (*GetInsightTypeConfigRequest) ProtoMessage()

func (*GetInsightTypeConfigRequest) ProtoReflect

func (*GetInsightTypeConfigRequest) Reset

func (x *GetInsightTypeConfigRequest) Reset()

func (*GetInsightTypeConfigRequest) String

func (x *GetInsightTypeConfigRequest) String() string

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

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

GetRecommenderConfigRequest

type GetRecommenderConfigRequest struct {

	// 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`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for the GetRecommenderConfig` method.

func (*GetRecommenderConfigRequest) Descriptor

func (*GetRecommenderConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRecommenderConfigRequest.ProtoReflect.Descriptor instead.

func (*GetRecommenderConfigRequest) GetName

func (x *GetRecommenderConfigRequest) GetName() string

func (*GetRecommenderConfigRequest) ProtoMessage

func (*GetRecommenderConfigRequest) ProtoMessage()

func (*GetRecommenderConfigRequest) ProtoReflect

func (*GetRecommenderConfigRequest) Reset

func (x *GetRecommenderConfigRequest) Reset()

func (*GetRecommenderConfigRequest) String

func (x *GetRecommenderConfigRequest) String() string

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
	//	*Impact_SecurityProjection
	//	*Impact_SustainabilityProjection
	//	*Impact_ReliabilityProjection
	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

func (*Impact) Descriptor() ([]byte, []int)

Deprecated: Use Impact.ProtoReflect.Descriptor instead.

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) GetReliabilityProjection

func (x *Impact) GetReliabilityProjection() *ReliabilityProjection

func (*Impact) GetSecurityProjection

func (x *Impact) GetSecurityProjection() *SecurityProjection

func (*Impact) GetSustainabilityProjection

func (x *Impact) GetSustainabilityProjection() *SustainabilityProjection

func (*Impact) ProtoMessage

func (*Impact) ProtoMessage()

func (*Impact) ProtoReflect

func (x *Impact) ProtoReflect() protoreflect.Message

func (*Impact) Reset

func (x *Impact) Reset()

func (*Impact) String

func (x *Impact) String() string

Impact_Category

type Impact_Category int32

The category of the impact.

Impact_CATEGORY_UNSPECIFIED, Impact_COST, Impact_SECURITY, Impact_PERFORMANCE, Impact_MANAGEABILITY, Impact_SUSTAINABILITY, Impact_RELIABILITY

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
	// Indicates a potential increase or decrease in sustainability.
	Impact_SUSTAINABILITY Impact_Category = 5
	// Indicates a potential increase or decrease in reliability.
	Impact_RELIABILITY Impact_Category = 6
)

func (Impact_Category) Descriptor

func (Impact_Category) Enum

func (x Impact_Category) Enum() *Impact_Category

func (Impact_Category) EnumDescriptor

func (Impact_Category) EnumDescriptor() ([]byte, []int)

Deprecated: Use Impact_Category.Descriptor instead.

func (Impact_Category) Number

func (Impact_Category) String

func (x Impact_Category) String() string

func (Impact_Category) Type

Impact_CostProjection

type Impact_CostProjection struct {
	// Use with CategoryType.COST
	CostProjection *CostProjection `protobuf:"bytes,100,opt,name=cost_projection,json=costProjection,proto3,oneof"`
}

Impact_ReliabilityProjection

type Impact_ReliabilityProjection struct {
	// Use with CategoryType.RELIABILITY
	ReliabilityProjection *ReliabilityProjection `protobuf:"bytes,103,opt,name=reliability_projection,json=reliabilityProjection,proto3,oneof"`
}

Impact_SecurityProjection

type Impact_SecurityProjection struct {
	// Use with CategoryType.SECURITY
	SecurityProjection *SecurityProjection `protobuf:"bytes,101,opt,name=security_projection,json=securityProjection,proto3,oneof"`
}

Impact_SustainabilityProjection

type Impact_SustainabilityProjection struct {
	// Use with CategoryType.SUSTAINABILITY
	SustainabilityProjection *SustainabilityProjection `protobuf:"bytes,102,opt,name=sustainability_projection,json=sustainabilityProjection,proto3,oneof"`
}

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"`
	// Insight's severity.
	Severity Insight_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.
	Etag string `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.

func (*Insight) Descriptor

func (*Insight) Descriptor() ([]byte, []int)

Deprecated: Use Insight.ProtoReflect.Descriptor instead.

func (*Insight) GetAssociatedRecommendations

func (x *Insight) GetAssociatedRecommendations() []*Insight_RecommendationReference

func (*Insight) GetCategory

func (x *Insight) GetCategory() Insight_Category

func (*Insight) GetContent

func (x *Insight) GetContent() *structpb.Struct

func (*Insight) GetDescription

func (x *Insight) GetDescription() string

func (*Insight) GetEtag

func (x *Insight) GetEtag() string

func (*Insight) GetInsightSubtype

func (x *Insight) GetInsightSubtype() string

func (*Insight) GetLastRefreshTime

func (x *Insight) GetLastRefreshTime() *timestamppb.Timestamp

func (*Insight) GetName

func (x *Insight) GetName() string

func (*Insight) GetObservationPeriod

func (x *Insight) GetObservationPeriod() *durationpb.Duration

func (*Insight) GetSeverity

func (x *Insight) GetSeverity() Insight_Severity

func (*Insight) GetStateInfo

func (x *Insight) GetStateInfo() *InsightStateInfo

func (*Insight) GetTargetResources

func (x *Insight) GetTargetResources() []string

func (*Insight) ProtoMessage

func (*Insight) ProtoMessage()

func (*Insight) ProtoReflect

func (x *Insight) ProtoReflect()