Package types (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.

API documentation for recommender_v1beta1.types package.

Classes

CostProjection

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

GetInsightRequest

Request to the GetInsight method. .. attribute:: name

Required. Name of the insight.

:type: str

GetRecommendationRequest

Request to the GetRecommendation method. .. attribute:: name

Required. Name of the recommendation.

:type: str

Impact

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

Insight

An insight along with the information used to derive the insight. The insight may have associated recomendations as well.

InsightStateInfo

Information related to insight state. .. attribute:: state

Insight state.

:type: google.cloud.recommender_v1beta1.types.InsightStateInfo.State

ListInsightsRequest

Request for the ListInsights method. .. attribute:: parent

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.

:type: str

ListInsightsResponse

Response to the ListInsights method. .. attribute:: insights

The set of insights for the parent resource.

:type: Sequence[google.cloud.recommender_v1beta1.types.Insight]

ListRecommendationsRequest

Request for the ListRecommendations method. .. attribute:: parent

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.

:type: str

ListRecommendationsResponse

Response to the ListRecommendations method. .. attribute:: recommendations

The set of recommendations for the parent resource.

:type: Sequence[google.cloud.recommender_v1beta1.types.Recommendation]

MarkInsightAcceptedRequest

Request for the MarkInsightAccepted method. .. attribute:: name

Required. Name of the insight.

:type: str

MarkRecommendationClaimedRequest

Request for the MarkRecommendationClaimed Method. .. attribute:: name

Required. Name of the recommendation.

:type: str

MarkRecommendationFailedRequest

Request for the MarkRecommendationFailed Method. .. attribute:: name

Required. Name of the recommendation.

:type: str

MarkRecommendationSucceededRequest

Request for the MarkRecommendationSucceeded Method. .. attribute:: name

Required. Name of the recommendation.

:type: str

Operation

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.

OperationGroup

Group of operations that need to be performed atomically. .. attribute:: operations

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.

:type: Sequence[google.cloud.recommender_v1beta1.types.Operation]

Recommendation

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

RecommendationContent

Contains what resources are changing and how they are changing.

RecommendationStateInfo

Information for state. Contains state and metadata. .. attribute:: state

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

:type: google.cloud.recommender_v1beta1.types.RecommendationStateInfo.State

ValueMatcher

Contains various matching options for values for a GCP resource field.