Class CreateGuiSessionAccessDetailsResponse

    • Method Detail

      • resourceName

        public final String resourceName()

        The resource name.

        Returns:
        The resource name.
      • status

        public final Status status()

        The status of the operation.

        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 status of the operation.
        See Also:
        Status
      • statusAsString

        public final String statusAsString()

        The status of the operation.

        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 status of the operation.
        See Also:
        Status
      • percentageComplete

        public final Integer percentageComplete()

        The percentage of completion for the operation.

        Returns:
        The percentage of completion for the operation.
      • failureReason

        public final String failureReason()

        The reason the operation failed.

        Returns:
        The reason the operation failed.
      • hasSessions

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

        public final List<Session> sessions()

        Returns information about the specified NICE DCV GUI session.

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

        Returns:
        Returns information about the specified NICE DCV GUI session.
      • 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