Class SummarizeIntelligenceFindingsRequest.Builder (2.69.0)

public static final class SummarizeIntelligenceFindingsRequest.Builder extends GeneratedMessage.Builder<SummarizeIntelligenceFindingsRequest.Builder> implements SummarizeIntelligenceFindingsRequestOrBuilder

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

Protobuf type google.storage.control.v2.SummarizeIntelligenceFindingsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SummarizeIntelligenceFindingsRequest build()
Returns
Type Description
SummarizeIntelligenceFindingsRequest

buildPartial()

public SummarizeIntelligenceFindingsRequest buildPartial()
Returns
Type Description
SummarizeIntelligenceFindingsRequest

clear()

public SummarizeIntelligenceFindingsRequest.Builder clear()
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder
Overrides

clearFilter()

public SummarizeIntelligenceFindingsRequest.Builder clearFilter()

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

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

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

clearPageSize()

public SummarizeIntelligenceFindingsRequest.Builder clearPageSize()

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

This builder for chaining.

clearPageToken()

public SummarizeIntelligenceFindingsRequest.Builder clearPageToken()

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

This builder for chaining.

clearParent()

public SummarizeIntelligenceFindingsRequest.Builder clearParent()

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

This builder for chaining.

clearResourceScope()

public SummarizeIntelligenceFindingsRequest.Builder clearResourceScope()

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

This builder for chaining.

getDefaultInstanceForType()

public SummarizeIntelligenceFindingsRequest getDefaultInstanceForType()
Returns
Type Description
SummarizeIntelligenceFindingsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SummarizeIntelligenceFindingsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SummarizeIntelligenceFindingsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder
Overrides

mergeFrom(SummarizeIntelligenceFindingsRequest other)

public SummarizeIntelligenceFindingsRequest.Builder mergeFrom(SummarizeIntelligenceFindingsRequest other)
Parameter
Name Description
other SummarizeIntelligenceFindingsRequest
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

setFilter(String value)

public SummarizeIntelligenceFindingsRequest.Builder setFilter(String value)

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

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SummarizeIntelligenceFindingsRequest.Builder setFilterBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setPageSize(int value)

public SummarizeIntelligenceFindingsRequest.Builder setPageSize(int value)

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SummarizeIntelligenceFindingsRequest.Builder setPageToken(String value)

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SummarizeIntelligenceFindingsRequest.Builder setPageTokenBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setParent(String value)

public SummarizeIntelligenceFindingsRequest.Builder setParent(String value)

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SummarizeIntelligenceFindingsRequest.Builder setParentBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setResourceScope(SummarizeIntelligenceFindingsRequest.ResourceScope value)

public SummarizeIntelligenceFindingsRequest.Builder setResourceScope(SummarizeIntelligenceFindingsRequest.ResourceScope value)

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

Parameter
Name Description
value SummarizeIntelligenceFindingsRequest.ResourceScope

The resourceScope to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.

setResourceScopeValue(int value)

public SummarizeIntelligenceFindingsRequest.Builder setResourceScopeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for resourceScope to set.

Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

This builder for chaining.