Class FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Recommender.v1
Assembly: Google.Apis.Recommender.v1.dll
Syntax
public class FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest : RecommenderBaseServiceRequest<GoogleCloudRecommenderV1ListRecommendationsResponse>, IClientServiceRequest<GoogleCloudRecommenderV1ListRecommendationsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
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)
Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
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.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
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.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()