Class SummarizeIntelligenceFindingsRequest (2.69.0)

public final class SummarizeIntelligenceFindingsRequest extends GeneratedMessage implements SummarizeIntelligenceFindingsRequestOrBuilder

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

Protobuf type google.storage.control.v2.SummarizeIntelligenceFindingsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SummarizeIntelligenceFindingsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_SCOPE_FIELD_NUMBER

public static final int RESOURCE_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SummarizeIntelligenceFindingsRequest getDefaultInstance()
Returns
Type Description
SummarizeIntelligenceFindingsRequest

getDescriptor()

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

newBuilder()

public static SummarizeIntelligenceFindingsRequest.Builder newBuilder()
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

newBuilder(SummarizeIntelligenceFindingsRequest prototype)

public static SummarizeIntelligenceFindingsRequest.Builder newBuilder(SummarizeIntelligenceFindingsRequest prototype)
Parameter
Name Description
prototype SummarizeIntelligenceFindingsRequest
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SummarizeIntelligenceFindingsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SummarizeIntelligenceFindingsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SummarizeIntelligenceFindingsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SummarizeIntelligenceFindingsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SummarizeIntelligenceFindingsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SummarizeIntelligenceFindingsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SummarizeIntelligenceFindingsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SummarizeIntelligenceFindingsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SummarizeIntelligenceFindingsRequest> parser()
Returns
Type Description
Parser<SummarizeIntelligenceFindingsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SummarizeIntelligenceFindingsRequest getDefaultInstanceForType()
Returns
Type Description
SummarizeIntelligenceFindingsRequest

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.

getParserForType()

public Parser<SummarizeIntelligenceFindingsRequest> getParserForType()
Returns
Type Description
Parser<SummarizeIntelligenceFindingsRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SummarizeIntelligenceFindingsRequest.Builder newBuilderForType()
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SummarizeIntelligenceFindingsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder
Overrides

toBuilder()

public SummarizeIntelligenceFindingsRequest.Builder toBuilder()
Returns
Type Description
SummarizeIntelligenceFindingsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException