Class PersistentAppUI

    • Method Detail

      • persistentAppUIId

        public final String persistentAppUIId()

        The identifier for the persistent application user interface object.

        Returns:
        The identifier for the persistent application user interface object.
      • persistentAppUITypeList

        public final List<PersistentAppUIType> persistentAppUITypeList()

        The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.

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

        Returns:
        The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.
      • hasPersistentAppUITypeList

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

        public final List<String> persistentAppUITypeListAsStrings()

        The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.

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

        Returns:
        The type list for the persistent application user interface object. Valid values include SHS, YTS, or TEZ.
      • persistentAppUIStatus

        public final String persistentAppUIStatus()

        The status for the persistent application user interface object.

        Returns:
        The status for the persistent application user interface object.
      • authorId

        public final String authorId()

        The author ID for the persistent application user interface object.

        Returns:
        The author ID for the persistent application user interface object.
      • creationTime

        public final Instant creationTime()

        The creation date and time for the persistent application user interface object.

        Returns:
        The creation date and time for the persistent application user interface object.
      • lastModifiedTime

        public final Instant lastModifiedTime()

        The date and time the persistent application user interface object was last changed.

        Returns:
        The date and time the persistent application user interface object was last changed.
      • lastStateChangeReason

        public final String lastStateChangeReason()

        The reason the persistent application user interface object was last changed.

        Returns:
        The reason the persistent application user interface object was last changed.
      • hasTags

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

        public final List<Tag> tags()

        A collection of tags for the persistent application user interface object.

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

        Returns:
        A collection of tags for the persistent application user interface object.
      • 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)