recommender

package
v0.199.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2024 License: BSD-3-Clause Imports: 16 Imported by: 5

Documentation

Overview

Package recommender provides access to the Recommender API.

For product documentation, see: https://cloud.google.com/recommender/docs/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/recommender/v1"
...
ctx := context.Background()
recommenderService, err := recommender.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

recommenderService, err := recommender.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
recommenderService, err := recommender.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type BillingAccountsLocationsInsightTypesGetConfigCall added in v0.98.0

type BillingAccountsLocationsInsightTypesGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsInsightTypesGetConfigCall) Context added in v0.98.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsInsightTypesGetConfigCall) Do added in v0.98.0

Do executes the "recommender.billingAccounts.locations.insightTypes.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsInsightTypesGetConfigCall) Fields added in v0.98.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsInsightTypesGetConfigCall) Header added in v0.98.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsInsightTypesGetConfigCall) IfNoneMatch added in v0.98.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type BillingAccountsLocationsInsightTypesInsightsGetCall added in v0.37.0

type BillingAccountsLocationsInsightTypesInsightsGetCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsInsightTypesInsightsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsInsightTypesInsightsGetCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.insightTypes.insights.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsInsightTypesInsightsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsInsightTypesInsightsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsInsightTypesInsightsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type BillingAccountsLocationsInsightTypesInsightsListCall added in v0.37.0

type BillingAccountsLocationsInsightTypesInsightsListCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.insightTypes.insights.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListInsightsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*BillingAccountsLocationsInsightTypesInsightsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall added in v0.37.0

type BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.insightTypes.insights.markAccepted" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsInsightTypesInsightsMarkAcceptedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BillingAccountsLocationsInsightTypesInsightsService added in v0.37.0

type BillingAccountsLocationsInsightTypesInsightsService struct {
	// contains filtered or unexported fields
}

func NewBillingAccountsLocationsInsightTypesInsightsService added in v0.37.0

func NewBillingAccountsLocationsInsightTypesInsightsService(s *Service) *BillingAccountsLocationsInsightTypesInsightsService

func (*BillingAccountsLocationsInsightTypesInsightsService) Get added in v0.37.0

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

- name: Name of the insight.

