Class TitleAggregation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TitleAggregation.Builder,
TitleAggregation>
The details that define an aggregation based on finding title.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic TitleAggregation.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final AggregationFindingType
The type of finding to aggregate on.final String
The type of finding to aggregate on.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Titles property.final boolean
For responses, this returns true if the service returned a value for the VulnerabilityIds property.final AggregationResourceType
The resource type to aggregate on.final String
The resource type to aggregate on.static Class
<? extends TitleAggregation.Builder> final TitleSortBy
sortBy()
The value to sort results by.final String
The value to sort results by.final SortOrder
The order to sort results by.final String
The order to sort results by.final List
<StringFilter> titles()
The finding titles to aggregate on.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final List
<StringFilter> The vulnerability IDs of the findings.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
findingType
The type of finding to aggregate on.
If the service returns an enum value that is not available in the current SDK version,
findingType
will returnAggregationFindingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfindingTypeAsString()
.- Returns:
- The type of finding to aggregate on.
- See Also:
-
findingTypeAsString
The type of finding to aggregate on.
If the service returns an enum value that is not available in the current SDK version,
findingType
will returnAggregationFindingType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfindingTypeAsString()
.- Returns:
- The type of finding to aggregate on.
- See Also:
-
resourceType
The resource type to aggregate on.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnAggregationResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type to aggregate on.
- See Also:
-
resourceTypeAsString
The resource type to aggregate on.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnAggregationResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type to aggregate on.
- See Also:
-
sortBy
The value to sort results by.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnTitleSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The value to sort results by.
- See Also:
-
sortByAsString
The value to sort results by.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnTitleSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The value to sort results by.
- See Also:
-
sortOrder
The order to sort results by.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The order to sort results by.
- See Also:
-
sortOrderAsString
The order to sort results by.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The order to sort results by.
- See Also:
-
hasTitles
public final boolean hasTitles()For responses, this returns true if the service returned a value for the Titles property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
titles
The finding titles to aggregate on.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTitles()
method.- Returns:
- The finding titles to aggregate on.
-
hasVulnerabilityIds
public final boolean hasVulnerabilityIds()For responses, this returns true if the service returned a value for the VulnerabilityIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
vulnerabilityIds
The vulnerability IDs of the findings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasVulnerabilityIds()
method.- Returns:
- The vulnerability IDs of the findings.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<TitleAggregation.Builder,
TitleAggregation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-