Class FindingSummary
- java.lang.Object
-
- software.amazon.awssdk.services.accessanalyzer.model.FindingSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FindingSummary.Builder,FindingSummary>
@Generated("software.amazon.awssdk:codegen") public final class FindingSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FindingSummary.Builder,FindingSummary>
Contains information about a finding.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFindingSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>action()The action in the analyzed policy statement that an external principal has permission to use.InstantanalyzedAt()The time at which the resource-based policy that generated the finding was analyzed.static FindingSummary.Builderbuilder()Map<String,String>condition()The condition in the analyzed policy statement that resulted in a finding.InstantcreatedAt()The time at which the finding was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringerror()The error that resulted in an Error finding.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAction()For responses, this returns true if the service returned a value for the Action property.booleanhasCondition()For responses, this returns true if the service returned a value for the Condition property.inthashCode()booleanhasPrincipal()For responses, this returns true if the service returned a value for the Principal property.booleanhasSources()For responses, this returns true if the service returned a value for the Sources property.Stringid()The ID of the finding.BooleanisPublic()Indicates whether the finding reports a resource that has a policy that allows public access.Map<String,String>principal()The external principal that has access to a resource within the zone of trust.Stringresource()The resource that the external principal has access to.StringresourceOwnerAccount()The Amazon Web Services account ID that owns the resource.ResourceTyperesourceType()The type of the resource that the external principal has access to.StringresourceTypeAsString()The type of the resource that the external principal has access to.List<SdkField<?>>sdkFields()static Class<? extends FindingSummary.Builder>serializableBuilderClass()List<FindingSource>sources()The sources of the finding.FindingStatusstatus()The status of the finding.StringstatusAsString()The status of the finding.FindingSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The time at which the finding was most recently updated.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
id
public final String 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
public final Map<String,String> 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
public final List<String> 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
public final String resource()
The resource that the external principal has access to.
- Returns:
- The resource that the external principal has access to.
-
isPublic
public final Boolean isPublic()
Indicates whether the finding reports a resource that has a policy that allows public access.
- Returns:
- Indicates whether the finding reports a resource that has a policy that allows public access.
-
resourceType
public final ResourceType resourceType()
The type of the resource that the external principal has access to.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of the resource that the external principal has access to.
- See Also:
ResourceType
-
resourceTypeAsString
public final String resourceTypeAsString()
The type of the resource that the external principal has access to.
If the service returns an enum value that is not available in the current SDK version,
resourceTypewill returnResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresourceTypeAsString().- Returns:
- The type of the resource that the external principal has access to.
- See Also:
ResourceType
-
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
public final Map<String,String> 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
public final Instant createdAt()
The time at which the finding was created.
- Returns:
- The time at which the finding was created.
-
analyzedAt
public final Instant analyzedAt()
The time at which the resource-based policy that generated the finding was analyzed.
- Returns:
- The time at which the resource-based policy that generated the finding was analyzed.
-
updatedAt
public final Instant updatedAt()
The time at which the finding was most recently updated.
- Returns:
- The time at which the finding was most recently updated.
-
status
public final FindingStatus status()
The status of the finding.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the finding.
- See Also:
FindingStatus
-
statusAsString
public final String statusAsString()
The status of the finding.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the finding.
- See Also:
FindingStatus
-
resourceOwnerAccount
public final String resourceOwnerAccount()
The Amazon Web Services account ID that owns the resource.
- Returns:
- The Amazon Web Services account ID that owns the resource.
-
error
public final String error()
The error that resulted in an Error finding.
- Returns:
- The error that resulted in an Error finding.
-
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
public final List<FindingSource> 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
public FindingSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FindingSummary.Builder,FindingSummary>
-
builder
public static FindingSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends FindingSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-