Package software.amazon.awssdk.services.accessanalyzer.model

Class AccessPreviewSummary

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.AccessPreviewSummary

All Implemented Interfaces:

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

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

Contains a summary of information about an access preview.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessPreviewSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	analyzerArn()	The ARN of the analyzer used to generate the access preview.
static AccessPreviewSummary.Builder	builder()
Instant	createdAt()	The time at which the access preview was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique ID for the access preview.
List<SdkField<?>>	sdkFields()
static Class<? extends AccessPreviewSummary.Builder>	serializableBuilderClass()
AccessPreviewStatus	status()	The status of the access preview.
String	statusAsString()	The status of the access preview.
AccessPreviewStatusReason	statusReason()	Returns the value of the StatusReason property for this object.
AccessPreviewSummary.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

id

public final String id()

The unique ID for the access preview.

Returns:

The unique ID for the access preview.

analyzerArn

public final String analyzerArn()

The ARN of the analyzer used to generate the access preview.

Returns:

The ARN of the analyzer used to generate the access preview.

createdAt

public final Instant createdAt()

The time at which the access preview was created.

Returns:

The time at which the access preview was created.

status

public final AccessPreviewStatus status()

The status of the access preview.

• Creating - The access preview creation is in progress.

• Completed - The access preview is complete and previews the findings for external access to the resource.

• Failed - The access preview creation has failed.

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

Returns:

The status of the access preview.

• Creating - The access preview creation is in progress.

• Completed - The access preview is complete and previews the findings for external access to the resource.

• Failed - The access preview creation has failed.

See Also:

AccessPreviewStatus

statusAsString

public final String statusAsString()

The status of the access preview.

• Creating - The access preview creation is in progress.

• Completed - The access preview is complete and previews the findings for external access to the resource.

• Failed - The access preview creation has failed.

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

Returns:

The status of the access preview.

• Creating - The access preview creation is in progress.

• Completed - The access preview is complete and previews the findings for external access to the resource.

• Failed - The access preview creation has failed.

See Also:

AccessPreviewStatus

statusReason

public final AccessPreviewStatusReason statusReason()

Returns the value of the StatusReason property for this object.

Returns:

The value of the StatusReason property for this object.

toBuilder

public AccessPreviewSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessPreviewSummary.Builder,AccessPreviewSummary>

builder

public static AccessPreviewSummary.Builder builder()

serializableBuilderClass

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