Class: Google::Cloud::Recommender::V1::ListInsightsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommender/v1/recommender_service.rb

Overview

Request for the ListInsights method.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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)



85
86
87
88
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 85

class ListInsightsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



85
86
87
88
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 85

class ListInsightsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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.



85
86
87
88
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 85

class ListInsightsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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.



85
86
87
88
 
# File 'proto_docs/google/cloud/recommender/v1/recommender_service.rb', line 85

class ListInsightsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end