func (*BillingAccountsLocationsInsightTypesInsightsService) List added in v0.37.0

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

  • parent: 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/[IN SIGHT_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.

func (*BillingAccountsLocationsInsightTypesInsightsService) MarkAccepted added in v0.37.0

MarkAccepted: 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.

- name: Name of the insight.

type BillingAccountsLocationsInsightTypesService added in v0.37.0

type BillingAccountsLocationsInsightTypesService struct {
	Insights *BillingAccountsLocationsInsightTypesInsightsService
	// contains filtered or unexported fields
}

func NewBillingAccountsLocationsInsightTypesService added in v0.37.0

func NewBillingAccountsLocationsInsightTypesService(s *Service) *BillingAccountsLocationsInsightTypesService

func (*BillingAccountsLocationsInsightTypesService) GetConfig added in v0.98.0

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

  • name: 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/[IN SIGHT_TYPE_ID]/config`.

func (*BillingAccountsLocationsInsightTypesService) UpdateConfig added in v0.98.0

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

  • name: Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_I D]/config.

type BillingAccountsLocationsInsightTypesUpdateConfigCall added in v0.98.0

type BillingAccountsLocationsInsightTypesUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) Context added in v0.98.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) Do added in v0.98.0

Do executes the "recommender.billingAccounts.locations.insightTypes.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) Fields added in v0.98.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) Header added in v0.98.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) UpdateMask added in v0.98.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*BillingAccountsLocationsInsightTypesUpdateConfigCall) ValidateOnly added in v0.98.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type BillingAccountsLocationsRecommendersGetConfigCall added in v0.98.0

type BillingAccountsLocationsRecommendersGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersGetConfigCall) Context added in v0.98.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersGetConfigCall) Do added in v0.98.0

Do executes the "recommender.billingAccounts.locations.recommenders.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersGetConfigCall) Fields added in v0.98.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersGetConfigCall) Header added in v0.98.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsRecommendersGetConfigCall) IfNoneMatch added in v0.98.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type BillingAccountsLocationsRecommendersRecommendationsGetCall added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsGetCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsGetCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsRecommendersRecommendationsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type BillingAccountsLocationsRecommendersRecommendationsListCall added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsListCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListRecommendationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*BillingAccountsLocationsRecommendersRecommendationsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.markClaimed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkClaimedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall added in v0.107.0

type BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall) Context added in v0.107.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall) Do added in v0.107.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.markDismissed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall) Fields added in v0.107.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkDismissedCall) Header added in v0.107.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.markFailed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkFailedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall) Do added in v0.37.0

Do executes the "recommender.billingAccounts.locations.recommenders.recommendations.markSucceeded" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersRecommendationsMarkSucceededCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type BillingAccountsLocationsRecommendersRecommendationsService added in v0.37.0

type BillingAccountsLocationsRecommendersRecommendationsService struct {
	// contains filtered or unexported fields
}

func NewBillingAccountsLocationsRecommendersRecommendationsService added in v0.37.0

func NewBillingAccountsLocationsRecommendersRecommendationsService(s *Service) *BillingAccountsLocationsRecommendersRecommendationsService

func (*BillingAccountsLocationsRecommendersRecommendationsService) Get added in v0.37.0

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

- name: Name of the recommendation.

func (*BillingAccountsLocationsRecommendersRecommendationsService) List added in v0.37.0

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

  • parent: The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_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.

func (*BillingAccountsLocationsRecommendersRecommendationsService) MarkClaimed added in v0.37.0

MarkClaimed: 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.

- name: Name of the recommendation.

func (*BillingAccountsLocationsRecommendersRecommendationsService) MarkDismissed added in v0.107.0

MarkDismissed: 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.

- name: Name of the recommendation.

func (*BillingAccountsLocationsRecommendersRecommendationsService) MarkFailed added in v0.37.0

MarkFailed: 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.

- name: Name of the recommendation.

func (*BillingAccountsLocationsRecommendersRecommendationsService) MarkSucceeded added in v0.37.0

MarkSucceeded: 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.

- name: Name of the recommendation.

type BillingAccountsLocationsRecommendersService added in v0.37.0

type BillingAccountsLocationsRecommendersService struct {
	Recommendations *BillingAccountsLocationsRecommendersRecommendationsService
	// contains filtered or unexported fields
}

func NewBillingAccountsLocationsRecommendersService added in v0.37.0

func NewBillingAccountsLocationsRecommendersService(s *Service) *BillingAccountsLocationsRecommendersService

func (*BillingAccountsLocationsRecommendersService) GetConfig added in v0.98.0

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

  • name: Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/c onfig` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]/config`.

func (*BillingAccountsLocationsRecommendersService) UpdateConfig added in v0.98.0

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

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

type BillingAccountsLocationsRecommendersUpdateConfigCall added in v0.98.0

type BillingAccountsLocationsRecommendersUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) Context added in v0.98.0

Context sets the context to be used in this call's Do method.

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) Do added in v0.98.0

Do executes the "recommender.billingAccounts.locations.recommenders.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) Fields added in v0.98.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) Header added in v0.98.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) UpdateMask added in v0.98.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*BillingAccountsLocationsRecommendersUpdateConfigCall) ValidateOnly added in v0.98.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type BillingAccountsLocationsService added in v0.37.0

type BillingAccountsLocationsService struct {
	InsightTypes *BillingAccountsLocationsInsightTypesService

	Recommenders *BillingAccountsLocationsRecommendersService
	// contains filtered or unexported fields
}

func NewBillingAccountsLocationsService added in v0.37.0

func NewBillingAccountsLocationsService(s *Service) *BillingAccountsLocationsService

type BillingAccountsService added in v0.37.0

type BillingAccountsService struct {
	Locations *BillingAccountsLocationsService
	// contains filtered or unexported fields
}

func NewBillingAccountsService added in v0.37.0

func NewBillingAccountsService(s *Service) *BillingAccountsService

type FoldersLocationsInsightTypesInsightsGetCall added in v0.37.0

type FoldersLocationsInsightTypesInsightsGetCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsInsightTypesInsightsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsInsightTypesInsightsGetCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.insightTypes.insights.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsInsightTypesInsightsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsInsightTypesInsightsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersLocationsInsightTypesInsightsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type FoldersLocationsInsightTypesInsightsListCall added in v0.37.0

type FoldersLocationsInsightTypesInsightsListCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsInsightTypesInsightsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsInsightTypesInsightsListCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.insightTypes.insights.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListInsightsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsInsightTypesInsightsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsInsightTypesInsightsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*FoldersLocationsInsightTypesInsightsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersLocationsInsightTypesInsightsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersLocationsInsightTypesInsightsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*FoldersLocationsInsightTypesInsightsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*FoldersLocationsInsightTypesInsightsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type FoldersLocationsInsightTypesInsightsMarkAcceptedCall added in v0.37.0

type FoldersLocationsInsightTypesInsightsMarkAcceptedCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsInsightTypesInsightsMarkAcceptedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsInsightTypesInsightsMarkAcceptedCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.insightTypes.insights.markAccepted" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsInsightTypesInsightsMarkAcceptedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsInsightTypesInsightsMarkAcceptedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersLocationsInsightTypesInsightsService added in v0.37.0

type FoldersLocationsInsightTypesInsightsService struct {
	// contains filtered or unexported fields
}

func NewFoldersLocationsInsightTypesInsightsService added in v0.37.0

func NewFoldersLocationsInsightTypesInsightsService(s *Service) *FoldersLocationsInsightTypesInsightsService

func (*FoldersLocationsInsightTypesInsightsService) Get added in v0.37.0

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

- name: Name of the insight.

func (*FoldersLocationsInsightTypesInsightsService) List added in v0.37.0

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

  • parent: 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/[IN SIGHT_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.

func (*FoldersLocationsInsightTypesInsightsService) MarkAccepted added in v0.37.0

MarkAccepted: 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.

- name: Name of the insight.

type FoldersLocationsInsightTypesService added in v0.37.0

type FoldersLocationsInsightTypesService struct {
	Insights *FoldersLocationsInsightTypesInsightsService
	// contains filtered or unexported fields
}

func NewFoldersLocationsInsightTypesService added in v0.37.0

func NewFoldersLocationsInsightTypesService(s *Service) *FoldersLocationsInsightTypesService

type FoldersLocationsRecommendersRecommendationsGetCall added in v0.37.0

type FoldersLocationsRecommendersRecommendationsGetCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsGetCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.recommenders.recommendations.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersLocationsRecommendersRecommendationsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type FoldersLocationsRecommendersRecommendationsListCall added in v0.37.0

type FoldersLocationsRecommendersRecommendationsListCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsListCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.recommenders.recommendations.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListRecommendationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*FoldersLocationsRecommendersRecommendationsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*FoldersLocationsRecommendersRecommendationsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*FoldersLocationsRecommendersRecommendationsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*FoldersLocationsRecommendersRecommendationsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*FoldersLocationsRecommendersRecommendationsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type FoldersLocationsRecommendersRecommendationsMarkClaimedCall added in v0.37.0

type FoldersLocationsRecommendersRecommendationsMarkClaimedCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsMarkClaimedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsMarkClaimedCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.recommenders.recommendations.markClaimed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsMarkClaimedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsMarkClaimedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersLocationsRecommendersRecommendationsMarkDismissedCall added in v0.107.0

type FoldersLocationsRecommendersRecommendationsMarkDismissedCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsMarkDismissedCall) Context added in v0.107.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsMarkDismissedCall) Do added in v0.107.0

Do executes the "recommender.folders.locations.recommenders.recommendations.markDismissed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsMarkDismissedCall) Fields added in v0.107.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsMarkDismissedCall) Header added in v0.107.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersLocationsRecommendersRecommendationsMarkFailedCall added in v0.37.0

type FoldersLocationsRecommendersRecommendationsMarkFailedCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsMarkFailedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsMarkFailedCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.recommenders.recommendations.markFailed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsMarkFailedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsMarkFailedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersLocationsRecommendersRecommendationsMarkSucceededCall added in v0.37.0

type FoldersLocationsRecommendersRecommendationsMarkSucceededCall struct {
	// contains filtered or unexported fields
}

func (*FoldersLocationsRecommendersRecommendationsMarkSucceededCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*FoldersLocationsRecommendersRecommendationsMarkSucceededCall) Do added in v0.37.0

Do executes the "recommender.folders.locations.recommenders.recommendations.markSucceeded" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FoldersLocationsRecommendersRecommendationsMarkSucceededCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*FoldersLocationsRecommendersRecommendationsMarkSucceededCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type FoldersLocationsRecommendersRecommendationsService added in v0.37.0

type FoldersLocationsRecommendersRecommendationsService struct {
	// contains filtered or unexported fields
}

func NewFoldersLocationsRecommendersRecommendationsService added in v0.37.0

func NewFoldersLocationsRecommendersRecommendationsService(s *Service) *FoldersLocationsRecommendersRecommendationsService

func (*FoldersLocationsRecommendersRecommendationsService) Get added in v0.37.0

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

- name: Name of the recommendation.

func (*FoldersLocationsRecommendersRecommendationsService) List added in v0.37.0

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

  • parent: The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_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.

func (*FoldersLocationsRecommendersRecommendationsService) MarkClaimed added in v0.37.0

MarkClaimed: 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.

- name: Name of the recommendation.

func (*FoldersLocationsRecommendersRecommendationsService) MarkDismissed added in v0.107.0

MarkDismissed: 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.

- name: Name of the recommendation.

func (*FoldersLocationsRecommendersRecommendationsService) MarkFailed added in v0.37.0

MarkFailed: 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.

- name: Name of the recommendation.

func (*FoldersLocationsRecommendersRecommendationsService) MarkSucceeded added in v0.37.0

MarkSucceeded: 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.

- name: Name of the recommendation.

type FoldersLocationsRecommendersService added in v0.37.0

type FoldersLocationsRecommendersService struct {
	Recommendations *FoldersLocationsRecommendersRecommendationsService
	// contains filtered or unexported fields
}

func NewFoldersLocationsRecommendersService added in v0.37.0

func NewFoldersLocationsRecommendersService(s *Service) *FoldersLocationsRecommendersService

type FoldersLocationsService added in v0.37.0

type FoldersLocationsService struct {
	InsightTypes *FoldersLocationsInsightTypesService

	Recommenders *FoldersLocationsRecommendersService
	// contains filtered or unexported fields
}

func NewFoldersLocationsService added in v0.37.0

func NewFoldersLocationsService(s *Service) *FoldersLocationsService

type FoldersService added in v0.37.0

type FoldersService struct {
	Locations *FoldersLocationsService
	// contains filtered or unexported fields
}

func NewFoldersService added in v0.37.0

func NewFoldersService(s *Service) *FoldersService

type GoogleCloudRecommenderV1CostProjection

type GoogleCloudRecommenderV1CostProjection struct {
	// Cost: An approximate projection on amount saved or amount incurred. Negative
	// cost units indicate cost savings and positive cost units indicate increase.
	// See google.type.Money documentation for positive/negative units. A user's
	// permissions may affect whether the cost is computed using list prices or
	// custom contract prices.
	Cost *GoogleTypeMoney `json:"cost,omitempty"`
	// CostInLocalCurrency: The approximate cost savings in the billing account's
	// local currency.
	CostInLocalCurrency *GoogleTypeMoney `json:"costInLocalCurrency,omitempty"`
	// Duration: Duration for which this cost applies.
	Duration string `json:"duration,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cost") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cost") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1CostProjection) MarshalJSON

