Class Experiment

    • Method Detail

      • id

        public final String id()

        The ID of the experiment.

        Returns:
        The ID of the experiment.
      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the experiment.

        Returns:
        The Amazon Resource Name (ARN) of the experiment.
      • experimentTemplateId

        public final String experimentTemplateId()

        The ID of the experiment template.

        Returns:
        The ID of the experiment template.
      • roleArn

        public final String roleArn()

        The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.

        Returns:
        The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
      • state

        public final ExperimentState state()

        The state of the experiment.

        Returns:
        The state of the experiment.
      • 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,​ExperimentTarget> targets()

        The targets for the experiment.

        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 experiment.
      • hasActions

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

        public final Map<String,​ExperimentAction> actions()

        The actions for the experiment.

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

        Returns:
        The actions for the experiment.
      • hasStopConditions

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

        public final List<ExperimentStopCondition> stopConditions()

        The stop conditions for the experiment.

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

        Returns:
        The stop conditions for the experiment.
      • creationTime

        public final Instant creationTime()

        The time that the experiment was created.

        Returns:
        The time that the experiment was created.
      • startTime

        public final Instant startTime()

        The time that the experiment started.

        Returns:
        The time that the experiment started.
      • endTime

        public final Instant endTime()

        The time that the experiment ended.

        Returns:
        The time that the experiment ended.
      • 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 Map<String,​String> tags()

        The tags for the experiment.

        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:
        The tags for the experiment.
      • logConfiguration

        public final ExperimentLogConfiguration logConfiguration()

        The configuration for experiment logging.

        Returns:
        The configuration for experiment logging.
      • experimentOptions

        public final ExperimentOptions experimentOptions()

        The experiment options for the experiment.

        Returns:
        The experiment options for the experiment.
      • targetAccountConfigurationsCount

        public final Long targetAccountConfigurationsCount()

        The count of target account configurations for the experiment.

        Returns:
        The count of target account configurations for the experiment.
      • 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)