Interface SummarizeIntelligenceFindingsRequestOrBuilder (2.69.0)

public interface SummarizeIntelligenceFindingsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Optional. The filter expression, following AIP-160. Supports filtering by FindingType.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. The filter expression, following AIP-160. Supports filtering by FindingType.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of findings to return.

The maximum value is 100; values above 100 will be coerced to 100. The default value is 100.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. A page token, received from a previous SummarizeIntelligenceFindings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SummarizeIntelligenceFindings must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

Optional. A page token, received from a previous SummarizeIntelligenceFindings call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SummarizeIntelligenceFindings must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The scope to summarize the findings for. Format:

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The scope to summarize the findings for. Format:

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getResourceScope()

public abstract SummarizeIntelligenceFindingsRequest.ResourceScope getResourceScope()

Optional. Determines the granularity of the findings when the parent is an organization or folder.

  • PARENT (or not set): A single summary is returned for each insight type, aggregated across the entire parent scope.
  • PROJECT: A separate summary is returned for each insight type for every project within the parent scope.

    The only supported values are PARENT and PROJECT. If no value is specified, the API behaviour defaults to the PARENT.

.google.storage.control.v2.SummarizeIntelligenceFindingsRequest.ResourceScope resource_scope = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SummarizeIntelligenceFindingsRequest.ResourceScope

The resourceScope.

getResourceScopeValue()

public abstract int getResourceScopeValue()

Optional. Determines the granularity of the findings when the parent is an organization or folder.

  • PARENT (or not set): A single summary is returned for each insight type, aggregated across the entire parent scope.
  • PROJECT: A separate summary is returned for each insight type for every project within the parent scope.

    The only supported values are PARENT and PROJECT. If no value is specified, the API behaviour defaults to the PARENT.

.google.storage.control.v2.SummarizeIntelligenceFindingsRequest.ResourceScope resource_scope = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for resourceScope.