func (s GoogleCloudRecommenderV1CostProjection) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1Impact

type GoogleCloudRecommenderV1Impact struct {
	// Category: Category that is being targeted.
	//
	// Possible values:
	//   "CATEGORY_UNSPECIFIED" - Default unspecified category. Don't use directly.
	//   "COST" - Indicates a potential increase or decrease in cost.
	//   "SECURITY" - Indicates a potential increase or decrease in security.
	//   "PERFORMANCE" - Indicates a potential increase or decrease in performance.
	//   "MANAGEABILITY" - Indicates a potential increase or decrease in
	// manageability.
	//   "SUSTAINABILITY" - Indicates a potential increase or decrease in
	// sustainability.
	//   "RELIABILITY" - Indicates a potential increase or decrease in reliability.
	Category string `json:"category,omitempty"`
	// CostProjection: Use with CategoryType.COST
	CostProjection *GoogleCloudRecommenderV1CostProjection `json:"costProjection,omitempty"`
	// ReliabilityProjection: Use with CategoryType.RELIABILITY
	ReliabilityProjection *GoogleCloudRecommenderV1ReliabilityProjection `json:"reliabilityProjection,omitempty"`
	// SecurityProjection: Use with CategoryType.SECURITY
	SecurityProjection *GoogleCloudRecommenderV1SecurityProjection `json:"securityProjection,omitempty"`
	// SustainabilityProjection: Use with CategoryType.SUSTAINABILITY
	SustainabilityProjection *GoogleCloudRecommenderV1SustainabilityProjection `json:"sustainabilityProjection,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Category") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Category") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1Impact: Contains the impact a recommendation can have for a given category.

func (GoogleCloudRecommenderV1Impact) MarshalJSON

func (s GoogleCloudRecommenderV1Impact) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1Insight added in v0.30.0

type GoogleCloudRecommenderV1Insight struct {
	// AssociatedRecommendations: Recommendations derived from this insight.
	AssociatedRecommendations []*GoogleCloudRecommenderV1InsightRecommendationReference `json:"associatedRecommendations,omitempty"`
	// Category: Category being targeted by the insight.
	//
	// Possible values:
	//   "CATEGORY_UNSPECIFIED" - Unspecified category.
	//   "COST" - The insight is related to cost.
	//   "SECURITY" - The insight is related to security.
	//   "PERFORMANCE" - The insight is related to performance.
	//   "MANAGEABILITY" - This insight is related to manageability.
	//   "SUSTAINABILITY" - The insight is related to sustainability.
	//   "RELIABILITY" - This insight is related to reliability.
	Category string `json:"category,omitempty"`
	// Content: A struct of custom fields to explain the insight. Example:
	// "grantedPermissionsCount": "1000"
	Content googleapi.RawMessage `json:"content,omitempty"`
	// Description: Free-form human readable summary in English. The maximum length
	// is 500 characters.
	Description string `json:"description,omitempty"`
	// Etag: Fingerprint of the Insight. Provides optimistic locking when updating
	// states.
	Etag string `json:"etag,omitempty"`
	// InsightSubtype: Insight subtype. Insight content schema will be stable for a
	// given subtype.
	InsightSubtype string `json:"insightSubtype,omitempty"`
	// LastRefreshTime: Timestamp of the latest data used to generate the insight.
	LastRefreshTime string `json:"lastRefreshTime,omitempty"`
	// Name: Identifier. Name of the insight.
	Name string `json:"name,omitempty"`
	// ObservationPeriod: Observation period that led to the insight. The source
	// data used to generate the insight ends at last_refresh_time and begins at
	// (last_refresh_time - observation_period).
	ObservationPeriod string `json:"observationPeriod,omitempty"`
	// Severity: Insight's severity.
	//
	// Possible values:
	//   "SEVERITY_UNSPECIFIED" - Insight has unspecified severity.
	//   "LOW" - Insight has low severity.
	//   "MEDIUM" - Insight has medium severity.
	//   "HIGH" - Insight has high severity.
	//   "CRITICAL" - Insight has critical severity.
	Severity string `json:"severity,omitempty"`
	// StateInfo: Information state and metadata.
	StateInfo *GoogleCloudRecommenderV1InsightStateInfo `json:"stateInfo,omitempty"`
	// TargetResources: Fully qualified resource names that this insight is
	// targeting.
	TargetResources []string `json:"targetResources,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AssociatedRecommendations")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AssociatedRecommendations") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1Insight) MarshalJSON added in v0.30.0

func (s GoogleCloudRecommenderV1Insight) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1InsightRecommendationReference added in v0.30.0

type GoogleCloudRecommenderV1InsightRecommendationReference struct {
	// Recommendation: Recommendation resource name, e.g.
	// projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/
	// recommendations/[RECOMMENDATION_ID]
	Recommendation string `json:"recommendation,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Recommendation") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Recommendation") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1InsightRecommendationReference: Reference to an associated recommendation.

func (GoogleCloudRecommenderV1InsightRecommendationReference) MarshalJSON added in v0.30.0

type GoogleCloudRecommenderV1InsightStateInfo added in v0.30.0

type GoogleCloudRecommenderV1InsightStateInfo struct {
	// State: Insight state.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Unspecified state.
	//   "ACTIVE" - Insight is active. Content for ACTIVE insights can be updated
	// by Google. ACTIVE insights can be marked DISMISSED OR ACCEPTED.
	//   "ACCEPTED" - Some action has been taken based on this insight. Insights
	// become accepted when a recommendation derived from the insight has been
	// marked CLAIMED, SUCCEEDED, or FAILED. ACTIVE insights can also be marked
	// ACCEPTED explicitly. Content for ACCEPTED insights is immutable. ACCEPTED
	// insights can only be marked ACCEPTED (which may update state metadata).
	//   "DISMISSED" - Insight is dismissed. Content for DISMISSED insights can be
	// updated by Google. DISMISSED insights can be marked as ACTIVE.
	State string `json:"state,omitempty"`
	// StateMetadata: A map of metadata for the state, provided by user or
	// automations systems.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1InsightStateInfo: Information related to insight state.

func (GoogleCloudRecommenderV1InsightStateInfo) MarshalJSON added in v0.30.0

type GoogleCloudRecommenderV1InsightTypeConfig added in v0.74.0

type GoogleCloudRecommenderV1InsightTypeConfig struct {
	// Annotations: Allows clients to store small amounts of arbitrary data.
	// Annotations must follow the Kubernetes syntax. The total size of all keys
	// and values combined is limited to 256k. Key can have 2 segments: prefix
	// (optional) and name (required), separated by a slash (/). Prefix must be a
	// DNS subdomain. Name must be 63 characters or less, begin and end with
	// alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics
	// between.
	Annotations map[string]string `json:"annotations,omitempty"`
	// DisplayName: A user-settable field to provide a human-readable name to be
	// used in user interfaces.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Fingerprint of the InsightTypeConfig. Provides optimistic locking when
	// updating.
	Etag string `json:"etag,omitempty"`
	// InsightTypeGenerationConfig: InsightTypeGenerationConfig which configures
	// the generation of insights for this insight type.
	InsightTypeGenerationConfig *GoogleCloudRecommenderV1InsightTypeGenerationConfig `json:"insightTypeGenerationConfig,omitempty"`
	// Name: Identifier. Name of insight type config. Eg,
	// projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
	// /config
	Name string `json:"name,omitempty"`
	// RevisionId: Output only. Immutable. The revision ID of the config. A new
	// revision is committed whenever the config is changed in any way. The format
	// is an 8-character hexadecimal string.
	RevisionId string `json:"revisionId,omitempty"`
	// UpdateTime: Last time when the config was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Annotations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1InsightTypeConfig: Configuration for an InsightType.

func (GoogleCloudRecommenderV1InsightTypeConfig) MarshalJSON added in v0.74.0

type GoogleCloudRecommenderV1InsightTypeGenerationConfig added in v0.74.0

type GoogleCloudRecommenderV1InsightTypeGenerationConfig struct {
	// Params: Parameters for this InsightTypeGenerationConfig. These configs can
	// be used by or are applied to all subtypes.
	Params googleapi.RawMessage `json:"params,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Params") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Params") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1InsightTypeGenerationConfig) MarshalJSON added in v0.74.0

