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

Class DescribePrincipalMappingResponse

    • Method Detail

      • indexId

        public final String indexId()

        Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

        Returns:
        Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • dataSourceId

        public final String dataSourceId()

        Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

        Returns:
        Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • groupId

        public final String groupId()

        Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

        Returns:
        Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

      • hasGroupOrderingIdSummaries

        public final boolean hasGroupOrderingIdSummaries()
        For responses, this returns true if the service returned a value for the GroupOrderingIdSummaries 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.

      • groupOrderingIdSummaries

        public final List<GroupOrderingIdSummary> groupOrderingIdSummaries()

        Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

        • Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

        • Last updated—the last date-time an action was updated.

        • Received—the last date-time an action was received or submitted.

        • Ordering ID—the latest action that should process and apply after other actions.

        • Failure reason—the reason an action could not be processed.

        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 hasGroupOrderingIdSummaries() method.

        Returns:
        Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

        • Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

        • Last updated—the last date-time an action was updated.

        • Received—the last date-time an action was received or submitted.

        • Ordering ID—the latest action that should process and apply after other actions.

        • Failure reason—the reason an action could not be processed.

      • 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