As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Recommender v1beta1 API

class google.cloud.recommender_v1beta1.types.CostProjection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

cost

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.

Type

google.type.money_pb2.Money

duration

Duration for which this cost applies.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.recommender_v1beta1.types.GetInsightRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to the GetInsight method.

name

Required. Name of the insight.

Type

str

class google.cloud.recommender_v1beta1.types.GetInsightTypeConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the GetInsightTypeConfig` method.

name

Required. Name of the InsightTypeConfig to get.

Acceptable formats:

• projects/[PROJECT_NUMBER]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config

• projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config

• organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config

Type

str

class google.cloud.recommender_v1beta1.types.GetRecommendationRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to the GetRecommendation method.

name

Required. Name of the recommendation.

Type

str

class google.cloud.recommender_v1beta1.types.GetRecommenderConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the GetRecommenderConfig` method.

name

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

Type

str

class google.cloud.recommender_v1beta1.types.Impact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

category

Category that is being targeted.

Type

google.cloud.recommender_v1beta1.types.Impact.Category

cost_projection

Use with CategoryType.COST

This field is a member of oneof projection.

Type

google.cloud.recommender_v1beta1.types.CostProjection

security_projection

Use with CategoryType.SECURITY

This field is a member of oneof projection.

Type

google.cloud.recommender_v1beta1.types.SecurityProjection

sustainability_projection

Use with CategoryType.SUSTAINABILITY

This field is a member of oneof projection.

Type

google.cloud.recommender_v1beta1.types.SustainabilityProjection

class Category(value)

Bases: proto.enums.Enum

The category of the impact.

Values:

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.

MANAGEABILITY (4):

Indicates a potential increase or decrease in manageability.

SUSTAINABILITY (5):

Indicates a potential increase or decrease in sustainability.

class google.cloud.recommender_v1beta1.types.Insight(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Name of the insight.

Type

str

description

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

Type

str

target_resources

Fully qualified resource names that this insight is targeting.

Type

MutableSequence[str]

insight_subtype

Insight subtype. Insight content schema will be stable for a given subtype.

Type

str

content

A struct of custom fields to explain the insight. Example: “grantedPermissionsCount”: “1000”.

Type

google.protobuf.struct_pb2.Struct

last_refresh_time

Timestamp of the latest data used to generate the insight.

Type

google.protobuf.timestamp_pb2.Timestamp

observation_period

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

Type

google.protobuf.duration_pb2.Duration

state_info

Information state and metadata.

Type

google.cloud.recommender_v1beta1.types.InsightStateInfo

category

Category being targeted by the insight.

Type

google.cloud.recommender_v1beta1.types.Insight.Category

severity

Insight’s severity.

Type

google.cloud.recommender_v1beta1.types.Insight.Severity

etag

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

Type

str

associated_recommendations

Recommendations derived from this insight.

Type

MutableSequence[google.cloud.recommender_v1beta1.types.Insight.RecommendationReference]

class Category(value)

Bases: proto.enums.Enum

Insight category.

Values:

CATEGORY_UNSPECIFIED (0):

Unspecified category.

COST (1):

The insight is related to cost.

SECURITY (2):

The insight is related to security.

PERFORMANCE (3):

The insight is related to performance.

MANAGEABILITY (4):

This insight is related to manageability.

class RecommendationReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Reference to an associated recommendation.

recommendation

Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID]

Type

str

class Severity(value)

Bases: proto.enums.Enum

Insight severity levels.

Values:

SEVERITY_UNSPECIFIED (0):

Insight has unspecified severity.

LOW (1):

Insight has low severity.

MEDIUM (2):

Insight has medium severity.

HIGH (3):

Insight has high severity.

CRITICAL (4):

Insight has critical severity.

class google.cloud.recommender_v1beta1.types.InsightStateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information related to insight state.

state

Insight state.

Type

google.cloud.recommender_v1beta1.types.InsightStateInfo.State

state_metadata

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

Type

MutableMapping[str, str]

class State(value)

Bases: proto.enums.Enum

Represents insight state.

Values:

STATE_UNSPECIFIED (0):

Unspecified state.

ACTIVE (1):

Insight is active. Content for ACTIVE insights can be updated by Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED.

ACCEPTED (2):

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

DISMISSED (3):

Insight is dismissed. Content for DISMISSED insights can be updated by Google. DISMISSED insights can be marked as ACTIVE.

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.InsightType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The type of insight.

name

The insight_type’s name in format insightTypes/{insight_type} eg: insightTypes/google.iam.policy.Insight

Type

str

class google.cloud.recommender_v1beta1.types.InsightTypeConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for an InsightType.

name

Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

Type

str

insight_type_generation_config

InsightTypeGenerationConfig which configures the generation of insights for this insight type.

Type

google.cloud.recommender_v1beta1.types.InsightTypeGenerationConfig

etag

Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating.

Type

str

