Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Recommender

import { Recommender } from "https://googleapis.deno.dev/v1/recommender:v1.ts";

class Recommender {

constructor(client?: CredentialsClient, baseUrl?: string);

async billingAccountsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async billingAccountsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>;

async billingAccountsLocationsInsightTypesInsightsList(parent: string, opts?: BillingAccountsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>;

async billingAccountsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>;

async billingAccountsLocationsInsightTypesUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1InsightTypeConfig,

opts?: BillingAccountsLocationsInsightTypesUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async billingAccountsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

async billingAccountsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>;

async billingAccountsLocationsRecommendersRecommendationsList(parent: string, opts?: BillingAccountsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>;

async billingAccountsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async billingAccountsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async billingAccountsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async billingAccountsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async billingAccountsLocationsRecommendersUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1RecommenderConfig,

opts?: BillingAccountsLocationsRecommendersUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

async foldersLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>;

async foldersLocationsInsightTypesInsightsList(parent: string, opts?: FoldersLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>;

async foldersLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>;

async foldersLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>;

async foldersLocationsRecommendersRecommendationsList(parent: string, opts?: FoldersLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>;

async foldersLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async foldersLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async foldersLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async foldersLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async organizationsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>;

async organizationsLocationsInsightTypesInsightsList(parent: string, opts?: OrganizationsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>;

async organizationsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>;

async organizationsLocationsInsightTypesUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1InsightTypeConfig,

opts?: OrganizationsLocationsInsightTypesUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async organizationsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

async organizationsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsRecommendersRecommendationsList(parent: string, opts?: OrganizationsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>;

async organizationsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async organizationsLocationsRecommendersUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1RecommenderConfig,

opts?: OrganizationsLocationsRecommendersUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

async projectsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async projectsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>;

async projectsLocationsInsightTypesInsightsList(parent: string, opts?: ProjectsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>;

async projectsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>;

async projectsLocationsInsightTypesUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1InsightTypeConfig,

opts?: ProjectsLocationsInsightTypesUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1InsightTypeConfig>;

async projectsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

async projectsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>;

async projectsLocationsRecommendersRecommendationsList(parent: string, opts?: ProjectsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>;

async projectsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async projectsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async projectsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async projectsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>;

async projectsLocationsRecommendersUpdateConfig(

name: string,

req: GoogleCloudRecommenderV1RecommenderConfig,

opts?: ProjectsLocationsRecommendersUpdateConfigOptions,

): Promise<GoogleCloudRecommenderV1RecommenderConfig>;

}

§Constructors

new Recommender(client?: CredentialsClient, baseUrl?: string)

§Methods

billingAccountsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

@param name

Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

billingAccountsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

@param name

Required. Name of the insight.

billingAccountsLocationsInsightTypesInsightsList(parent: string, opts?: BillingAccountsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.

billingAccountsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>

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.

@param name

Required. Name of the insight.

billingAccountsLocationsInsightTypesUpdateConfig(name: string, req: GoogleCloudRecommenderV1InsightTypeConfig, opts?: BillingAccountsLocationsInsightTypesUpdateConfigOptions): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Updates an InsightTypeConfig change. This will create a new revision of the config.

@param name

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

billingAccountsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

@param name

Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

billingAccountsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

@param name

Required. Name of the recommendation.

billingAccountsLocationsRecommendersRecommendationsList(parent: string, opts?: BillingAccountsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

billingAccountsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

billingAccountsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

billingAccountsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

billingAccountsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

billingAccountsLocationsRecommendersUpdateConfig(name: string, req: GoogleCloudRecommenderV1RecommenderConfig, opts?: BillingAccountsLocationsRecommendersUpdateConfigOptions): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Updates a Recommender Config. This will create a new revision of the config.

@param name

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

foldersLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

@param name

Required. Name of the insight.

foldersLocationsInsightTypesInsightsList(parent: string, opts?: FoldersLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.

foldersLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>

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.

@param name

Required. Name of the insight.

foldersLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

@param name

Required. Name of the recommendation.

foldersLocationsRecommendersRecommendationsList(parent: string, opts?: FoldersLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

foldersLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

foldersLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

foldersLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

foldersLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

organizationsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

@param name

Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

organizationsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

@param name

Required. Name of the insight.

organizationsLocationsInsightTypesInsightsList(parent: string, opts?: OrganizationsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.

organizationsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>

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.

@param name

Required. Name of the insight.

organizationsLocationsInsightTypesUpdateConfig(name: string, req: GoogleCloudRecommenderV1InsightTypeConfig, opts?: OrganizationsLocationsInsightTypesUpdateConfigOptions): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Updates an InsightTypeConfig change. This will create a new revision of the config.

@param name

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

organizationsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

@param name

Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

organizationsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

@param name

Required. Name of the recommendation.

organizationsLocationsRecommendersRecommendationsList(parent: string, opts?: OrganizationsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

organizationsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

organizationsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

organizationsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

organizationsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

organizationsLocationsRecommendersUpdateConfig(name: string, req: GoogleCloudRecommenderV1RecommenderConfig, opts?: OrganizationsLocationsRecommendersUpdateConfigOptions): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Updates a Recommender Config. This will create a new revision of the config.

@param name

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

projectsLocationsInsightTypesGetConfig(name: string): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

@param name

Required. Name of the InsightTypeConfig to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config

projectsLocationsInsightTypesInsightsGet(name: string): Promise<GoogleCloudRecommenderV1Insight>

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

@param name

Required. Name of the insight.

projectsLocationsInsightTypesInsightsList(parent: string, opts?: ProjectsLocationsInsightTypesInsightsListOptions): Promise<GoogleCloudRecommenderV1ListInsightsResponse>

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.

projectsLocationsInsightTypesInsightsMarkAccepted(name: string, req: GoogleCloudRecommenderV1MarkInsightAcceptedRequest): Promise<GoogleCloudRecommenderV1Insight>

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.

@param name

Required. Name of the insight.

projectsLocationsInsightTypesUpdateConfig(name: string, req: GoogleCloudRecommenderV1InsightTypeConfig, opts?: ProjectsLocationsInsightTypesUpdateConfigOptions): Promise<GoogleCloudRecommenderV1InsightTypeConfig>

Updates an InsightTypeConfig change. This will create a new revision of the config.

@param name

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

projectsLocationsRecommendersGetConfig(name: string): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

@param name

Required. Name of the Recommendation Config to get. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config

projectsLocationsRecommendersRecommendationsGet(name: string): Promise<GoogleCloudRecommenderV1Recommendation>

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

@param name

Required. Name of the recommendation.

projectsLocationsRecommendersRecommendationsList(parent: string, opts?: ProjectsLocationsRecommendersRecommendationsListOptions): Promise<GoogleCloudRecommenderV1ListRecommendationsResponse>

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

@param parent

Required. The container resource on which to execute the request. Acceptable formats: * projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders.

projectsLocationsRecommendersRecommendationsMarkClaimed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationClaimedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

projectsLocationsRecommendersRecommendationsMarkDismissed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationDismissedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

projectsLocationsRecommendersRecommendationsMarkFailed(name: string, req: GoogleCloudRecommenderV1MarkRecommendationFailedRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

projectsLocationsRecommendersRecommendationsMarkSucceeded(name: string, req: GoogleCloudRecommenderV1MarkRecommendationSucceededRequest): Promise<GoogleCloudRecommenderV1Recommendation>

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.

@param name

Required. Name of the recommendation.

projectsLocationsRecommendersUpdateConfig(name: string, req: GoogleCloudRecommenderV1RecommenderConfig, opts?: ProjectsLocationsRecommendersUpdateConfigOptions): Promise<GoogleCloudRecommenderV1RecommenderConfig>

Updates a Recommender Config. This will create a new revision of the config.

@param name

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