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

Class PolicyGeneration

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.PolicyGeneration

All Implemented Interfaces:

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

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

Contains details about the policy generation status and properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PolicyGeneration.Builder

Method Summary

Modifier and Type	Method	Description
static PolicyGeneration.Builder	builder()
Instant	completedOn()	A timestamp of when the policy generation was completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId()	The JobId that is returned by the StartPolicyGeneration operation.
String	principalArn()	The ARN of the IAM entity (user or role) for which you are generating a policy.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyGeneration.Builder>	serializableBuilderClass()
Instant	startedOn()	A timestamp of when the policy generation started.
JobStatus	status()	The status of the policy generation request.
String	statusAsString()	The status of the policy generation request.
PolicyGeneration.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

jobId

public final String jobId()

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

Returns:

The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

principalArn

public final String principalArn()

The ARN of the IAM entity (user or role) for which you are generating a policy.

Returns:

The ARN of the IAM entity (user or role) for which you are generating a policy.

status

public final JobStatus status()

The status of the policy generation request.

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

Returns:

The status of the policy generation request.

See Also:

JobStatus

statusAsString

public final String statusAsString()

The status of the policy generation request.

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

Returns:

The status of the policy generation request.

See Also:

JobStatus

startedOn

public final Instant startedOn()

A timestamp of when the policy generation started.

Returns:

A timestamp of when the policy generation started.

completedOn

public final Instant completedOn()

A timestamp of when the policy generation was completed.

Returns:

A timestamp of when the policy generation was completed.

toBuilder

public PolicyGeneration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyGeneration.Builder,PolicyGeneration>

builder

public static PolicyGeneration.Builder builder()

serializableBuilderClass

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