com.google.cloud.recommender.v1

Interface ListInsightsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListInsightsRequest, ListInsightsRequest.Builder

public interface ListInsightsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

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

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageSize.

getPageToken

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

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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.
 

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 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)
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 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)
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.