Class FindingHistoryRecord
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FindingHistoryRecord.Builder,
FindingHistoryRecord>
A list of events that changed the specified finding during the specified time period. Each record represents a single finding change event.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic FindingHistoryRecord.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Identifies whether the event marks the creation of a new finding.Returns the value of the FindingIdentifier property for this object.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 Updates property.final String
A token for pagination purposes.static Class
<? extends FindingHistoryRecord.Builder> 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
<FindingHistoryUpdate> updates()
An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.Identifies the source of the event that changed the finding.final Instant
A timestamp that indicates when Security Hub processed the updated finding record.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
findingIdentifier
Returns the value of the FindingIdentifier property for this object.- Returns:
- The value of the FindingIdentifier property for this object.
-
updateTime
A timestamp that indicates when Security Hub processed the updated finding record.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
- Returns:
- A timestamp that indicates when Security Hub processed the updated finding record.
This field accepts only the specified formats. Timestamps can end with
Z
or("+" / "-") time-hour [":" time-minute]
. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ
(for example,2019-01-31T23:00:00Z
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ
(for example,2019-01-31T23:00:00.123456789Z
) -
YYYY-MM-DDTHH:MM:SS+HH:MM
(for example,2024-01-04T15:25:10+17:59
) -
YYYY-MM-DDTHH:MM:SS-HHMM
(for example,2024-01-04T15:25:10-1759
) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM
(for example,2024-01-04T15:25:10.123456789+17:59
)
-
-
-
findingCreated
Identifies whether the event marks the creation of a new finding. A value of
True
means that the finding is newly created. A value ofFalse
means that the finding isn’t newly created.- Returns:
- Identifies whether the event marks the creation of a new finding. A value of
True
means that the finding is newly created. A value ofFalse
means that the finding isn’t newly created.
-
updateSource
Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Service or third-party partner integration may call
BatchImportFindings
, or an Security Hub customer may callBatchUpdateFindings
.- Returns:
- Identifies the source of the event that changed the finding. For example, an integrated Amazon Web
Service or third-party partner integration may call
BatchImportFindings
, or an Security Hub customer may callBatchUpdateFindings
.
-
hasUpdates
public final boolean hasUpdates()For responses, this returns true if the service returned a value for the Updates 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. -
updates
An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.
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
hasUpdates()
method.- Returns:
- An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.
-
nextToken
A token for pagination purposes. Provide this token in the subsequent request to
GetFindingsHistory
to get up to an additional 100 results of history for the same finding that you specified in your initial request.- Returns:
- A token for pagination purposes. Provide this token in the subsequent request to
GetFindingsHistory
to get up to an additional 100 results of history for the same finding that you specified in your initial request.
-
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<FindingHistoryRecord.Builder,
FindingHistoryRecord> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int 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
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-