Summary of entries of Methods for recommender.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient
RecommenderAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recommender_v1.services.recommender.transports.base.RecommenderTransport, typing.Callable[[...], google.cloud.recommender_v1.services.recommender.transports.base.RecommenderTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the recommender async client.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_billing_account_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_folder_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_location_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_organization_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.common_project_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_file
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_info
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.from_service_account_json
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_insight
get_insight(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetInsightRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight.Insight
Gets the requested insight.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_insight
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_insight_type_config
get_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetInsightTypeConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
Gets the requested InsightTypeConfig.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_insight_type_config
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_recommendation
get_recommendation(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetRecommendationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Gets the requested recommendation.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_recommendation
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_recommender_config
get_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetRecommenderConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
Gets the requested Recommender Config.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_recommender_config
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.recommender_v1.services.recommender.transports.base.RecommenderTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.get_transport_class
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_path
insight_path(project: str, location: str, insight_type: str, insight: str) -> str
Returns a fully-qualified insight string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_type_config_path
insight_type_config_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type_config string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_type_config_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_type_path
insight_type_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.insight_type_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.list_insights
list_insights(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.services.recommender.pagers.ListInsightsAsyncPager
Lists insights for the specified Cloud Resource.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.list_insights
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.list_recommendations
list_recommendations(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsAsyncPager
)
Lists recommendations for the specified Cloud Resource.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.list_recommendations
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_insight_accepted
mark_insight_accepted(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkInsightAcceptedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight.Insight
Marks the Insight State as Accepted.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_insight_accepted
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_claimed
mark_recommendation_claimed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationClaimedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Claimed.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_claimed
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_dismissed
mark_recommendation_dismissed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationDismissedRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Mark the Recommendation State as Dismissed.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_failed
mark_recommendation_failed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationFailedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Failed.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_failed
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.mark_recommendation_succeeded
mark_recommendation_succeeded(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationSucceededRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Succeeded.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_folder_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_location_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_common_project_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_insight_path
parse_insight_path(path: str) -> typing.Dict[str, str]
Parses a insight path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_insight_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_insight_type_config_path
parse_insight_type_config_path(path: str) -> typing.Dict[str, str]
Parses a insight_type_config path into its component segments.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_insight_type_path
parse_insight_type_path(path: str) -> typing.Dict[str, str]
Parses a insight_type path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_insight_type_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_recommendation_path
parse_recommendation_path(path: str) -> typing.Dict[str, str]
Parses a recommendation path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_recommendation_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_recommender_config_path
parse_recommender_config_path(path: str) -> typing.Dict[str, str]
Parses a recommender_config path into its component segments.
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_recommender_path
parse_recommender_path(path: str) -> typing.Dict[str, str]
Parses a recommender path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.parse_recommender_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommendation_path
recommendation_path(
project: str, location: str, recommender: str, recommendation: str
) -> str
Returns a fully-qualified recommendation string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommendation_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommender_config_path
recommender_config_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender_config string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommender_config_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommender_path
recommender_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.recommender_path
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.update_insight_type_config
update_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.UpdateInsightTypeConfigRequest,
dict,
]
] = None,
*,
insight_type_config: typing.Optional[
google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
Updates an InsightTypeConfig change.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.update_insight_type_config
google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.update_recommender_config
update_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.UpdateRecommenderConfigRequest,
dict,
]
] = None,
*,
recommender_config: typing.Optional[
google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
Updates a Recommender Config.
See more: google.cloud.recommender_v1.services.recommender.RecommenderAsyncClient.update_recommender_config
google.cloud.recommender_v1.services.recommender.RecommenderClient
RecommenderClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recommender_v1.services.recommender.transports.base.RecommenderTransport, typing.Callable[[...], google.cloud.recommender_v1.services.recommender.transports.base.RecommenderTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the recommender client.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient
google.cloud.recommender_v1.services.recommender.RecommenderClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.exit
google.cloud.recommender_v1.services.recommender.RecommenderClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.common_billing_account_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.common_folder_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.common_location_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.common_organization_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.common_project_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_file
google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_info
google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.from_service_account_json
google.cloud.recommender_v1.services.recommender.RecommenderClient.get_insight
get_insight(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetInsightRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight.Insight
Gets the requested insight.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.get_insight
google.cloud.recommender_v1.services.recommender.RecommenderClient.get_insight_type_config
get_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetInsightTypeConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
Gets the requested InsightTypeConfig.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.get_insight_type_config
google.cloud.recommender_v1.services.recommender.RecommenderClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.get_mtls_endpoint_and_cert_source
google.cloud.recommender_v1.services.recommender.RecommenderClient.get_recommendation
get_recommendation(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetRecommendationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Gets the requested recommendation.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.get_recommendation
google.cloud.recommender_v1.services.recommender.RecommenderClient.get_recommender_config
get_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.GetRecommenderConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
Gets the requested Recommender Config.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.get_recommender_config
google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_path
insight_path(project: str, location: str, insight_type: str, insight: str) -> str
Returns a fully-qualified insight string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_type_config_path
insight_type_config_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type_config string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_type_config_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_type_path
insight_type_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.insight_type_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.list_insights
list_insights(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.services.recommender.pagers.ListInsightsPager
Lists insights for the specified Cloud Resource.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.list_insights
google.cloud.recommender_v1.services.recommender.RecommenderClient.list_recommendations
list_recommendations(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsPager
Lists recommendations for the specified Cloud Resource.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.list_recommendations
google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_insight_accepted
mark_insight_accepted(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkInsightAcceptedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight.Insight
Marks the Insight State as Accepted.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_insight_accepted
google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_claimed
mark_recommendation_claimed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationClaimedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Claimed.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_claimed
google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_dismissed
mark_recommendation_dismissed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationDismissedRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Mark the Recommendation State as Dismissed.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_dismissed
google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_failed
mark_recommendation_failed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationFailedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Failed.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_failed
google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_succeeded
mark_recommendation_succeeded(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.MarkRecommendationSucceededRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommendation.Recommendation
Marks the Recommendation State as Succeeded.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.mark_recommendation_succeeded
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_billing_account_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_folder_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_location_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_organization_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_common_project_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_path
parse_insight_path(path: str) -> typing.Dict[str, str]
Parses a insight path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_type_config_path
parse_insight_type_config_path(path: str) -> typing.Dict[str, str]
Parses a insight_type_config path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_type_config_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_type_path
parse_insight_type_path(path: str) -> typing.Dict[str, str]
Parses a insight_type path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_insight_type_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommendation_path
parse_recommendation_path(path: str) -> typing.Dict[str, str]
Parses a recommendation path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommendation_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommender_config_path
parse_recommender_config_path(path: str) -> typing.Dict[str, str]
Parses a recommender_config path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommender_config_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommender_path
parse_recommender_path(path: str) -> typing.Dict[str, str]
Parses a recommender path into its component segments.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.parse_recommender_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.recommendation_path
recommendation_path(
project: str, location: str, recommender: str, recommendation: str
) -> str
Returns a fully-qualified recommendation string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.recommendation_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.recommender_config_path
recommender_config_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender_config string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.recommender_config_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.recommender_path
recommender_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender string.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.recommender_path
google.cloud.recommender_v1.services.recommender.RecommenderClient.update_insight_type_config
update_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.UpdateInsightTypeConfigRequest,
dict,
]
] = None,
*,
insight_type_config: typing.Optional[
google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.insight_type_config.InsightTypeConfig
Updates an InsightTypeConfig change.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.update_insight_type_config
google.cloud.recommender_v1.services.recommender.RecommenderClient.update_recommender_config
update_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1.types.recommender_service.UpdateRecommenderConfigRequest,
dict,
]
] = None,
*,
recommender_config: typing.Optional[
google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1.types.recommender_config.RecommenderConfig
Updates a Recommender Config.
See more: google.cloud.recommender_v1.services.recommender.RecommenderClient.update_recommender_config
google.cloud.recommender_v1.services.recommender.pagers.ListInsightsAsyncPager
ListInsightsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse
],
],
request: google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
response: google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1.services.recommender.pagers.ListInsightsAsyncPager
google.cloud.recommender_v1.services.recommender.pagers.ListInsightsPager
ListInsightsPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
],
request: google.cloud.recommender_v1.types.recommender_service.ListInsightsRequest,
response: google.cloud.recommender_v1.types.recommender_service.ListInsightsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1.services.recommender.pagers.ListInsightsPager
google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsAsyncPager
ListRecommendationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse
],
],
request: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
response: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsAsyncPager
google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsPager
ListRecommendationsPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
],
request: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsRequest,
response: google.cloud.recommender_v1.types.recommender_service.ListRecommendationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1.services.recommender.pagers.ListRecommendationsPager
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient
RecommenderAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport, typing.Callable[[...], google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the recommender async client.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_folder_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_location_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.common_project_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_insight
get_insight(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetInsightRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight.Insight
Gets the requested insight.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_insight
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_insight_type_config
get_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetInsightTypeConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
Gets the requested InsightTypeConfig.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_insight_type_config
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_recommendation
get_recommendation(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetRecommendationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Gets the requested recommendation.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_recommendation
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_recommender_config
get_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetRecommenderConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
Gets the requested Recommender Config.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_recommender_config
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport
]
)
Returns an appropriate transport class.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.get_transport_class
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.insight_path
insight_path(project: str, location: str, insight_type: str, insight: str) -> str
Returns a fully-qualified insight string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.insight_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.insight_type_config_path
insight_type_config_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type_config string.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.insight_type_path
insight_type_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.insight_type_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_insight_types
list_insight_types(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesAsyncPager
)
Lists available InsightTypes.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_insight_types
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_insights
list_insights(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager
)
Lists insights for the specified Cloud Resource.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_insights
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_recommendations
list_recommendations(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager
)
Lists recommendations for the specified Cloud Resource.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_recommendations
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_recommenders
list_recommenders(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersAsyncPager
)
Lists all available Recommenders.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.list_recommenders
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.mark_insight_accepted
mark_insight_accepted(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkInsightAcceptedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight.Insight
Marks the Insight State as Accepted.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.mark_insight_accepted
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.mark_recommendation_claimed
mark_recommendation_claimed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationClaimedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Claimed.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.mark_recommendation_failed
mark_recommendation_failed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationFailedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Failed.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.mark_recommendation_succeeded
mark_recommendation_succeeded(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationSucceededRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Succeeded.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_insight_path
parse_insight_path(path: str) -> typing.Dict[str, str]
Parses a insight path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_insight_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_insight_type_config_path
parse_insight_type_config_path(path: str) -> typing.Dict[str, str]
Parses a insight_type_config path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_insight_type_path
parse_insight_type_path(path: str) -> typing.Dict[str, str]
Parses a insight_type path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_insight_type_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_recommendation_path
parse_recommendation_path(path: str) -> typing.Dict[str, str]
Parses a recommendation path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_recommender_config_path
parse_recommender_config_path(path: str) -> typing.Dict[str, str]
Parses a recommender_config path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_recommender_path
parse_recommender_path(path: str) -> typing.Dict[str, str]
Parses a recommender path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.parse_recommender_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommendation_path
recommendation_path(
project: str, location: str, recommender: str, recommendation: str
) -> str
Returns a fully-qualified recommendation string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommendation_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommender_config_path
recommender_config_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender_config string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommender_config_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommender_path
recommender_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.recommender_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.update_insight_type_config
update_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.UpdateInsightTypeConfigRequest,
dict,
]
] = None,
*,
insight_type_config: typing.Optional[
google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
Updates an InsightTypeConfig change.
google.cloud.recommender_v1beta1.services.recommender.RecommenderAsyncClient.update_recommender_config
update_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.UpdateRecommenderConfigRequest,
dict,
]
] = None,
*,
recommender_config: typing.Optional[
google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
Updates a Recommender Config.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient
RecommenderClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport, typing.Callable[[...], google.cloud.recommender_v1beta1.services.recommender.transports.base.RecommenderTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the recommender client.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.exit
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_billing_account_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_folder_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_location_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_organization_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.common_project_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_file
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_info
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.from_service_account_json
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_insight
get_insight(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetInsightRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight.Insight
Gets the requested insight.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_insight
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_insight_type_config
get_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetInsightTypeConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
Gets the requested InsightTypeConfig.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_insight_type_config
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_recommendation
get_recommendation(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetRecommendationRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Gets the requested recommendation.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_recommendation
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_recommender_config
get_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.GetRecommenderConfigRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
Gets the requested Recommender Config.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.get_recommender_config
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_path
insight_path(project: str, location: str, insight_type: str, insight: str) -> str
Returns a fully-qualified insight string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_type_config_path
insight_type_config_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type_config string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_type_config_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_type_path
insight_type_path(project: str, location: str, insight_type: str) -> str
Returns a fully-qualified insight_type string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.insight_type_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_insight_types
list_insight_types(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesPager
Lists available InsightTypes.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_insight_types
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_insights
list_insights(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsPager
Lists insights for the specified Cloud Resource.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_insights
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_recommendations
list_recommendations(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
filter: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsPager
)
Lists recommendations for the specified Cloud Resource.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_recommendations
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_recommenders
list_recommenders(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersPager
Lists all available Recommenders.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.list_recommenders
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_insight_accepted
mark_insight_accepted(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkInsightAcceptedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight.Insight
Marks the Insight State as Accepted.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_insight_accepted
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_recommendation_claimed
mark_recommendation_claimed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationClaimedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Claimed.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_recommendation_claimed
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_recommendation_failed
mark_recommendation_failed(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationFailedRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Failed.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_recommendation_failed
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.mark_recommendation_succeeded
mark_recommendation_succeeded(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.MarkRecommendationSucceededRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
state_metadata: typing.Optional[typing.MutableMapping[str, str]] = None,
etag: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommendation.Recommendation
Marks the Recommendation State as Succeeded.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_folder_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_location_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_common_project_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_insight_path
parse_insight_path(path: str) -> typing.Dict[str, str]
Parses a insight path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_insight_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_insight_type_config_path
parse_insight_type_config_path(path: str) -> typing.Dict[str, str]
Parses a insight_type_config path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_insight_type_path
parse_insight_type_path(path: str) -> typing.Dict[str, str]
Parses a insight_type path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_insight_type_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_recommendation_path
parse_recommendation_path(path: str) -> typing.Dict[str, str]
Parses a recommendation path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_recommendation_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_recommender_config_path
parse_recommender_config_path(path: str) -> typing.Dict[str, str]
Parses a recommender_config path into its component segments.
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_recommender_path
parse_recommender_path(path: str) -> typing.Dict[str, str]
Parses a recommender path into its component segments.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.parse_recommender_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommendation_path
recommendation_path(
project: str, location: str, recommender: str, recommendation: str
) -> str
Returns a fully-qualified recommendation string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommendation_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommender_config_path
recommender_config_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender_config string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommender_config_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommender_path
recommender_path(project: str, location: str, recommender: str) -> str
Returns a fully-qualified recommender string.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.recommender_path
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.update_insight_type_config
update_insight_type_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.UpdateInsightTypeConfigRequest,
dict,
]
] = None,
*,
insight_type_config: typing.Optional[
google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.insight_type_config.InsightTypeConfig
Updates an InsightTypeConfig change.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.update_insight_type_config
google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.update_recommender_config
update_recommender_config(
request: typing.Optional[
typing.Union[
google.cloud.recommender_v1beta1.types.recommender_service.UpdateRecommenderConfigRequest,
dict,
]
] = None,
*,
recommender_config: typing.Optional[
google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.recommender_v1beta1.types.recommender_config.RecommenderConfig
Updates a Recommender Config.
See more: google.cloud.recommender_v1beta1.services.recommender.RecommenderClient.update_recommender_config
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesAsyncPager
ListInsightTypesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesResponse
],
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesAsyncPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesPager
ListInsightTypesPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesResponse,
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightTypesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightTypesPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager
ListInsightsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsResponse
],
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsAsyncPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsPager
ListInsightsPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsResponse,
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListInsightsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListInsightsPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager
ListRecommendationsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsResponse
],
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsAsyncPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsPager
ListRecommendationsPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsResponse,
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendationsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendationsPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersAsyncPager
ListRecommendersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse
],
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiates the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersAsyncPager
google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersPager
ListRecommendersPager(
method: typing.Callable[
[...],
google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse,
],
request: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersRequest,
response: google.cloud.recommender_v1beta1.types.recommender_service.ListRecommendersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)
Instantiate the pager.
See more: google.cloud.recommender_v1beta1.services.recommender.pagers.ListRecommendersPager