update_time

Last time when the config was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

revision_id

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

Type

str

annotations

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Type

MutableMapping[str, str]

display_name

A user-settable field to provide a human-readable name to be used in user interfaces.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.InsightTypeGenerationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

params

Parameters for this InsightTypeGenerationConfig. These configs can be used by or are applied to all subtypes.

Type

google.protobuf.struct_pb2.Struct

class google.cloud.recommender_v1beta1.types.ListInsightTypesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListInsightTypes method.

page_size

The number of InsightTypes to return per page. The service may return fewer than this value.

Type

int

page_token

A page token, received from a previous ListRecommenders call. Provide this to retrieve the subsequent page.

Type

str

class google.cloud.recommender_v1beta1.types.ListInsightTypesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the ListInsightTypes method.

insight_types

The set of recommenders available

Type

MutableSequence[google.cloud.recommender_v1beta1.types.InsightType]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.cloud.recommender_v1beta1.types.ListInsightsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListInsights method.

parent

Required. The container resource on which to execute the request. Acceptable formats:

• projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]

• projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]

• billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]

• folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]

• organizations/[ORGANIZATION_ID]/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

page_size

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.

Type

int

page_token

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.

Type

str

filter

Optional. Filter expression to restrict the insights returned. Supported filter fields:

• stateInfo.state

• insightSubtype

• severity

Examples:

• stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED

• insightSubtype = PERMISSIONS_USAGE

• severity = CRITICAL OR severity = HIGH

• stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)

(These expressions are based on the filter language described at https://google.aip.dev/160)

Type

str

class google.cloud.recommender_v1beta1.types.ListInsightsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the ListInsights method.

insights

The set of insights for the parent resource.

Type

MutableSequence[google.cloud.recommender_v1beta1.types.Insight]

next_page_token

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

Type

str

class google.cloud.recommender_v1beta1.types.ListRecommendationsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListRecommendations method.

parent

Required. The container resource on which to execute the request. Acceptable formats:

• projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]

• projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]

• billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]

• folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]

• organizations/[ORGANIZATION_ID]/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

page_size

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.

Type

int

page_token

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.

Type

str

filter

Filter expression to restrict the recommendations returned. Supported filter fields:

• state_info.state

• recommenderSubtype

• priority

Examples:

• stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED

• recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE

• priority = P1 OR priority = P2

• stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)

