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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GroupOrderingIdSummary.Builder,GroupOrderingIdSummary>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.