Package Classes (2.16.1)

Summary of entries of Classes for recommender.

Classes

RecommenderAsyncClient

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

RecommenderClient

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

ListInsightsAsyncPager

A pager for iterating through list_insights requests.

This class thinly wraps an initial ListInsightsResponse object, and provides an __aiter__ method to iterate through its insights field.

If there are more pages, the __aiter__ method will make additional ListInsights requests and continue to iterate through the insights field on the corresponding responses.

All the usual ListInsightsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInsightsPager

A pager for iterating through list_insights requests.

This class thinly wraps an initial ListInsightsResponse object, and provides an __iter__ method to iterate through its insights field.

If there are more pages, the __iter__ method will make additional ListInsights requests and continue to iterate through the insights field on the corresponding responses.

All the usual ListInsightsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendationsAsyncPager

A pager for iterating through list_recommendations requests.

This class thinly wraps an initial ListRecommendationsResponse object, and provides an __aiter__ method to iterate through its recommendations field.

If there are more pages, the __aiter__ method will make additional ListRecommendations requests and continue to iterate through the recommendations field on the corresponding responses.

All the usual ListRecommendationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendationsPager

A pager for iterating through list_recommendations requests.

This class thinly wraps an initial ListRecommendationsResponse object, and provides an __iter__ method to iterate through its recommendations field.

If there are more pages, the __iter__ method will make additional ListRecommendations requests and continue to iterate through the recommendations field on the corresponding responses.

All the usual ListRecommendationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CostProjection

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

GetInsightRequest

Request to the GetInsight method.

GetInsightTypeConfigRequest

Request for the GetInsightTypeConfig` method.

GetRecommendationRequest

Request to the GetRecommendation method.

GetRecommenderConfigRequest

Request for the GetRecommenderConfig` method.

Impact

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Category

The category of the impact.

Insight

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

Category

Insight category.

RecommendationReference

Reference to an associated recommendation.

Severity

Insight severity levels.

InsightStateInfo

Information related to insight state.

State

Represents insight state.

StateMetadataEntry

The abstract base class for a message.

InsightTypeConfig

Configuration for an InsightType.

AnnotationsEntry

The abstract base class for a message.

InsightTypeGenerationConfig

A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight.

ListInsightsRequest

Request for the ListInsights method.

ListInsightsResponse

Response to the ListInsights method.

ListRecommendationsRequest

Request for the ListRecommendations method.

ListRecommendationsResponse

Response to the ListRecommendations method.

MarkInsightAcceptedRequest

Request for the MarkInsightAccepted method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationClaimedRequest

Request for the MarkRecommendationClaimed Method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationDismissedRequest

Request for the MarkRecommendationDismissed Method.

MarkRecommendationFailedRequest

Request for the MarkRecommendationFailed Method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationSucceededRequest

Request for the MarkRecommendationSucceeded Method.

StateMetadataEntry

The abstract base class for a message.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PathFiltersEntry

The abstract base class for a message.

PathValueMatchersEntry

The abstract base class for a message.

OperationGroup

Group of operations that need to be performed atomically.

Recommendation

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

InsightReference

Reference to an associated insight.

Priority

Recommendation priority levels.

RecommendationContent

Contains what resources are changing and how they are changing.

RecommendationStateInfo

Information for state. Contains state and metadata.

State

Represents Recommendation State.

    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.

StateMetadataEntry

The abstract base class for a message.

RecommenderConfig

Configuration for a Recommender.

AnnotationsEntry

The abstract base class for a message.

RecommenderGenerationConfig

A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.

ReliabilityProjection

Contains information on the impact of a reliability recommendation.

RiskType

The risk associated with the reliability issue.

SecurityProjection

Contains various ways of describing the impact on Security.

SustainabilityProjection

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

UpdateInsightTypeConfigRequest

Request for the UpdateInsightTypeConfig method.

UpdateRecommenderConfigRequest

Request for the UpdateRecommenderConfig method.

ValueMatcher

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RecommenderAsyncClient

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

RecommenderClient

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

ListInsightTypesAsyncPager

A pager for iterating through list_insight_types requests.

This class thinly wraps an initial ListInsightTypesResponse object, and provides an __aiter__ method to iterate through its insight_types field.

If there are more pages, the __aiter__ method will make additional ListInsightTypes requests and continue to iterate through the insight_types field on the corresponding responses.

All the usual ListInsightTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInsightTypesPager

A pager for iterating through list_insight_types requests.

This class thinly wraps an initial ListInsightTypesResponse object, and provides an __iter__ method to iterate through its insight_types field.

If there are more pages, the __iter__ method will make additional ListInsightTypes requests and continue to iterate through the insight_types field on the corresponding responses.

All the usual ListInsightTypesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInsightsAsyncPager

A pager for iterating through list_insights requests.