(These expressions are based on the filter language described at https://google.aip.dev/160)

Type

str

class google.cloud.recommender_v1beta1.types.ListRecommendationsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response to the ListRecommendations method.

recommendations

The set of recommendations for the parent resource.

Type

MutableSequence[google.cloud.recommender_v1beta1.types.Recommendation]

next_page_token

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

Type

str

class google.cloud.recommender_v1beta1.types.ListRecommendersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListRecommender method.

page_size

The number of RecommenderTypes to return per page. The service may return fewer than this value.

Type

int

page_token

A page token, received from a previous ListRecommenders call. Provide this to retrieve the subsequent page.

Type

str

class google.cloud.recommender_v1beta1.types.ListRecommendersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the ListRecommender method.

recommenders

The set of recommenders available

Type

MutableSequence[google.cloud.recommender_v1beta1.types.RecommenderType]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.cloud.recommender_v1beta1.types.MarkInsightAcceptedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the MarkInsightAccepted method.

name

Required. Name of the insight.

Type

str

state_metadata

Optional. State properties user wish to include with this state. Full replace of the current state_metadata.

Type

MutableMapping[str, str]

etag

Required. Fingerprint of the Insight. Provides optimistic locking.

Type

str

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.MarkRecommendationClaimedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the MarkRecommendationClaimed Method.

name

Required. Name of the recommendation.

Type

str

state_metadata

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

Type

MutableMapping[str, str]

etag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Type

str

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.MarkRecommendationFailedRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the MarkRecommendationFailed Method.

name

Required. Name of the recommendation.

Type

str

state_metadata

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

Type

MutableMapping[str, str]

etag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Type

str

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.MarkRecommendationSucceededRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the MarkRecommendationSucceeded Method.

name

Required. Name of the recommendation.

Type

str

state_metadata

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

Type

MutableMapping[str, str]

etag

Required. Fingerprint of the Recommendation. Provides optimistic locking.

Type

str

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.Operation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

action

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

Type

str

resource_type

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

Type

str

resource

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

Type

str

path

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.

Type

str

source_resource

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 = and resource_name = . This field is empty for all other values of action.

Type

str

source_path

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.

Type

str

value

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.

This field is a member of oneof path_value.

Type

google.protobuf.struct_pb2.Value

value_matcher

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.

This field is a member of oneof path_value.

Type

google.cloud.recommender_v1beta1.types.ValueMatcher

path_filters

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.

Type

MutableMapping[str, google.protobuf.struct_pb2.Value]

path_value_matchers

Similar to path_filters, this contains set of filters to apply if path field refers 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.

Type

MutableMapping[str, google.cloud.recommender_v1beta1.types.ValueMatcher]

class PathFiltersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class PathValueMatchersEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.OperationGroup(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Group of operations that need to be performed atomically.

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

MutableSequence[google.cloud.recommender_v1beta1.types.Operation]

class google.cloud.recommender_v1beta1.types.Recommendation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

name

Name of recommendation.

Type

str

description

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

Type

str

recommender_subtype

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

Type

str

last_refresh_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

primary_impact

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

Type

google.cloud.recommender_v1beta1.types.Impact

additional_impact

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

Type

MutableSequence[google.cloud.recommender_v1beta1.types.Impact]

priority

Recommendation’s priority.

Type

google.cloud.recommender_v1beta1.types.Recommendation.Priority

content

Content of the recommendation describing recommended changes to resources.

Type

google.cloud.recommender_v1beta1.types.RecommendationContent

state_info

Information for state. Contains state and metadata.

Type

google.cloud.recommender_v1beta1.types.RecommendationStateInfo

etag

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

Type

str

associated_insights

Insights that led to this recommendation.

Type

MutableSequence[google.cloud.recommender_v1beta1.types.Recommendation.InsightReference]

xor_group_id

Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied.

Type

str

class InsightReference(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Reference to an associated insight.

insight

Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID]

Type

str

class Priority(value)

Bases: proto.enums.Enum

Recommendation priority levels.

Values:

PRIORITY_UNSPECIFIED (0):

Recommendation has unspecified priority.

P4 (1):

Recommendation has P4 priority (lowest priority).

P3 (2):

Recommendation has P3 priority (second lowest priority).

P2 (3):

Recommendation has P2 priority (second highest priority).

P1 (4):

Recommendation has P1 priority (highest priority).

class google.cloud.recommender_v1beta1.types.RecommendationContent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains what resources are changing and how they are changing.

operation_groups

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.

Type

MutableSequence[google.cloud.recommender_v1beta1.types.OperationGroup]

overview

Condensed overview information about the recommendation.

Type

google.protobuf.struct_pb2.Struct

class google.cloud.recommender_v1beta1.types.RecommendationStateInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information for state. Contains state and metadata.

state

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

Type

google.cloud.recommender_v1beta1.types.RecommendationStateInfo.State

state_metadata

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

Type

MutableMapping[str, str]

class State(value)

Bases: proto.enums.Enum

Represents Recommendation State.

Values:

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.

class StateMetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.RecommenderConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Recommender.

name

Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

Type

str

recommender_generation_config

RecommenderGenerationConfig which configures the Generation of recommendations for this recommender.

Type

google.cloud.recommender_v1beta1.types.RecommenderGenerationConfig

etag

Fingerprint of the RecommenderConfig. Provides optimistic locking when updating.

Type

str

update_time

Last time when the config was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

revision_id

Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string.

Type

str

annotations

Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.

Type

MutableMapping[str, str]

display_name

A user-settable field to provide a human-readable name to be used in user interfaces.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.recommender_v1beta1.types.RecommenderGenerationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

params

Parameters for this RecommenderGenerationConfig. These configs can be used by or are applied to all subtypes.

Type

google.protobuf.struct_pb2.Struct

class google.cloud.recommender_v1beta1.types.RecommenderType(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The type of a recommender.

name

The recommender’s name in format RecommenderTypes/{recommender_type} eg: recommenderTypes/google.iam.policy.Recommender

Type

str

class google.cloud.recommender_v1beta1.types.SecurityProjection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Contains various ways of describing the impact on Security.

details

This field can be used by the recommender to define details specific to security impact.

Type

google.protobuf.struct_pb2.Struct

class google.cloud.recommender_v1beta1.types.SustainabilityProjection(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

kg_c_o2e

Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e so that the name renders correctly in camelCase (kgCO2e).

Type

float

duration

Duration for which this sustanability applies.

Type

google.protobuf.duration_pb2.Duration

class google.cloud.recommender_v1beta1.types.UpdateInsightTypeConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the UpdateInsightTypeConfig method.

insight_type_config

Required. The InsightTypeConfig to update.

Type

google.cloud.recommender_v1beta1.types.InsightTypeConfig

update_mask

The list of fields to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

validate_only

If true, validate the request and preview the change, but do not actually update it.

Type

bool

class google.cloud.recommender_v1beta1.types.UpdateRecommenderConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the UpdateRecommenderConfig method.

recommender_config

Required. The RecommenderConfig to update.

Type

google.cloud.recommender_v1beta1.types.RecommenderConfig

update_mask

The list of fields to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask

validate_only

If true, validate the request and preview the change, but do not actually update it.

Type

bool

class google.cloud.recommender_v1beta1.types.ValueMatcher(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

matches_pattern

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

This field is a member of oneof match_variant.

Type

str