type GoogleCloudRecommenderV1ListInsightsResponse added in v0.30.0

type GoogleCloudRecommenderV1ListInsightsResponse struct {
	// Insights: The set of insights for the `parent` resource.
	Insights []*GoogleCloudRecommenderV1Insight `json:"insights,omitempty"`
	// NextPageToken: A token that can be used to request the next page of results.
	// This field is empty if there are no additional results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Insights") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Insights") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1ListInsightsResponse: Response to the `ListInsights` method.

func (GoogleCloudRecommenderV1ListInsightsResponse) MarshalJSON added in v0.30.0

type GoogleCloudRecommenderV1ListRecommendationsResponse

type GoogleCloudRecommenderV1ListRecommendationsResponse struct {
	// NextPageToken: A token that can be used to request the next page of results.
	// This field is empty if there are no additional results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Recommendations: The set of recommendations for the `parent` resource.
	Recommendations []*GoogleCloudRecommenderV1Recommendation `json:"recommendations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1ListRecommendationsResponse: Response to the `ListRecommendations` method.

func (GoogleCloudRecommenderV1ListRecommendationsResponse) MarshalJSON

type GoogleCloudRecommenderV1MarkInsightAcceptedRequest added in v0.30.0

type GoogleCloudRecommenderV1MarkInsightAcceptedRequest struct {
	// Etag: Required. Fingerprint of the Insight. Provides optimistic locking.
	Etag string `json:"etag,omitempty"`
	// StateMetadata: Optional. State properties user wish to include with this
	// state. Full replace of the current state_metadata.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1MarkInsightAcceptedRequest: Request for the `MarkInsightAccepted` method.

func (GoogleCloudRecommenderV1MarkInsightAcceptedRequest) MarshalJSON added in v0.30.0

type GoogleCloudRecommenderV1MarkRecommendationClaimedRequest

type GoogleCloudRecommenderV1MarkRecommendationClaimedRequest struct {
	// Etag: Required. Fingerprint of the Recommendation. Provides optimistic
	// locking.
	Etag string `json:"etag,omitempty"`
	// StateMetadata: State properties to include with this state. Overwrites any
	// existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`.
	// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1MarkRecommendationClaimedRequest: Request for the `MarkRecommendationClaimed` Method.

func (GoogleCloudRecommenderV1MarkRecommendationClaimedRequest) MarshalJSON

type GoogleCloudRecommenderV1MarkRecommendationDismissedRequest added in v0.107.0

type GoogleCloudRecommenderV1MarkRecommendationDismissedRequest struct {
	// Etag: Fingerprint of the Recommendation. Provides optimistic locking.
	Etag string `json:"etag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1MarkRecommendationDismissedRequest: Request for the `MarkRecommendationDismissed` Method.

func (GoogleCloudRecommenderV1MarkRecommendationDismissedRequest) MarshalJSON added in v0.107.0

type GoogleCloudRecommenderV1MarkRecommendationFailedRequest

type GoogleCloudRecommenderV1MarkRecommendationFailedRequest struct {
	// Etag: Required. Fingerprint of the Recommendation. Provides optimistic
	// locking.
	Etag string `json:"etag,omitempty"`
	// StateMetadata: State properties to include with this state. Overwrites any
	// existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`.
	// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1MarkRecommendationFailedRequest: Request for the `MarkRecommendationFailed` Method.

func (GoogleCloudRecommenderV1MarkRecommendationFailedRequest) MarshalJSON

type GoogleCloudRecommenderV1MarkRecommendationSucceededRequest

type GoogleCloudRecommenderV1MarkRecommendationSucceededRequest struct {
	// Etag: Required. Fingerprint of the Recommendation. Provides optimistic
	// locking.
	Etag string `json:"etag,omitempty"`
	// StateMetadata: State properties to include with this state. Overwrites any
	// existing `state_metadata`. Keys must match the regex `/^a-z0-9{0,62}$/`.
	// Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1MarkRecommendationSucceededRequest: Request for the `MarkRecommendationSucceeded` Method.

func (GoogleCloudRecommenderV1MarkRecommendationSucceededRequest) MarshalJSON

type GoogleCloudRecommenderV1Operation

type GoogleCloudRecommenderV1Operation struct {
	// Action: Type of this operation. Contains one of 'add', 'remove', 'replace',
	// 'move', 'copy', 'test' and custom operations. This field is case-insensitive
	// and always populated.
	Action string `json:"action,omitempty"`
	// Path: Path to the target field being operated on. If the operation is at the
	// resource level, then path should be "/". This field is always populated.
	Path string `json:"path,omitempty"`
	// PathFilters: Set of filters to apply if `path` refers to array elements or
	// nested array elements in order to narrow down to a single unique element
	// that is being tested/modified. This is intended to be an exact match per
	// filter. To perform advanced matching, use path_value_matchers. * Example:
	// “` { "/versions/*/name" : "it-123" "/versions/*/targetSize/percent": 20 }
	// “` * Example: “` { "/bindings/*/role": "roles/owner"
	// "/bindings/*/condition" : null } “` * Example: “` { "/bindings/*/role":
	// "roles/owner" "/bindings/*/members/*" : ["x@example.com", "y@example.com"] }
	// “` When both path_filters and path_value_matchers are set, an implicit AND
	// must be performed.
	PathFilters googleapi.RawMessage `json:"pathFilters,omitempty"`
	// PathValueMatchers: Similar to path_filters, this contains set of filters to
	// apply if `path` field refers to array elements. This is meant to support
	// value matching beyond exact match. To perform exact match, use path_filters.
	// When both path_filters and path_value_matchers are set, an implicit AND must
	// be performed.
	PathValueMatchers map[string]GoogleCloudRecommenderV1ValueMatcher `json:"pathValueMatchers,omitempty"`
	// Resource: Contains the fully qualified resource name. This field is always
	// populated. ex: //cloudresourcemanager.googleapis.com/projects/foo.
	Resource string `json:"resource,omitempty"`
	// ResourceType: Type of GCP resource being modified/tested. This field is
	// always populated. Example: cloudresourcemanager.googleapis.com/Project,
	// compute.googleapis.com/Instance
	ResourceType string `json:"resourceType,omitempty"`
	// SourcePath: Can be set with action 'copy' or 'move' to indicate the source
	// field within resource or source_resource, ignored if provided for other
	// operation types.
	SourcePath string `json:"sourcePath,omitempty"`
	// SourceResource: Can be set with action 'copy' to copy resource configuration
	// across different resources of the same type. Example: A resource clone can
	// be done via action = 'copy', path = "/", from = "/", source_resource = and
	// resource_name = . This field is empty for all other values of `action`.
	SourceResource string `json:"sourceResource,omitempty"`
	// Value: Value for the `path` field. Will be set for actions:'add'/'replace'.
	// Maybe set for action: 'test'. Either this or `value_matcher` will be set for
	// 'test' operation. An exact match must be performed.
	Value interface{} `json:"value,omitempty"`
	// ValueMatcher: Can be set for action 'test' for advanced matching for the
	// value of 'path' field. Either this or `value` will be set for 'test'
	// operation.
	ValueMatcher *GoogleCloudRecommenderV1ValueMatcher `json:"valueMatcher,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Action") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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.

func (GoogleCloudRecommenderV1Operation) MarshalJSON

func (s GoogleCloudRecommenderV1Operation) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1OperationGroup

type GoogleCloudRecommenderV1OperationGroup struct {
	// Operations: List of operations across one or more resources that belong to
	// this group. Loosely based on RFC6902 and should be performed in the order
	// they appear.
	Operations []*GoogleCloudRecommenderV1Operation `json:"operations,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Operations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Operations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1OperationGroup: Group of operations that need to be performed atomically.

func (GoogleCloudRecommenderV1OperationGroup) MarshalJSON

func (s GoogleCloudRecommenderV1OperationGroup) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1Recommendation

type GoogleCloudRecommenderV1Recommendation struct {
	// AdditionalImpact: Optional set of additional impact that this recommendation
	// may have when trying to optimize for the primary category. These may be
	// positive or negative.
	AdditionalImpact []*GoogleCloudRecommenderV1Impact `json:"additionalImpact,omitempty"`
	// AssociatedInsights: Insights that led to this recommendation.
	AssociatedInsights []*GoogleCloudRecommenderV1RecommendationInsightReference `json:"associatedInsights,omitempty"`
	// Content: Content of the recommendation describing recommended changes to
	// resources.
	Content *GoogleCloudRecommenderV1RecommendationContent `json:"content,omitempty"`
	// Description: Free-form human readable summary in English. The maximum length
	// is 500 characters.
	Description string `json:"description,omitempty"`
	// Etag: Fingerprint of the Recommendation. Provides optimistic locking when
	// updating states.
	Etag string `json:"etag,omitempty"`
	// LastRefreshTime: Last time this recommendation was refreshed by the system
	// that created it in the first place.
	LastRefreshTime string `json:"lastRefreshTime,omitempty"`
	// Name: Identifier. Name of recommendation.
	Name string `json:"name,omitempty"`
	// PrimaryImpact: The primary impact that this recommendation can have while
	// trying to optimize for one category.
	PrimaryImpact *GoogleCloudRecommenderV1Impact `json:"primaryImpact,omitempty"`
	// Priority: Recommendation's priority.
	//
	// Possible values:
	//   "PRIORITY_UNSPECIFIED" - Recommendation has unspecified priority.
	//   "P4" - Recommendation has P4 priority (lowest priority).
	//   "P3" - Recommendation has P3 priority (second lowest priority).
	//   "P2" - Recommendation has P2 priority (second highest priority).
	//   "P1" - Recommendation has P1 priority (highest priority).
	Priority string `json:"priority,omitempty"`
	// RecommenderSubtype: Contains an identifier for a subtype of recommendations
	// produced for the same recommender. Subtype is a function of content and
	// impact, meaning a new subtype might be added when significant changes to
	// `content` or `primary_impact.category` are introduced. See the Recommenders
	// section to see a list of subtypes for a given Recommender. Examples: For
	// recommender = "google.iam.policy.Recommender", recommender_subtype can be
	// one of "REMOVE_ROLE"/"REPLACE_ROLE"
	RecommenderSubtype string `json:"recommenderSubtype,omitempty"`
	// StateInfo: Information for state. Contains state and metadata.
	StateInfo *GoogleCloudRecommenderV1RecommendationStateInfo `json:"stateInfo,omitempty"`
	// TargetResources: Fully qualified resource names that this recommendation is
	// targeting.
	TargetResources []string `json:"targetResources,omitempty"`
	// XorGroupId: Corresponds to a mutually exclusive group ID within a
	// recommender. A non-empty ID indicates that the recommendation belongs to a
	// mutually exclusive group. This means that only one recommendation within the
	// group is suggested to be applied.
	XorGroupId string `json:"xorGroupId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AdditionalImpact") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AdditionalImpact") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1Recommendation) MarshalJSON

func (s GoogleCloudRecommenderV1Recommendation) MarshalJSON() ([]byte, error)

type GoogleCloudRecommenderV1RecommendationContent

type GoogleCloudRecommenderV1RecommendationContent struct {
	// OperationGroups: Operations to one or more Google Cloud resources grouped in
	// such a way that, all operations within one group are expected to be
	// performed atomically and in an order.
	OperationGroups []*GoogleCloudRecommenderV1OperationGroup `json:"operationGroups,omitempty"`
	// Overview: Condensed overview information about the recommendation.
	Overview googleapi.RawMessage `json:"overview,omitempty"`
	// ForceSendFields is a list of field names (e.g. "OperationGroups") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "OperationGroups") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1RecommendationContent: Contains what resources are changing and how they are changing.

func (GoogleCloudRecommenderV1RecommendationContent) MarshalJSON

type GoogleCloudRecommenderV1RecommendationInsightReference added in v0.30.0

type GoogleCloudRecommenderV1RecommendationInsightReference struct {
	// Insight: Insight resource name, e.g.
	// projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
	// /insights/[INSIGHT_ID]
	Insight string `json:"insight,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Insight") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Insight") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1RecommendationInsightReference: Reference to an associated insight.

func (GoogleCloudRecommenderV1RecommendationInsightReference) MarshalJSON added in v0.30.0

type GoogleCloudRecommenderV1RecommendationStateInfo

type GoogleCloudRecommenderV1RecommendationStateInfo struct {
	// State: The state of the recommendation, Eg ACTIVE, SUCCEEDED, FAILED.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default state. Don't use directly.
	//   "ACTIVE" - Recommendation is active and can be applied. Recommendations
	// content can be updated by Google. ACTIVE recommendations can be marked as
	// CLAIMED, SUCCEEDED, or FAILED.
	//   "CLAIMED" - Recommendation is in claimed state. Recommendations content is
	// immutable and cannot be updated by Google. CLAIMED recommendations can be
	// marked as CLAIMED, SUCCEEDED, or FAILED.
	//   "SUCCEEDED" - Recommendation is in succeeded state. Recommendations
	// content is immutable and cannot be updated by Google. SUCCEEDED
	// recommendations can be marked as SUCCEEDED, or FAILED.
	//   "FAILED" - Recommendation is in failed state. Recommendations content is
	// immutable and cannot be updated by Google. FAILED recommendations can be
	// marked as SUCCEEDED, or FAILED.
	//   "DISMISSED" - Recommendation is in dismissed state. Recommendation content
	// can be updated by Google. DISMISSED recommendations can be marked as ACTIVE.
	State string `json:"state,omitempty"`
	// StateMetadata: A map of metadata for the state, provided by user or
	// automations systems.
	StateMetadata map[string]string `json:"stateMetadata,omitempty"`
	// ForceSendFields is a list of field names (e.g. "State") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "State") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1RecommendationStateInfo: Information for state. Contains state and metadata.

func (GoogleCloudRecommenderV1RecommendationStateInfo) MarshalJSON

type GoogleCloudRecommenderV1RecommenderConfig added in v0.74.0

type GoogleCloudRecommenderV1RecommenderConfig struct {
	// Annotations: Allows clients to store small amounts of arbitrary data.
	// Annotations must follow the Kubernetes syntax. The total size of all keys
	// and values combined is limited to 256k. Key can have 2 segments: prefix
	// (optional) and name (required), separated by a slash (/). Prefix must be a
	// DNS subdomain. Name must be 63 characters or less, begin and end with
	// alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics
	// between.
	Annotations map[string]string `json:"annotations,omitempty"`
	// DisplayName: A user-settable field to provide a human-readable name to be
	// used in user interfaces.
	DisplayName string `json:"displayName,omitempty"`
	// Etag: Fingerprint of the RecommenderConfig. Provides optimistic locking when
	// updating.
	Etag string `json:"etag,omitempty"`
	// Name: Identifier. Name of recommender config. Eg,
	// projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/
	// config
	Name string `json:"name,omitempty"`
	// RecommenderGenerationConfig: RecommenderGenerationConfig which configures
	// the Generation of recommendations for this recommender.
	RecommenderGenerationConfig *GoogleCloudRecommenderV1RecommenderGenerationConfig `json:"recommenderGenerationConfig,omitempty"`
	// RevisionId: Output only. Immutable. The revision ID of the config. A new
	// revision is committed whenever the config is changed in any way. The format
	// is an 8-character hexadecimal string.
	RevisionId string `json:"revisionId,omitempty"`
	// UpdateTime: Last time when the config was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Annotations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1RecommenderConfig: Configuration for a Recommender.

func (GoogleCloudRecommenderV1RecommenderConfig) MarshalJSON added in v0.74.0

type GoogleCloudRecommenderV1RecommenderGenerationConfig added in v0.74.0

type GoogleCloudRecommenderV1RecommenderGenerationConfig struct {
	// Params: Parameters for this RecommenderGenerationConfig. These configs can
	// be used by or are applied to all subtypes.
	Params googleapi.RawMessage `json:"params,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Params") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Params") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1RecommenderGenerationConfig) MarshalJSON added in v0.74.0

type GoogleCloudRecommenderV1ReliabilityProjection added in v0.99.0

type GoogleCloudRecommenderV1ReliabilityProjection struct {
	// Details: Per-recommender projection.
	Details googleapi.RawMessage `json:"details,omitempty"`
	// Risks: Reliability risks mitigated by this recommendation.
	//
	// Possible values:
	//   "RISK_TYPE_UNSPECIFIED" - Default unspecified risk. Don't use directly.
	//   "SERVICE_DISRUPTION" - Potential service downtime.
	//   "DATA_LOSS" - Potential data loss.
	//   "ACCESS_DENY" - Potential access denial. The service is still up but some
	// or all clients can't access it.
	Risks []string `json:"risks,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Details") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1ReliabilityProjection: Contains information on the impact of a reliability recommendation.

func (GoogleCloudRecommenderV1ReliabilityProjection) MarshalJSON added in v0.99.0

type GoogleCloudRecommenderV1SecurityProjection added in v0.47.0

type GoogleCloudRecommenderV1SecurityProjection struct {
	// Details: Additional security impact details that is provided by the
	// recommender.
	Details googleapi.RawMessage `json:"details,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Details") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Details") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleCloudRecommenderV1SecurityProjection: Contains various ways of describing the impact on Security.

func (GoogleCloudRecommenderV1SecurityProjection) MarshalJSON added in v0.47.0

type GoogleCloudRecommenderV1SustainabilityProjection added in v0.99.0

type GoogleCloudRecommenderV1SustainabilityProjection struct {
	// Duration: Duration for which this sustainability applies.
	Duration string `json:"duration,omitempty"`
	// KgCO2e: Carbon Footprint generated in kg of CO2 equivalent. Chose kg_c_o2e
	// so that the name renders correctly in camelCase (kgCO2e).
	KgCO2e float64 `json:"kgCO2e,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Duration") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Duration") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1SustainabilityProjection) MarshalJSON added in v0.99.0

func (*GoogleCloudRecommenderV1SustainabilityProjection) UnmarshalJSON added in v0.99.0

type GoogleCloudRecommenderV1ValueMatcher

type GoogleCloudRecommenderV1ValueMatcher struct {
	// MatchesPattern: To be used for full regex matching. The regular expression
	// is using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax),
	// so to be used with RE2::FullMatch
	MatchesPattern string `json:"matchesPattern,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MatchesPattern") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MatchesPattern") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (GoogleCloudRecommenderV1ValueMatcher) MarshalJSON

func (s GoogleCloudRecommenderV1ValueMatcher) MarshalJSON() ([]byte, error)

type GoogleTypeMoney

type GoogleTypeMoney struct {
	// CurrencyCode: The three-letter currency code defined in ISO 4217.
	CurrencyCode string `json:"currencyCode,omitempty"`
	// Nanos: Number of nano (10^-9) units of the amount. The value must be between
	// -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos`
	// must be positive or zero. If `units` is zero, `nanos` can be positive, zero,
	// or negative. If `units` is negative, `nanos` must be negative or zero. For
	// example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
	Nanos int64 `json:"nanos,omitempty"`
	// Units: The whole units of the amount. For example if `currencyCode` is
	// "USD", then 1 unit is one US dollar.
	Units int64 `json:"units,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "CurrencyCode") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CurrencyCode") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleTypeMoney: Represents an amount of money with its currency type.

func (GoogleTypeMoney) MarshalJSON

func (s GoogleTypeMoney) MarshalJSON() ([]byte, error)

type OrganizationsLocationsInsightTypesGetConfigCall added in v0.74.0

type OrganizationsLocationsInsightTypesGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsInsightTypesGetConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsInsightTypesGetConfigCall) Do added in v0.74.0

Do executes the "recommender.organizations.locations.insightTypes.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsInsightTypesGetConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsInsightTypesGetConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsInsightTypesGetConfigCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsLocationsInsightTypesInsightsGetCall added in v0.37.0

type OrganizationsLocationsInsightTypesInsightsGetCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsInsightTypesInsightsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsInsightTypesInsightsGetCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.insightTypes.insights.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsInsightTypesInsightsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsInsightTypesInsightsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsInsightTypesInsightsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsLocationsInsightTypesInsightsListCall added in v0.37.0

type OrganizationsLocationsInsightTypesInsightsListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsInsightTypesInsightsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsInsightTypesInsightsListCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.insightTypes.insights.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListInsightsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsInsightTypesInsightsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsInsightTypesInsightsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*OrganizationsLocationsInsightTypesInsightsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsInsightTypesInsightsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsLocationsInsightTypesInsightsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*OrganizationsLocationsInsightTypesInsightsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*OrganizationsLocationsInsightTypesInsightsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall added in v0.37.0

type OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.insightTypes.insights.markAccepted" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsInsightTypesInsightsMarkAcceptedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsLocationsInsightTypesInsightsService added in v0.37.0

type OrganizationsLocationsInsightTypesInsightsService struct {
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsInsightTypesInsightsService added in v0.37.0

func NewOrganizationsLocationsInsightTypesInsightsService(s *Service) *OrganizationsLocationsInsightTypesInsightsService

func (*OrganizationsLocationsInsightTypesInsightsService) Get added in v0.37.0

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

- name: Name of the insight.

func (*OrganizationsLocationsInsightTypesInsightsService) List added in v0.37.0

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

  • parent: 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/[IN SIGHT_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.

func (*OrganizationsLocationsInsightTypesInsightsService) MarkAccepted added in v0.37.0

MarkAccepted: 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.

- name: Name of the insight.

type OrganizationsLocationsInsightTypesService added in v0.37.0

type OrganizationsLocationsInsightTypesService struct {
	Insights *OrganizationsLocationsInsightTypesInsightsService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsInsightTypesService added in v0.37.0

func NewOrganizationsLocationsInsightTypesService(s *Service) *OrganizationsLocationsInsightTypesService

func (*OrganizationsLocationsInsightTypesService) GetConfig added in v0.74.0

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

  • name: 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/[IN SIGHT_TYPE_ID]/config`.

func (*OrganizationsLocationsInsightTypesService) UpdateConfig added in v0.74.0

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

  • name: Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_I D]/config.

type OrganizationsLocationsInsightTypesUpdateConfigCall added in v0.74.0

type OrganizationsLocationsInsightTypesUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) Do added in v0.74.0

Do executes the "recommender.organizations.locations.insightTypes.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) UpdateMask added in v0.74.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*OrganizationsLocationsInsightTypesUpdateConfigCall) ValidateOnly added in v0.74.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type OrganizationsLocationsRecommendersGetConfigCall added in v0.74.0

type OrganizationsLocationsRecommendersGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersGetConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersGetConfigCall) Do added in v0.74.0

Do executes the "recommender.organizations.locations.recommenders.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersGetConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersGetConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsRecommendersGetConfigCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsLocationsRecommendersRecommendationsGetCall added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsGetCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsGetCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsGetCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsGetCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsRecommendersRecommendationsGetCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OrganizationsLocationsRecommendersRecommendationsListCall added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListRecommendationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Filter added in v0.37.0

Filter sets the optional parameter "filter": Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) IfNoneMatch added in v0.37.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) PageSize added in v0.37.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) PageToken added in v0.37.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*OrganizationsLocationsRecommendersRecommendationsListCall) Pages added in v0.37.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.markClaimed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsMarkClaimedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall added in v0.107.0

type OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall) Context added in v0.107.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall) Do added in v0.107.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.markDismissed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall) Fields added in v0.107.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsMarkDismissedCall) Header added in v0.107.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsLocationsRecommendersRecommendationsMarkFailedCall added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsMarkFailedCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsMarkFailedCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsMarkFailedCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.markFailed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsMarkFailedCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsMarkFailedCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall) Context added in v0.37.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall) Do added in v0.37.0