This class thinly wraps an initial ListInsightsResponse object, and provides an __aiter__ method to iterate through its insights field.

If there are more pages, the __aiter__ method will make additional ListInsights requests and continue to iterate through the insights field on the corresponding responses.

All the usual ListInsightsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListInsightsPager

A pager for iterating through list_insights requests.

This class thinly wraps an initial ListInsightsResponse object, and provides an __iter__ method to iterate through its insights field.

If there are more pages, the __iter__ method will make additional ListInsights requests and continue to iterate through the insights field on the corresponding responses.

All the usual ListInsightsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendationsAsyncPager

A pager for iterating through list_recommendations requests.

This class thinly wraps an initial ListRecommendationsResponse object, and provides an __aiter__ method to iterate through its recommendations field.

If there are more pages, the __aiter__ method will make additional ListRecommendations requests and continue to iterate through the recommendations field on the corresponding responses.

All the usual ListRecommendationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendationsPager

A pager for iterating through list_recommendations requests.

This class thinly wraps an initial ListRecommendationsResponse object, and provides an __iter__ method to iterate through its recommendations field.

If there are more pages, the __iter__ method will make additional ListRecommendations requests and continue to iterate through the recommendations field on the corresponding responses.

All the usual ListRecommendationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendersAsyncPager

A pager for iterating through list_recommenders requests.

This class thinly wraps an initial ListRecommendersResponse object, and provides an __aiter__ method to iterate through its recommenders field.

If there are more pages, the __aiter__ method will make additional ListRecommenders requests and continue to iterate through the recommenders field on the corresponding responses.

All the usual ListRecommendersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRecommendersPager

A pager for iterating through list_recommenders requests.

This class thinly wraps an initial ListRecommendersResponse object, and provides an __iter__ method to iterate through its recommenders field.

If there are more pages, the __iter__ method will make additional ListRecommenders requests and continue to iterate through the recommenders field on the corresponding responses.

All the usual ListRecommendersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

CostProjection

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

GetInsightRequest

Request to the GetInsight method.

GetInsightTypeConfigRequest

Request for the GetInsightTypeConfig` method.

GetRecommendationRequest

Request to the GetRecommendation method.

GetRecommenderConfigRequest

Request for the GetRecommenderConfig` method.

Impact

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Category

The category of the impact.

Insight

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

Category

Insight category.

RecommendationReference

Reference to an associated recommendation.

Severity

Insight severity levels.

InsightStateInfo

Information related to insight state.

State

Represents insight state.

StateMetadataEntry

The abstract base class for a message.

InsightType

The type of insight.

InsightTypeConfig

Configuration for an InsightType.

AnnotationsEntry

The abstract base class for a message.

InsightTypeGenerationConfig

A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight.

ListInsightTypesRequest

Request for the ListInsightTypes method.

ListInsightTypesResponse

Response for the ListInsightTypes method.

ListInsightsRequest

Request for the ListInsights method.

ListInsightsResponse

Response to the ListInsights method.

ListRecommendationsRequest

Request for the ListRecommendations method.

ListRecommendationsResponse

Response to the ListRecommendations method.

ListRecommendersRequest

Request for the ListRecommender method.

ListRecommendersResponse

Response for the ListRecommender method.

MarkInsightAcceptedRequest

Request for the MarkInsightAccepted method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationClaimedRequest

Request for the MarkRecommendationClaimed Method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationFailedRequest

Request for the MarkRecommendationFailed Method.

StateMetadataEntry

The abstract base class for a message.

MarkRecommendationSucceededRequest

Request for the MarkRecommendationSucceeded Method.

StateMetadataEntry

The abstract base class for a message.

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.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

PathFiltersEntry

The abstract base class for a message.

PathValueMatchersEntry

The abstract base class for a message.

OperationGroup

Group of operations that need to be performed atomically.

Recommendation

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

InsightReference

Reference to an associated insight.

Priority

Recommendation priority levels.

RecommendationContent

Contains what resources are changing and how they are changing.

RecommendationStateInfo

Information for state. Contains state and metadata.

State

Represents Recommendation State.

    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.

StateMetadataEntry

The abstract base class for a message.

RecommenderConfig

Configuration for a Recommender.

AnnotationsEntry

The abstract base class for a message.

RecommenderGenerationConfig

A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.

RecommenderType

The type of a recommender.

SecurityProjection

Contains various ways of describing the impact on Security.

SustainabilityProjection

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

UpdateInsightTypeConfigRequest

Request for the UpdateInsightTypeConfig method.

UpdateRecommenderConfigRequest

Request for the UpdateRecommenderConfig method.

ValueMatcher

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Modules

pagers

API documentation for recommender_v1.services.recommender.pagers module.

pagers

API documentation for recommender_v1beta1.services.recommender.pagers module.