Class ExperimentAction

    • Method Detail

      • actionId

        public final String actionId()

        The ID of the action.

        Returns:
        The ID of the action.
      • description

        public final String description()

        The description for the action.

        Returns:
        The description 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 Map<String,​String> parameters()

        The parameters for the 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 hasParameters() method.

        Returns:
        The parameters for the action.
      • hasTargets

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

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

        The targets for the 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 hasTargets() method.

        Returns:
        The targets for the action.
      • hasStartAfter

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

        public final List<String> startAfter()

        The name of the action that must be completed before this action starts.

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

        Returns:
        The name of the action that must be completed before this action starts.
      • state

        public final ExperimentActionState state()

        The state of the action.

        Returns:
        The state of the action.
      • startTime

        public final Instant startTime()

        The time that the action started.

        Returns:
        The time that the action started.
      • endTime

        public final Instant endTime()

        The time that the action ended.

        Returns:
        The time that the action ended.
      • 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)