Do executes the "recommender.organizations.locations.recommenders.recommendations.markSucceeded" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall) Fields added in v0.37.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersRecommendationsMarkSucceededCall) Header added in v0.37.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type OrganizationsLocationsRecommendersRecommendationsService added in v0.37.0

type OrganizationsLocationsRecommendersRecommendationsService struct {
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsRecommendersRecommendationsService added in v0.37.0

func NewOrganizationsLocationsRecommendersRecommendationsService(s *Service) *OrganizationsLocationsRecommendersRecommendationsService

func (*OrganizationsLocationsRecommendersRecommendationsService) Get added in v0.37.0

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

- name: Name of the recommendation.

func (*OrganizationsLocationsRecommendersRecommendationsService) List added in v0.37.0

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

  • parent: The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_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.

func (*OrganizationsLocationsRecommendersRecommendationsService) MarkClaimed added in v0.37.0

MarkClaimed: 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.

- name: Name of the recommendation.

func (*OrganizationsLocationsRecommendersRecommendationsService) MarkDismissed added in v0.107.0

MarkDismissed: 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.

- name: Name of the recommendation.

func (*OrganizationsLocationsRecommendersRecommendationsService) MarkFailed added in v0.37.0

MarkFailed: 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.

- name: Name of the recommendation.

func (*OrganizationsLocationsRecommendersRecommendationsService) MarkSucceeded added in v0.37.0

MarkSucceeded: 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.

- name: Name of the recommendation.

type OrganizationsLocationsRecommendersService added in v0.37.0

type OrganizationsLocationsRecommendersService struct {
	Recommendations *OrganizationsLocationsRecommendersRecommendationsService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsRecommendersService added in v0.37.0

func NewOrganizationsLocationsRecommendersService(s *Service) *OrganizationsLocationsRecommendersService

func (*OrganizationsLocationsRecommendersService) GetConfig added in v0.74.0

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

  • name: Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/c onfig` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]/config`.

func (*OrganizationsLocationsRecommendersService) UpdateConfig added in v0.74.0

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

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

type OrganizationsLocationsRecommendersUpdateConfigCall added in v0.74.0

type OrganizationsLocationsRecommendersUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsRecommendersUpdateConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsRecommendersUpdateConfigCall) Do added in v0.74.0

Do executes the "recommender.organizations.locations.recommenders.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsRecommendersUpdateConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsRecommendersUpdateConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsRecommendersUpdateConfigCall) UpdateMask added in v0.74.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*OrganizationsLocationsRecommendersUpdateConfigCall) ValidateOnly added in v0.74.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type OrganizationsLocationsService added in v0.37.0

type OrganizationsLocationsService struct {
	InsightTypes *OrganizationsLocationsInsightTypesService

	Recommenders *OrganizationsLocationsRecommendersService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsService added in v0.37.0

func NewOrganizationsLocationsService(s *Service) *OrganizationsLocationsService

type OrganizationsService added in v0.37.0

type OrganizationsService struct {
	Locations *OrganizationsLocationsService
	// contains filtered or unexported fields
}

func NewOrganizationsService added in v0.37.0

func NewOrganizationsService(s *Service) *OrganizationsService

type ProjectsLocationsInsightTypesGetConfigCall added in v0.74.0

type ProjectsLocationsInsightTypesGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightTypesGetConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightTypesGetConfigCall) Do added in v0.74.0

Do executes the "recommender.projects.locations.insightTypes.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightTypesGetConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightTypesGetConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInsightTypesGetConfigCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInsightTypesInsightsGetCall added in v0.30.0

type ProjectsLocationsInsightTypesInsightsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightTypesInsightsGetCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightTypesInsightsGetCall) Do added in v0.30.0

