Class StatusSummary

    • Method Detail

      • lastUpdatedAt

        public final Instant lastUpdatedAt()

        The datetime stamp when the status was last updated.

        Returns:
        The datetime stamp when the status was last updated.
      • status

        public final Status status()

        The current status.

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

        Returns:
        The current status.
        See Also:
        Status
      • statusAsString

        public final String statusAsString()

        The current status.

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

        Returns:
        The current status.
        See Also:
        Status
      • hasStatusDetails

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

        public final Map<String,​String> statusDetails()

        Details about the status.

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

        Returns:
        Details about the status.
      • statusMessage

        public final String statusMessage()

        When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.

        Returns:
        When applicable, returns an informational message relevant to the current status and status type of the status summary object. We don't recommend implementing parsing logic around this value since the messages returned can vary in format.
      • statusTypeAsString

        public final String statusTypeAsString()

        The type of a status summary.

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

        Returns:
        The type of a status summary.
        See Also:
        StatusType
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)