target.apidocs.com.google.api.services.recommender.v1.Recommender.BillingAccounts.Locations.Recommenders.Recommendations.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-recommender Show documentation

The newest version!







Recommender.BillingAccounts.Locations.Recommenders.Recommendations (Recommender API v1-rev20240428-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.recommender.v1
Class Recommender.BillingAccounts.Locations.Recommenders.Recommendations



java.lang.Object


com.google.api.services.recommender.v1.Recommender.BillingAccounts.Locations.Recommenders.Recommendations







Enclosing class:
Recommender.BillingAccounts.Locations.Recommenders




public class Recommender.BillingAccounts.Locations.Recommenders.Recommendations
extends Object
The "recommendations" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.Get 


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.List 


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkClaimed 


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkDismissed 


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkFailed 


class 
Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkSucceeded 









Constructor Summary

Constructors 

Constructor and Description


Recommendations() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Recommender.BillingAccounts.Locations.Recommenders.Recommendations.Get
get(String name)
Gets the requested recommendation.



Recommender.BillingAccounts.Locations.Recommenders.Recommendations.List
list(String parent)
Lists recommendations for the specified Cloud Resource.



Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkClaimed
markClaimed(String name,
           GoogleCloudRecommenderV1MarkRecommendationClaimedRequest content)
Marks the Recommendation State as Claimed.



Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkDismissed
markDismissed(String name,
             GoogleCloudRecommenderV1MarkRecommendationDismissedRequest content)
Mark the Recommendation State as Dismissed.



Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkFailed
markFailed(String name,
          GoogleCloudRecommenderV1MarkRecommendationFailedRequest content)
Marks the Recommendation State as Failed.



Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkSucceeded
markSucceeded(String name,
             GoogleCloudRecommenderV1MarkRecommendationSucceededRequest content)
Marks the Recommendation State as Succeeded.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Recommendations
public Recommendations()









Method Detail





get
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.Get get(String name)
                                                                           throws IOException
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the
 specified recommender.

 Create a request for the method "recommendations.get".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the recommendation.
Returns:
the request
Throws:
IOException








list
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.List list(String parent)
                                                                             throws IOException
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM
 permission for the specified recommender.

 Create a request for the method "recommendations.list".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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








markClaimed
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkClaimed markClaimed(String name,
                                                                                                  GoogleCloudRecommenderV1MarkRecommendationClaimedRequest content)
                                                                                           throws IOException
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.

 Create a request for the method "recommendations.markClaimed".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the recommendation.
content - the GoogleCloudRecommenderV1MarkRecommendationClaimedRequest
Returns:
the request
Throws:
IOException








markDismissed
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkDismissed markDismissed(String name,
                                                                                                      GoogleCloudRecommenderV1MarkRecommendationDismissedRequest content)
                                                                                               throws IOException
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.

 Create a request for the method "recommendations.markDismissed".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the recommendation.
content - the GoogleCloudRecommenderV1MarkRecommendationDismissedRequest
Returns:
the request
Throws:
IOException








markFailed
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkFailed markFailed(String name,
                                                                                                GoogleCloudRecommenderV1MarkRecommendationFailedRequest content)
                                                                                         throws IOException
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.

 Create a request for the method "recommendations.markFailed".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the recommendation.
content - the GoogleCloudRecommenderV1MarkRecommendationFailedRequest
Returns:
the request
Throws:
IOException








markSucceeded
public Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkSucceeded markSucceeded(String name,
                                                                                                      GoogleCloudRecommenderV1MarkRecommendationSucceededRequest content)
                                                                                               throws IOException
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.

 Create a request for the method "recommendations.markSucceeded".

 This request holds the parameters needed by the recommender server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. Name of the recommendation.
content - the GoogleCloudRecommenderV1MarkRecommendationSucceededRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.Get`
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.List`
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkClaimed`
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkDismissed`
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkFailed`
`class`	`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkSucceeded`

Modifier and Type	Method and Description
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.Get`	`get(String name)` Gets the requested recommendation.
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.List`	`list(String parent)` Lists recommendations for the specified Cloud Resource.
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkClaimed`	`markClaimed(String name, GoogleCloudRecommenderV1MarkRecommendationClaimedRequest content)` Marks the Recommendation State as Claimed.
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkDismissed`	`markDismissed(String name, GoogleCloudRecommenderV1MarkRecommendationDismissedRequest content)` Mark the Recommendation State as Dismissed.
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkFailed`	`markFailed(String name, GoogleCloudRecommenderV1MarkRecommendationFailedRequest content)` Marks the Recommendation State as Failed.
`Recommender.BillingAccounts.Locations.Recommenders.Recommendations.MarkSucceeded`	`markSucceeded(String name, GoogleCloudRecommenderV1MarkRecommendationSucceededRequest content)` Marks the Recommendation State as Succeeded.