public sealed class ListRecommendationsRequest : IPageRequest, IMessage<ListRecommendationsRequest>, IEquatable<ListRecommendationsRequest>, IDeepCloneable<ListRecommendationsRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Recommender v1 API class ListRecommendationsRequest.
Request for the ListRecommendations
method.
Implements
IPageRequest, IMessageListRecommendationsRequest, IEquatableListRecommendationsRequest, IDeepCloneableListRecommendationsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.Recommender.V1Assembly
Google.Cloud.Recommender.V1.dll
Constructors
ListRecommendationsRequest()
public ListRecommendationsRequest()
ListRecommendationsRequest(ListRecommendationsRequest)
public ListRecommendationsRequest(ListRecommendationsRequest other)
Parameter | |
---|---|
Name | Description |
other | ListRecommendationsRequest |
Properties
Filter
public string Filter { get; set; }
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)
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Optional. 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.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
Optional. 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.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
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.
Property Value | |
---|---|
Type | Description |
string |
ParentAsRecommenderName
public RecommenderName ParentAsRecommenderName { get; set; }
RecommenderName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
RecommenderName |