Class ListInsightsRequest.Builder (2.9.0)

public static final class ListInsightsRequest.Builder extends GeneratedMessageV3.Builder<ListInsightsRequest.Builder> implements ListInsightsRequestOrBuilder

Request for the ListInsights method.

Protobuf type google.cloud.recommender.v1beta1.ListInsightsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListInsightsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

build()

public ListInsightsRequest build()
Returns
TypeDescription
ListInsightsRequest

buildPartial()

public ListInsightsRequest buildPartial()
Returns
TypeDescription
ListInsightsRequest

clear()

public ListInsightsRequest.Builder clear()
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInsightsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

clearFilter()

public ListInsightsRequest.Builder clearFilter()

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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInsightsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

clearPageSize()

public ListInsightsRequest.Builder clearPageSize()

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
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

clearPageToken()

public ListInsightsRequest.Builder clearPageToken()

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
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

clearParent()

public ListInsightsRequest.Builder clearParent()

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
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

clone()

public ListInsightsRequest.Builder clone()
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListInsightsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListInsightsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String 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)

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

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public 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
TypeDescription
int

The pageSize.

getPageToken()

public 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
TypeDescription
String

The pageToken.

getPageTokenBytes()

public 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
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListInsightsRequest other)

public ListInsightsRequest.Builder mergeFrom(ListInsightsRequest other)
Parameter
NameDescription
otherListInsightsRequest
Returns
TypeDescription
ListInsightsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInsightsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListInsightsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInsightsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListInsightsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

setFilter(String value)

public ListInsightsRequest.Builder setFilter(String value)

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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListInsightsRequest.Builder setFilterBytes(ByteString value)

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 filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListInsightsRequest.Builder setPageSize(int value)

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];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInsightsRequest.Builder setPageToken(String value)

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];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInsightsRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setParent(String value)

public ListInsightsRequest.Builder setParent(String value)

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) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListInsightsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListInsightsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListInsightsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInsightsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInsightsRequest.Builder
Overrides