software.amazon.awssdk.services.accessanalyzer.model

Class ValidatePolicyFinding

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.ValidatePolicyFinding

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ValidatePolicyFinding.Builder,ValidatePolicyFinding>

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

A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValidatePolicyFinding.Builder

Method Summary

Modifier and Type	Method and Description
static ValidatePolicyFinding.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	findingDetails() A localized message that explains the finding and provides guidance on how to address it.
ValidatePolicyFindingType	findingType() The impact of the finding.
String	findingTypeAsString() The impact of the finding.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLocations() For responses, this returns true if the service returned a value for the Locations property.
String	issueCode() The issue code provides an identifier of the issue associated with this finding.
String	learnMoreLink() A link to additional documentation about the type of finding.
List<Location>	locations() The list of locations in the policy document that are related to the finding.
List<SdkField<?>>	sdkFields()
static Class<? extends ValidatePolicyFinding.Builder>	serializableBuilderClass()
ValidatePolicyFinding.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

findingDetails

public final String findingDetails()

A localized message that explains the finding and provides guidance on how to address it.

Returns:

A localized message that explains the finding and provides guidance on how to address it.

findingType

public final ValidatePolicyFindingType findingType()

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

If the service returns an enum value that is not available in the current SDK version, findingType will return ValidatePolicyFindingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from findingTypeAsString().

Returns:

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

See Also:

ValidatePolicyFindingType

findingTypeAsString

public final String findingTypeAsString()

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

If the service returns an enum value that is not available in the current SDK version, findingType will return ValidatePolicyFindingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from findingTypeAsString().

Returns:

The impact of the finding.

Security warnings report when the policy allows access that we consider overly permissive.

Errors report when a part of the policy is not functional.

Warnings report non-security issues when a policy does not conform to policy writing best practices.

Suggestions recommend stylistic improvements in the policy that do not impact access.

See Also:

ValidatePolicyFindingType

issueCode

public final String issueCode()

The issue code provides an identifier of the issue associated with this finding.

Returns:

The issue code provides an identifier of the issue associated with this finding.

learnMoreLink

public final String learnMoreLink()

A link to additional documentation about the type of finding.

Returns:

A link to additional documentation about the type of finding.

hasLocations

public final boolean hasLocations()

For responses, this returns true if the service returned a value for the Locations 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.

locations

public final List<Location> locations()

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the 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 hasLocations() method.

Returns:

The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.

toBuilder

public ValidatePolicyFinding.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ValidatePolicyFinding.Builder,ValidatePolicyFinding>

builder

public static ValidatePolicyFinding.Builder builder()

serializableBuilderClass

public static Class<? extends ValidatePolicyFinding.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