Do executes the "recommender.projects.locations.insightTypes.insights.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightTypesInsightsGetCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightTypesInsightsGetCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInsightTypesInsightsGetCall) IfNoneMatch added in v0.30.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsInsightTypesInsightsListCall added in v0.30.0

type ProjectsLocationsInsightTypesInsightsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightTypesInsightsListCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightTypesInsightsListCall) Do added in v0.30.0

Do executes the "recommender.projects.locations.insightTypes.insights.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListInsightsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightTypesInsightsListCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightTypesInsightsListCall) Filter added in v0.30.0

Filter sets the optional parameter "filter": Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*ProjectsLocationsInsightTypesInsightsListCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInsightTypesInsightsListCall) IfNoneMatch added in v0.30.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsInsightTypesInsightsListCall) PageSize added in v0.30.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*ProjectsLocationsInsightTypesInsightsListCall) PageToken added in v0.30.0

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*ProjectsLocationsInsightTypesInsightsListCall) Pages added in v0.30.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsInsightTypesInsightsMarkAcceptedCall added in v0.30.0

type ProjectsLocationsInsightTypesInsightsMarkAcceptedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightTypesInsightsMarkAcceptedCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightTypesInsightsMarkAcceptedCall) Do added in v0.30.0

Do executes the "recommender.projects.locations.insightTypes.insights.markAccepted" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Insight.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightTypesInsightsMarkAcceptedCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightTypesInsightsMarkAcceptedCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsInsightTypesInsightsService added in v0.30.0

type ProjectsLocationsInsightTypesInsightsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsInsightTypesInsightsService added in v0.30.0

func NewProjectsLocationsInsightTypesInsightsService(s *Service) *ProjectsLocationsInsightTypesInsightsService

func (*ProjectsLocationsInsightTypesInsightsService) Get added in v0.30.0

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

- name: Name of the insight.

func (*ProjectsLocationsInsightTypesInsightsService) List added in v0.30.0

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

  • parent: 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/[IN SIGHT_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.

func (*ProjectsLocationsInsightTypesInsightsService) MarkAccepted added in v0.30.0

MarkAccepted: 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.

- name: Name of the insight.

type ProjectsLocationsInsightTypesService added in v0.30.0

type ProjectsLocationsInsightTypesService struct {
	Insights *ProjectsLocationsInsightTypesInsightsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsInsightTypesService added in v0.30.0

func NewProjectsLocationsInsightTypesService(s *Service) *ProjectsLocationsInsightTypesService

func (*ProjectsLocationsInsightTypesService) GetConfig added in v0.74.0

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

  • name: 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/[IN SIGHT_TYPE_ID]/config`.

func (*ProjectsLocationsInsightTypesService) UpdateConfig added in v0.74.0

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

  • name: Identifier. Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_I D]/config.

type ProjectsLocationsInsightTypesUpdateConfigCall added in v0.74.0

type ProjectsLocationsInsightTypesUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsInsightTypesUpdateConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsInsightTypesUpdateConfigCall) Do added in v0.74.0

Do executes the "recommender.projects.locations.insightTypes.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1InsightTypeConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsInsightTypesUpdateConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsInsightTypesUpdateConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsInsightTypesUpdateConfigCall) UpdateMask added in v0.74.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*ProjectsLocationsInsightTypesUpdateConfigCall) ValidateOnly added in v0.74.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type ProjectsLocationsRecommendersGetConfigCall added in v0.74.0

type ProjectsLocationsRecommendersGetConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersGetConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersGetConfigCall) Do added in v0.74.0

Do executes the "recommender.projects.locations.recommenders.getConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersGetConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersGetConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsRecommendersGetConfigCall) IfNoneMatch added in v0.74.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsRecommendersRecommendationsGetCall

type ProjectsLocationsRecommendersRecommendationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsGetCall) Do

Do executes the "recommender.projects.locations.recommenders.recommendations.get" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsRecommendersRecommendationsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsRecommendersRecommendationsListCall

type ProjectsLocationsRecommendersRecommendationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsListCall) Do

Do executes the "recommender.projects.locations.recommenders.recommendations.list" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1ListRecommendationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsListCall) Filter

Filter sets the optional parameter "filter": Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` * `targetResources` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `targetResources : //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance -1` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` The max allowed filter length is 500 characters. (These expressions are based on the filter language described at https://google.aip.dev/160)

func (*ProjectsLocationsRecommendersRecommendationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsRecommendersRecommendationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsRecommendersRecommendationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.

func (*ProjectsLocationsRecommendersRecommendationsListCall) PageToken

PageToken sets the optional parameter "pageToken": If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.

func (*ProjectsLocationsRecommendersRecommendationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsRecommendersRecommendationsMarkClaimedCall

type ProjectsLocationsRecommendersRecommendationsMarkClaimedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsMarkClaimedCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsMarkClaimedCall) Do

Do executes the "recommender.projects.locations.recommenders.recommendations.markClaimed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsMarkClaimedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsMarkClaimedCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsRecommendersRecommendationsMarkDismissedCall added in v0.107.0

type ProjectsLocationsRecommendersRecommendationsMarkDismissedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsMarkDismissedCall) Context added in v0.107.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsMarkDismissedCall) Do added in v0.107.0

Do executes the "recommender.projects.locations.recommenders.recommendations.markDismissed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsMarkDismissedCall) Fields added in v0.107.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsMarkDismissedCall) Header added in v0.107.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsRecommendersRecommendationsMarkFailedCall

type ProjectsLocationsRecommendersRecommendationsMarkFailedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsMarkFailedCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsMarkFailedCall) Do

Do executes the "recommender.projects.locations.recommenders.recommendations.markFailed" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsMarkFailedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsMarkFailedCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsRecommendersRecommendationsMarkSucceededCall

type ProjectsLocationsRecommendersRecommendationsMarkSucceededCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsMarkSucceededCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersRecommendationsMarkSucceededCall) Do

Do executes the "recommender.projects.locations.recommenders.recommendations.markSucceeded" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1Recommendation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersRecommendationsMarkSucceededCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersRecommendationsMarkSucceededCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsRecommendersRecommendationsService

type ProjectsLocationsRecommendersRecommendationsService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersRecommendationsService) Get

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

- name: Name of the recommendation.

func (*ProjectsLocationsRecommendersRecommendationsService) List

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

  • parent: The container resource on which to execute the request. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]` * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_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.

func (*ProjectsLocationsRecommendersRecommendationsService) MarkClaimed

MarkClaimed: 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.

- name: Name of the recommendation.

func (*ProjectsLocationsRecommendersRecommendationsService) MarkDismissed added in v0.107.0

MarkDismissed: 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.

- name: Name of the recommendation.

func (*ProjectsLocationsRecommendersRecommendationsService) MarkFailed

MarkFailed: 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.

- name: Name of the recommendation.

func (*ProjectsLocationsRecommendersRecommendationsService) MarkSucceeded

MarkSucceeded: 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.

- name: Name of the recommendation.

type ProjectsLocationsRecommendersService

type ProjectsLocationsRecommendersService struct {
	Recommendations *ProjectsLocationsRecommendersRecommendationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsRecommendersService

func NewProjectsLocationsRecommendersService(s *Service) *ProjectsLocationsRecommendersService

func (*ProjectsLocationsRecommendersService) GetConfig added in v0.74.0

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

  • name: Name of the Recommendation Config to get. Acceptable formats: * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_I D]/config` * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/c onfig` * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMME NDER_ID]/config` * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RE COMMENDER_ID]/config`.

func (*ProjectsLocationsRecommendersService) UpdateConfig added in v0.74.0

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

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

type ProjectsLocationsRecommendersUpdateConfigCall added in v0.74.0

type ProjectsLocationsRecommendersUpdateConfigCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsRecommendersUpdateConfigCall) Context added in v0.74.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsRecommendersUpdateConfigCall) Do added in v0.74.0

Do executes the "recommender.projects.locations.recommenders.updateConfig" call. Any non-2xx status code is an error. Response headers are in either *GoogleCloudRecommenderV1RecommenderConfig.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsRecommendersUpdateConfigCall) Fields added in v0.74.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsRecommendersUpdateConfigCall) Header added in v0.74.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsRecommendersUpdateConfigCall) UpdateMask added in v0.74.0

UpdateMask sets the optional parameter "updateMask": The list of fields to be updated.

func (*ProjectsLocationsRecommendersUpdateConfigCall) ValidateOnly added in v0.74.0

ValidateOnly sets the optional parameter "validateOnly": If true, validate the request and preview the change, but do not actually update it.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	InsightTypes *ProjectsLocationsInsightTypesService

	Recommenders *ProjectsLocationsRecommendersService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	BillingAccounts *BillingAccountsService

	Folders *FoldersService

	Organizations *OrganizationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL