Class Experiment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Experiment.Builder,
Experiment>
Describes an experiment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Map
<String, ExperimentAction> actions()
The actions for the experiment.final String
arn()
The Amazon Resource Name (ARN) of the experiment.static Experiment.Builder
builder()
final Instant
The time that the experiment was created.final Instant
endTime()
The time that the experiment ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExperimentOptions
The experiment options for the experiment.final String
The ID of the experiment template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Actions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StopConditions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Targets property.final String
id()
The ID of the experiment.The configuration for experiment logging.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.static Class
<? extends Experiment.Builder> final Instant
The time that the experiment started.final ExperimentState
state()
The state of the experiment.final List
<ExperimentStopCondition> The stop conditions for the experiment.tags()
The tags for the experiment.final Long
The count of target account configurations for the experiment.final Map
<String, ExperimentTarget> targets()
The targets for the experiment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the experiment.
- Returns:
- The ID of the experiment.
-
arn
The Amazon Resource Name (ARN) of the experiment.
- Returns:
- The Amazon Resource Name (ARN) of the experiment.
-
experimentTemplateId
The ID of the experiment template.
- Returns:
- The ID of the experiment template.
-
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The time that the experiment was created.
- Returns:
- The time that the experiment was created.
-
startTime
The time that the experiment started.
- Returns:
- The time that the experiment started.
-
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 theisEmpty()
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
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
The configuration for experiment logging.
- Returns:
- The configuration for experiment logging.
-
experimentOptions
The experiment options for the experiment.
- Returns:
- The experiment options for the experiment.
-
targetAccountConfigurationsCount
The count of target account configurations for the experiment.
- Returns:
- The count of target account configurations for the experiment.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Experiment.Builder,
Experiment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-