Google Cloud Storage Control V2 Client - Class SummarizeIntelligenceFindingsRequest (1.9.0)

Reference documentation and code samples for the Google Cloud Storage Control V2 Client class SummarizeIntelligenceFindingsRequest.

Request message to summarize the intelligence findings for the specified scope(org, folder or project).

Generated from protobuf message google.storage.control.v2.SummarizeIntelligenceFindingsRequest

Namespace

Google \ Cloud \ Storage \ Control \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The scope to summarize the findings for. Format: - organizations/{organization}/locations/{location} - folders/{folder}/locations/{location} - projects/{project}/locations/{location}
↳ resource_scope int

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.
↳ filter string

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

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.
↳ page_token string

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.

getParent

Required. The scope to summarize the findings for.

Format:

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location}
Returns
Type Description
string

setParent

Required. The scope to summarize the findings for.

Format:

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location}
Parameter
Name Description
var string
Returns
Type Description
$this

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.
Returns
Type Description
int Enum of type ResourceScope.

setResourceScope

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.
Parameter
Name Description
var int

Enum of type ResourceScope.

Returns
Type Description
$this

getFilter

Optional. The filter expression, following AIP-160.

Supports filtering by FindingType.

Returns
Type Description
string

setFilter

Optional. The filter expression, following AIP-160.

Supports filtering by FindingType.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

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

  • organizations/{organization}/locations/{location}
  • folders/{folder}/locations/{location}
  • projects/{project}/locations/{location}
Returns
Type Description
SummarizeIntelligenceFindingsRequest