Module api

Module api 

Source

Structs§

BillingAccountLocationInsightTypeGetConfigCall
Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
BillingAccountLocationInsightTypeInsightGetCall
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
BillingAccountLocationInsightTypeInsightListCall
Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
BillingAccountLocationInsightTypeInsightMarkAcceptedCall
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.
BillingAccountLocationInsightTypeUpdateConfigCall
Updates an InsightTypeConfig change. This will create a new revision of the config.
BillingAccountLocationRecommenderGetConfigCall
Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
BillingAccountLocationRecommenderRecommendationGetCall
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
BillingAccountLocationRecommenderRecommendationListCall
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
BillingAccountLocationRecommenderRecommendationMarkClaimedCall
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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
BillingAccountLocationRecommenderRecommendationMarkDismissedCall
Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
BillingAccountLocationRecommenderRecommendationMarkFailedCall
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.
BillingAccountLocationRecommenderRecommendationMarkSucceededCall
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.
BillingAccountLocationRecommenderUpdateConfigCall
Updates a Recommender Config. This will create a new revision of the config.
BillingAccountMethods
A builder providing access to all methods supported on billingAccount resources. It is not used directly, but through the Recommender hub.
FolderLocationInsightTypeInsightGetCall
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
FolderLocationInsightTypeInsightListCall
Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
FolderLocationInsightTypeInsightMarkAcceptedCall
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.
FolderLocationRecommenderRecommendationGetCall
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
FolderLocationRecommenderRecommendationListCall
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
FolderLocationRecommenderRecommendationMarkClaimedCall
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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
FolderLocationRecommenderRecommendationMarkDismissedCall
Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
FolderLocationRecommenderRecommendationMarkFailedCall
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.
FolderLocationRecommenderRecommendationMarkSucceededCall
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.
FolderMethods
A builder providing access to all methods supported on folder resources. It is not used directly, but through the Recommender hub.
GoogleCloudRecommenderV1CostProjection
Contains metadata about how much money a recommendation can save or incur.
GoogleCloudRecommenderV1Impact
Contains the impact a recommendation can have for a given category.
GoogleCloudRecommenderV1Insight
An insight along with the information used to derive the insight. The insight may have associated recommendations as well.
GoogleCloudRecommenderV1InsightRecommendationReference
Reference to an associated recommendation.
GoogleCloudRecommenderV1InsightStateInfo
Information related to insight state.
GoogleCloudRecommenderV1InsightTypeConfig
Configuration for an InsightType.
GoogleCloudRecommenderV1InsightTypeGenerationConfig
A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight.
GoogleCloudRecommenderV1ListInsightsResponse
Response to the ListInsights method.
GoogleCloudRecommenderV1ListRecommendationsResponse
Response to the ListRecommendations method.
GoogleCloudRecommenderV1MarkInsightAcceptedRequest
Request for the MarkInsightAccepted method.
GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
Request for the MarkRecommendationClaimed Method.
GoogleCloudRecommenderV1MarkRecommendationDismissedRequest
Request for the MarkRecommendationDismissed Method.
GoogleCloudRecommenderV1MarkRecommendationFailedRequest
Request for the MarkRecommendationFailed Method.
GoogleCloudRecommenderV1MarkRecommendationSucceededRequest
Request for the MarkRecommendationSucceeded Method.
GoogleCloudRecommenderV1Operation
Contains an operation for a resource loosely based on the JSON-PATCH format with support for: * Custom filters for describing partial array patch. * Extended path values for describing nested arrays. * Custom fields for describing the resource for which the operation is being described. * Allows extension to custom operations not natively supported by RFC6902. See https://tools.ietf.org/html/rfc6902 for details on the original RFC.
GoogleCloudRecommenderV1OperationGroup
Group of operations that need to be performed atomically.
GoogleCloudRecommenderV1Recommendation
A recommendation along with a suggested action. E.g., a rightsizing recommendation for an underutilized VM, IAM role recommendations, etc
GoogleCloudRecommenderV1RecommendationContent
Contains what resources are changing and how they are changing.
GoogleCloudRecommenderV1RecommendationInsightReference
Reference to an associated insight.
GoogleCloudRecommenderV1RecommendationStateInfo
Information for state. Contains state and metadata.
GoogleCloudRecommenderV1RecommenderConfig
Configuration for a Recommender.
GoogleCloudRecommenderV1RecommenderGenerationConfig
A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation.
GoogleCloudRecommenderV1ReliabilityProjection
Contains information on the impact of a reliability recommendation.
GoogleCloudRecommenderV1SecurityProjection
Contains various ways of describing the impact on Security.
GoogleCloudRecommenderV1SustainabilityProjection
Contains metadata about how much sustainability a recommendation can save or incur.
GoogleCloudRecommenderV1ValueMatcher
Contains various matching options for values for a GCP resource field.
GoogleTypeMoney
Represents an amount of money with its currency type.
OrganizationLocationInsightTypeGetConfigCall
Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
OrganizationLocationInsightTypeInsightGetCall
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
OrganizationLocationInsightTypeInsightListCall
Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
OrganizationLocationInsightTypeInsightMarkAcceptedCall
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.
OrganizationLocationInsightTypeUpdateConfigCall
Updates an InsightTypeConfig change. This will create a new revision of the config.
OrganizationLocationRecommenderGetConfigCall
Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
OrganizationLocationRecommenderRecommendationGetCall
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
OrganizationLocationRecommenderRecommendationListCall
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
OrganizationLocationRecommenderRecommendationMarkClaimedCall
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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
OrganizationLocationRecommenderRecommendationMarkDismissedCall
Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
OrganizationLocationRecommenderRecommendationMarkFailedCall
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.
OrganizationLocationRecommenderRecommendationMarkSucceededCall
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.
OrganizationLocationRecommenderUpdateConfigCall
Updates a Recommender Config. This will create a new revision of the config.
OrganizationMethods
A builder providing access to all methods supported on organization resources. It is not used directly, but through the Recommender hub.
ProjectLocationInsightTypeGetConfigCall
Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
ProjectLocationInsightTypeInsightGetCall
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
ProjectLocationInsightTypeInsightListCall
Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
ProjectLocationInsightTypeInsightMarkAcceptedCall
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.
ProjectLocationInsightTypeUpdateConfigCall
Updates an InsightTypeConfig change. This will create a new revision of the config.
ProjectLocationRecommenderGetConfigCall
Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
ProjectLocationRecommenderRecommendationGetCall
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationListCall
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationMarkClaimedCall
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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationMarkDismissedCall
Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.
ProjectLocationRecommenderRecommendationMarkFailedCall
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.
ProjectLocationRecommenderRecommendationMarkSucceededCall
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.
ProjectLocationRecommenderUpdateConfigCall
Updates a Recommender Config. This will create a new revision of the config.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the Recommender hub.
Recommender
Central instance to access all Recommender related resource activities

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.