Reference documentation and code samples for the Recommender V1 API class Google::Cloud::Recommender::V1::ListInsightsRequest.
Request for the ListInsights method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String- 
        (::String) — Optional. Filter expression to restrict the insights returned. Supported
filter fields:- stateInfo.state
- insightSubtype
- severity
 Examples: - stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
- insightSubtype = PERMISSIONS_USAGE
- severity = CRITICAL OR severity = HIGH
- stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)
 (These expressions are based on the filter language described at https://google.aip.dev/160) 
#filter=
def filter=(value) -> ::String- 
        value (::String) — Optional. Filter expression to restrict the insights returned. Supported
filter fields:- stateInfo.state
- insightSubtype
- severity
 Examples: - stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
- insightSubtype = PERMISSIONS_USAGE
- severity = CRITICAL OR severity = HIGH
- stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)
 (These expressions are based on the filter language described at https://google.aip.dev/160) 
- 
        (::String) — Optional. Filter expression to restrict the insights returned. Supported
filter fields:- stateInfo.state
- insightSubtype
- severity
 Examples: - stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED
- insightSubtype = PERMISSIONS_USAGE
- severity = CRITICAL OR severity = HIGH
- stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)
 (These expressions are based on the filter language described at https://google.aip.dev/160) 
#page_size
def page_size() -> ::Integer- (::Integer) — 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.
#page_size=
def page_size=(value) -> ::Integer- value (::Integer) — 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.
- (::Integer) — 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.
#page_token
def page_token() -> ::String- 
        (::String) — Optional. If present, retrieves the next batch of results from the preceding call to
this method. page_tokenmust be the value ofnext_page_tokenfrom the previous response. The values of other method parameters must be identical to those in the previous call.
#page_token=
def page_token=(value) -> ::String- 
        value (::String) — Optional. If present, retrieves the next batch of results from the preceding call to
this method. page_tokenmust be the value ofnext_page_tokenfrom the previous response. The values of other method parameters must be identical to those in the previous call.
- 
        (::String) — Optional. If present, retrieves the next batch of results from the preceding call to
this method. page_tokenmust be the value ofnext_page_tokenfrom the previous response. The values of other method parameters must be identical to those in the previous call.
#parent
def parent() -> ::String- 
        (::String) — Required. The container resource on which to execute the request.
Acceptable formats:- projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
 LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. 
#parent=
def parent=(value) -> ::String- 
        value (::String) — Required. The container resource on which to execute the request.
Acceptable formats:- projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
 LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. 
- 
        (::String) — Required. The container resource on which to execute the request.
Acceptable formats:- projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
- organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]
 LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types.