RecommenderAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-recommender/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
RecommenderTransport | The transport used by the client instance. |
Methods
RecommenderAsyncClient
RecommenderAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-recommender/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the recommender client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
RecommenderAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
RecommenderAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
RecommenderAsyncClient | The constructed client. |
get_insight
get_insight(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.GetInsightRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
| Parameters | |
|---|---|
| Name | Description |
request |
GetInsightRequest
The request object. Request to the |
name |
Required. Name of the insight. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Insight | An insight along with the information used to derive the insight. The insight may have associated recomendations as well. |
get_recommendation
get_recommendation(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.GetRecommendationRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
| Parameters | |
|---|---|
| Name | Description |
request |
GetRecommendationRequest
The request object. Request to the |
name |
Required. Name of the recommendation. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Recommendation | A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc |
get_transport_class
get_transport_class()Returns an appropriate transport class.
insight_path
insight_path(project: str, location: str, insight_type: str, insight: str)Returns a fully-qualified insight string.
insight_type_path
insight_type_path(project: str, location: str, insight_type: str)Returns a fully-qualified insight_type string.
list_insights
list_insights(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the specified insight type.
| Parameters | |
|---|---|
| Name | Description |
request |
ListInsightsRequest
The request object. Request for the |
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. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager | Response to the ListInsights method. Iterating over this object will yield results and resolve additional pages automatically. |
list_recommendations
list_recommendations(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsRequest] = None, *, parent: Optional[str] = None, filter: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists recommendations for a Cloud project. Requires the recommender.*.list IAM permission for the specified recommender.
| Parameters | |
|---|---|
| Name | Description |
request |
ListRecommendationsRequest
The request object. Request for the |
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. This corresponds to the |
filter |
Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: <code>state_info.state:"DISMISSED" or state_info.state:"FAILED" This corresponds to the filter |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager | Response to the ListRecommendations method. Iterating over this object will yield results and resolve additional pages automatically. |
mark_insight_accepted
mark_insight_accepted(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.MarkInsightAcceptedRequest] = None, *, name: Optional[str] = None, state_metadata: Optional[Sequence[google.cloud.recommender_v1beta1.types.recommender_service.MarkInsightAcceptedRequest.StateMetadataEntry]] = None, etag: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated.
MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight.
| Parameters | |
|---|---|
| Name | Description |
request |
MarkInsightAcceptedRequest
The request object. Request for the |
name |
Required. Name of the insight. This corresponds to the |
state_metadata |
:class:
Optional. State properties user wish to include with this state. Full replace of the current state_metadata. This corresponds to the |
etag |
Required. Fingerprint of the Insight. Provides optimistic locking. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Insight | An insight along with the information used to derive the insight. The insight may have associated recomendations as well. |
mark_recommendation_claimed
mark_recommendation_claimed(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationClaimedRequest] = None, *, name: Optional[str] = None, state_metadata: Optional[Sequence[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationClaimedRequest.StateMetadataEntry]] = None, etag: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Marks 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. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
| Parameters | |
|---|---|
| Name | Description |
request |
MarkRecommendationClaimedRequest
The request object. Request for the |
name |
Required. Name of the recommendation. This corresponds to the |
state_metadata |
:class:
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Recommendation | A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc |
mark_recommendation_failed
mark_recommendation_failed(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationFailedRequest] = None, *, name: Optional[str] = None, state_metadata: Optional[Sequence[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationFailedRequest.StateMetadataEntry]] = None, etag: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Marks 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. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
Requires the recommender.*.update IAM permission for the specified recommender.
| Parameters | |
|---|---|
| Name | Description |
request |
MarkRecommendationFailedRequest
The request object. Request for the |
name |
Required. Name of the recommendation. This corresponds to the |
state_metadata |
:class:
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Recommendation | A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc |
mark_recommendation_succeeded
mark_recommendation_succeeded(request: Optional[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationSucceededRequest] = None, *, name: Optional[str] = None, state_metadata: Optional[Sequence[google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationSucceededRequest.StateMetadataEntry]] = None, etag: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Marks 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. Associated insights are frozen and placed in the ACCEPTED state.
MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state.
Requires the recommender.*.update IAM permission for the specified recommender.
| Parameters | |
|---|---|
| Name | Description |
request |
MarkRecommendationSucceededRequest
The request object. Request for the |
name |
Required. Name of the recommendation. This corresponds to the |
state_metadata |
:class:
State properties to include with this state. Overwrites any existing |
etag |
Required. Fingerprint of the Recommendation. Provides optimistic locking. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.recommender_v1beta1.types.Recommendation | A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_insight_path
parse_insight_path(path: str)Parses a insight path into its component segments.
parse_insight_type_path
parse_insight_type_path(path: str)Parses a insight_type path into its component segments.
parse_recommendation_path
parse_recommendation_path(path: str)Parses a recommendation path into its component segments.
parse_recommender_path
parse_recommender_path(path: str)Parses a recommender path into its component segments.
recommendation_path
recommendation_path(
project: str, location: str, recommender: str, recommendation: str
)Returns a fully-qualified recommendation string.
recommender_path
recommender_path(project: str, location: str, recommender: str)Returns a fully-qualified recommender string.