Console
    Contact Us Start free

    Recommender V1 Client - Class ListInsightsRequest (1.7.8)

    Reference documentation and code samples for the Recommender V1 Client class ListInsightsRequest.

    Request for the ListInsights method.

    Generated from protobuf message google.cloud.recommender.v1.ListInsightsRequest

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    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 .

    ↳ page_size
    int

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

    ↳ filter
    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 )

    getParent

    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
    Type
    Description
    string

    setParent

    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 .
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    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
    Type
    Description
    int

    setPageSize

    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.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    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
    Type
    Description
    string

    setPageToken

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    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 )
    Returns
    Type
    Description
    string

    setFilter

    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 )
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: