Finding (AWS Java SDK :: Services :: AccessAnalyzer 2.20.22 API)

java.lang.Object
- software.amazon.awssdk.services.accessanalyzer.model.Finding

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Finding.Builder,Finding>

@Generated(value="software.amazon.awssdk:codegen")
public final class Finding
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Finding.Builder,Finding>

Contains information about a finding.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Finding.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Finding.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`action()` The action in the analyzed policy statement that an external principal has permission to use.
`Instant`	`analyzedAt()` The time at which the resource was analyzed.
`static Finding.Builder`	`builder()`
`Map<String,String>`	`condition()` The condition in the analyzed policy statement that resulted in a finding.
`Instant`	`createdAt()` The time at which the finding was generated.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`error()` An error.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAction()` For responses, this returns true if the service returned a value for the Action property.
`boolean`	`hasCondition()` For responses, this returns true if the service returned a value for the Condition property.
`int`	`hashCode()`
`boolean`	`hasPrincipal()` For responses, this returns true if the service returned a value for the Principal property.
`boolean`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`String`	`id()` The ID of the finding.
`Boolean`	`isPublic()` Indicates whether the policy that generated the finding allows public access to the resource.
`Map<String,String>`	`principal()` The external principal that access to a resource within the zone of trust.
`String`	`resource()` The resource that an external principal has access to.
`String`	`resourceOwnerAccount()` The Amazon Web Services account ID that owns the resource.
`ResourceType`	`resourceType()` The type of the resource identified in the finding.
`String`	`resourceTypeAsString()` The type of the resource identified in the finding.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Finding.Builder>`	`serializableBuilderClass()`
`List<FindingSource>`	`sources()` The sources of the finding.
`FindingStatus`	`status()` The current status of the finding.
`String`	`statusAsString()` The current status of the finding.
`Finding.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updatedAt()` The time at which the finding was 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 the isEmpty() 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 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 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 the isEmpty() 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 an external principal has access to.
    
    Returns:
    
    The resource that an external principal has access to.
  - isPublic
```
public final Boolean 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
```
public final ResourceType 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The type of the resource identified in the finding.
    
    See Also:
    
    ResourceType
  - resourceTypeAsString
```
public final String 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().
    
    Returns:
    
    The type of the resource identified in the finding.
    
    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 the isEmpty() 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 generated.
    
    Returns:
    
    The time at which the finding was generated.
  - analyzedAt
```
public final Instant analyzedAt()
```
    The time at which the resource was analyzed.
    
    Returns:
    
    The time at which the resource was analyzed.
  - updatedAt
```
public final Instant updatedAt()
```
    The time at which the finding was updated.
    
    Returns:
    
    The time at which the finding was updated.
  - status
```
public final FindingStatus 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 return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the finding.
    
    See Also:
    
    FindingStatus
  - statusAsString
```
public final String 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 return FindingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current 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()
```
    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 the isEmpty() 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 Finding.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Finding.Builder,Finding>
  - builder
```
public static Finding.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Finding.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Finding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

hasPrincipal

principal

hasAction

action

resource

isPublic

resourceType

resourceTypeAsString

hasCondition

condition

createdAt

analyzedAt

updatedAt

status

statusAsString

resourceOwnerAccount

error

hasSources

sources

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields