Package software.amazon.awssdk.services.kendra.model

Class GroupOrderingIdSummary

java.lang.Object

software.amazon.awssdk.services.kendra.model.GroupOrderingIdSummary

All Implemented Interfaces:

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

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

Summary information on the processing of PUT and DELETE actions for mapping users to their groups.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GroupOrderingIdSummary.Builder

Method Summary

Modifier and Type	Method	Description
static GroupOrderingIdSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason()	The reason an action could not be processed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedAt()	The Unix timestamp when an action was last updated.
Long	orderingId()	The order in which actions should complete processing.
Instant	receivedAt()	The Unix timestamp when an action was received by Amazon Kendra.
List<SdkField<?>>	sdkFields()
static Class<? extends GroupOrderingIdSummary.Builder>	serializableBuilderClass()
PrincipalMappingStatus	status()	The current processing status of actions for mapping users to their groups.
String	statusAsString()	The current processing status of actions for mapping users to their groups.
GroupOrderingIdSummary.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

status

public final PrincipalMappingStatus status()

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

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

Returns:

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

See Also:

PrincipalMappingStatus

statusAsString

public final String statusAsString()

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

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

Returns:

The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

See Also:

PrincipalMappingStatus

lastUpdatedAt

public final Instant lastUpdatedAt()

The Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.

Returns:

The Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.

receivedAt

public final Instant receivedAt()

The Unix timestamp when an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

Returns:

The Unix timestamp when an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

orderingId

public final Long orderingId()

The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

Returns:

The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

failureReason

public final String failureReason()

The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

Returns:

The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

toBuilder

public GroupOrderingIdSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GroupOrderingIdSummary.Builder,GroupOrderingIdSummary>

builder

public static GroupOrderingIdSummary.Builder builder()

serializableBuilderClass

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