Class RecommendedAction

    • Method Detail

      • actionId

        public final String actionId()

        The unique identifier of the recommended action.

        Returns:
        The unique identifier of the recommended action.
      • title

        public final String title()

        A short description to summarize the action. The description might contain markdown.

        Returns:
        A short description to summarize the action. The description might contain markdown.
      • description

        public final String description()

        A detailed description of the action. The description might contain markdown.

        Returns:
        A detailed description of the action. The description might contain markdown.
      • operation

        public final String operation()

        An API operation for the action.

        Returns:
        An API operation for the action.
      • hasParameters

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

        public final List<RecommendedActionParameter> parameters()

        The parameters for the API operation.

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

        Returns:
        The parameters for the API operation.
      • hasApplyModes

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

        public final List<String> applyModes()

        The methods to apply the recommended action.

        Valid values:

        • manual - The action requires you to resolve the recommendation manually.

        • immediately - The action is applied immediately.

        • next-maintainance-window - The action is applied during the next scheduled maintainance.

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

        Returns:
        The methods to apply the recommended action.

        Valid values:

        • manual - The action requires you to resolve the recommendation manually.

        • immediately - The action is applied immediately.

        • next-maintainance-window - The action is applied during the next scheduled maintainance.

      • status

        public final String status()

        The status of the action.

        • ready

        • applied

        • scheduled

        • resolved

        Returns:
        The status of the action.

        • ready

        • applied

        • scheduled

        • resolved

      • issueDetails

        public final IssueDetails issueDetails()

        The details of the issue.

        Returns:
        The details of the issue.
      • hasContextAttributes

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

        public final List<ContextAttribute> contextAttributes()

        The supporting attributes to explain the recommended action.

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

        Returns:
        The supporting attributes to explain the recommended action.
      • 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)