package google.cloud.recommender.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Provides recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. These recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.

• rpc ListRecommendations (ListRecommendationsRequest, ListRecommendationsResponse)

  recommender_service.proto:42

  Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.

  message ListRecommendationsRequest

  recommender_service.proto:109

  Request for the `ListRecommendations` method.

  • string parent = 1

    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/

  • int32 page_size = 2

    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.

  • string page_token = 3

    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.

  • string filter = 5

    Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"

  message ListRecommendationsResponse

  recommender_service.proto:138

  Response to the `ListRecommendations` method.

  • repeated Recommendation recommendations = 1

    The set of recommendations for the `parent` resource.

  • string next_page_token = 2

    A token that can be used to request the next page of results. This field is empty if there are no additional results.

• rpc GetRecommendation (GetRecommendationRequest, Recommendation)

  recommender_service.proto:50

  Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

  message GetRecommendationRequest

  recommender_service.proto:148

  Request to the `GetRecommendation` method.

  • string name = 1

    Name of the recommendation.

• rpc MarkRecommendationClaimed (MarkRecommendationClaimedRequest, Recommendation)

  recommender_service.proto:66

  Mark 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. MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

  message MarkRecommendationClaimedRequest

  recommender_service.proto:154

  Request for the `MarkRecommendationClaimed` Method.

  • string name = 1

    Name of the recommendation.

  • map<string, string> state_metadata = 2

    State properties to include with this state. Overwrites any existing `state_metadata`.

  • string etag = 3

    Fingerprint of the Recommendation. Provides optimistic locking.

• rpc MarkRecommendationSucceeded (MarkRecommendationSucceededRequest, Recommendation)

  recommender_service.proto:83

  Mark 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. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

  message MarkRecommendationSucceededRequest

  recommender_service.proto:167

  Request for the `MarkRecommendationSucceeded` Method.

  • string name = 1

    Name of the recommendation.

  • map<string, string> state_metadata = 2

    State properties to include with this state. Overwrites any existing `state_metadata`.

  • string etag = 3

    Fingerprint of the Recommendation. Provides optimistic locking.

• rpc MarkRecommendationFailed (MarkRecommendationFailedRequest, Recommendation)

  recommender_service.proto:100

  Mark 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. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

  message MarkRecommendationFailedRequest

  recommender_service.proto:180

  Request for the `MarkRecommendationFailed` Method.

  • string name = 1

    Name of the recommendation.

  • map<string, string> state_metadata = 2

    State properties to include with this state. Overwrites any existing `state_metadata`.

  • string etag = 3

    Fingerprint of the Recommendation. Provides optimistic locking.

Contains metadata about how much money a recommendation can save or incur.

Used in: Impact

• optional type.Money cost = 1

  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.

• optional protobuf.Duration duration = 2

  Duration for which this cost applies.

Contains the impact a recommendation can have for a given category.

Used in: Recommendation

• Impact.Category category = 1

  Category that is being targeted.

• oneof projection

  Contains projections (if any) for this category.

  • CostProjection cost_projection = 100

    Use with CategoryType.COST

The category of the impact.

Used in: Impact

• CATEGORY_UNSPECIFIED = 0

  Default unspecified category. Don't use directly.

• COST = 1

  Indicates a potential increase or decrease in cost.

• SECURITY = 2

  Indicates a potential increase or decrease in security.

• PERFORMANCE = 3

  Indicates a potential increase or decrease in performance.

Contains an operation for a resource inspired by 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.

Used in: OperationGroup

• string action = 1

  Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', 'copy', 'test' and custom operations. This field is case-insensitive and always populated.

• string resource_type = 2

  Type of GCP resource being modified/tested. This field is always populated. Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/Instance

• string resource = 3

  Contains the fully qualified resource name. This field is always populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.

• string path = 4

  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.

• string source_resource = 5

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

• string source_path = 6

  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.

• optional protobuf.Value value = 7

  Value for the `path` field. Set if action is 'add'/'replace'/'test'.

• map<string, protobuf.Value> path_filters = 8

  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. Note that this is intended to be an exact match per filter. Example: { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 } Example: { "/bindings/*/role": "roles/admin" "/bindings/*/condition" : null } Example: { "/bindings/*/role": "roles/admin" "/bindings/*/members/*" : ["x@google.com", "y@google.com"] }

Group of operations that need to be performed atomically.

Used in: RecommendationContent

• repeated Operation operations = 1

  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.

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

Used as response type in: Recommender.GetRecommendation, Recommender.MarkRecommendationClaimed, Recommender.MarkRecommendationFailed, Recommender.MarkRecommendationSucceeded

Used as field type in: ListRecommendationsResponse

• string name = 1

  Name of recommendation. A project recommendation is represented as projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]

• string description = 2

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

• string recommender_subtype = 12

  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 will be added when either content or primary impact category changes. Examples: For recommender = "google.iam.policy.RoleRecommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE"

• optional protobuf.Timestamp last_refresh_time = 4

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

• optional Impact primary_impact = 5

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

• repeated Impact additional_impact = 6

  Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative.

• optional RecommendationContent content = 7

  Content of the recommendation describing recommended changes to resources.

• optional RecommendationStateInfo state_info = 10

  Information for state. Contains state and metadata.

• string etag = 11

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

Contains what resources are changing and how they are changing.

Used in: Recommendation

• repeated OperationGroup operation_groups = 2

  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.

Information for state. Contains state and metadata.

Used in: Recommendation

• RecommendationStateInfo.State state = 1

  The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.

• map<string, string> state_metadata = 2

  A map of metadata for the state, provided by user or automations systems.

Represents Recommendation State

Used in: RecommendationStateInfo

• STATE_UNSPECIFIED = 0

  Default state. Don't use directly.

• ACTIVE = 1

  Recommendation is active and can be applied. Recommendations content can be updated by Google. ACTIVE recommendations can be marked as CLAIMED, SUCCEEDED, or FAILED.

• CLAIMED = 6

  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.

• SUCCEEDED = 3

  Recommendation is in succeeded state. Recommendations content is immutable and cannot be updated by Google. SUCCEEDED recommendations can be marked as SUCCEEDED, or FAILED.

• FAILED = 4

  Recommendation is in failed state. Recommendations content is immutable and cannot be updated by Google. FAILED recommendations can be marked as SUCCEEDED, or FAILED.

• DISMISSED = 5

  Recommendation is in dismissed state. Recommendation content can be updated by Google. DISMISSED recommendations can be marked as ACTIVE.