Class Finding
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Finding.Builder,
Finding>
Contains information about a finding.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionaction()
The action in the analyzed policy statement that an external principal has permission to use.final Instant
The time at which the resource was analyzed.static Finding.Builder
builder()
The condition in the analyzed policy statement that resulted in a finding.final Instant
The time at which the finding was generated.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
error()
An error.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Action property.final boolean
For responses, this returns true if the service returned a value for the Condition property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Principal property.final boolean
For responses, this returns true if the service returned a value for the Sources property.final String
id()
The ID of the finding.final Boolean
isPublic()
Indicates whether the policy that generated the finding allows public access to the resource.The external principal that has access to a resource within the zone of trust.final String
resource()
The resource that an external principal has access to.final String
The Amazon Web Services account ID that owns the resource.final ResourceType
The type of the resource identified in the finding.final String
The type of the resource identified in the finding.static Class
<? extends Finding.Builder> final List
<FindingSource> sources()
The sources of the finding.final FindingStatus
status()
The current status of the finding.final String
The current status of the finding.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 Instant
The time at which the finding was updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the finding.
- Returns:
- The ID of the finding.
-
hasPrincipal
public final boolean hasPrincipal()For responses, this returns true if the service returned a value for the Principal 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. -
principal
The external principal that has access to a resource within the zone of trust.
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
hasPrincipal()
method.- Returns:
- The external principal that has access to a resource within the zone of trust.
-
hasAction
public final boolean hasAction()For responses, this returns true if the service returned a value for the Action 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. -
action
The action in the analyzed policy statement that an external principal has permission to use.
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
hasAction()
method.- Returns:
- The action in the analyzed policy statement that an external principal has permission to use.
-
resource
The resource that an external principal has access to.
- Returns:
- The resource that an external principal has access to.
-
isPublic
Indicates whether the policy that generated the finding allows public access to the resource.
- Returns:
- Indicates whether the policy that generated the finding allows public access to the resource.
-
resourceType
The type of the resource identified in the finding.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of the resource identified in the finding.
- See Also:
-
resourceTypeAsString
The type of the resource identified in the finding.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of the resource identified in the finding.
- See Also:
-
hasCondition
public final boolean hasCondition()For responses, this returns true if the service returned a value for the Condition 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. -
condition
The condition in the analyzed policy statement that resulted in a finding.
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
hasCondition()
method.- Returns:
- The condition in the analyzed policy statement that resulted in a finding.
-
createdAt
The time at which the finding was generated.
- Returns:
- The time at which the finding was generated.
-
analyzedAt
The time at which the resource was analyzed.
- Returns:
- The time at which the resource was analyzed.
-
updatedAt
The time at which the finding was updated.
- Returns:
- The time at which the finding was updated.
-
status
The current status of the finding.
If the service returns an enum value that is not available in the current SDK version,
status
will returnFindingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the finding.
- See Also:
-
statusAsString
The current status of the finding.
If the service returns an enum value that is not available in the current SDK version,
status
will returnFindingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the finding.
- See Also:
-
resourceOwnerAccount
The Amazon Web Services account ID that owns the resource.
- Returns:
- The Amazon Web Services account ID that owns the resource.
-
error
An error.
- Returns:
- An error.
-
hasSources
public final boolean hasSources()For responses, this returns true if the service returned a value for the Sources 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. -
sources
The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket 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
hasSources()
method.- Returns:
- The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket 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<Finding.Builder,
Finding> - 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
-