Recommender V1 API - Class Google::Cloud::Recommender::V1::ListInsightsRequest (v1.4.1)

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

deffilter()->::String
Returns
  • (::String) — Optional. 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)

#filter=

deffilter=(value)->::String
Parameter
  • value (::String) — Optional. 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)

Returns
  • (::String) — Optional. 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)

#page_size

defpage_size()->::Integer
Returns
  • (::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=

defpage_size=(value)->::Integer
Parameter
  • 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.
Returns
  • (::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

defpage_token()->::String
Returns
  • (::String) — 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.

#page_token=

defpage_token=(value)->::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#parent

defparent()->::String
Returns
  • (::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=

defparent=(value)->::String
Parameter
  • 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.

Returns
  • (::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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.