Class LaunchAction

    • Method Detail

      • actionCode

        public final String actionCode()

        Launch action code.

        Returns:
        Launch action code.
      • actionId

        public final String actionId()
        Returns the value of the ActionId property for this object.
        Returns:
        The value of the ActionId property for this object.
      • actionVersion

        public final String actionVersion()
        Returns the value of the ActionVersion property for this object.
        Returns:
        The value of the ActionVersion property for this object.
      • active

        public final Boolean active()

        Whether the launch action is active.

        Returns:
        Whether the launch action is active.
      • categoryAsString

        public final String categoryAsString()
        Returns the value of the Category property for this object.

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

        Returns:
        The value of the Category property for this object.
        See Also:
        LaunchActionCategory
      • description

        public final String description()
        Returns the value of the Description property for this object.
        Returns:
        The value of the Description property for this object.
      • name

        public final String name()
        Returns the value of the Name property for this object.
        Returns:
        The value of the Name property for this object.
      • optional

        public final Boolean optional()

        Whether the launch will not be marked as failed if this action fails.

        Returns:
        Whether the launch will not be marked as failed if this action fails.
      • order

        public final Integer order()
        Returns the value of the Order property for this object.
        Returns:
        The value of the Order property for this object.
      • 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 Map<String,​LaunchActionParameter> parameters()
        Returns the value of the Parameters property for this 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 hasParameters() method.

        Returns:
        The value of the Parameters property for this 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)