Class DescribeExecutionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeExecutionResponse.Builder,
DescribeExecutionResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The type of action exectued.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Provides detailed information about the execution of your anomaly detection models.final Instant
The time the process ended.final String
Entity version used for the execution.final String
The ID of the execution.The result of the execution.final Instant
The time the process started.final ExecutionStatus
The status of the execution process.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the ExecutionDetails property.final boolean
For responses, this returns true if the service returned a value for the ExecutionResult property.final int
hashCode()
final ResolveTo
The detailed resource this execution resolves to.static Class
<? extends DescribeExecutionResponse.Builder> final TargetResource
Returns the value of the TargetResource property for this object.final String
The version of the target resource.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 class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
executionId
-
actionType
-
targetResource
Returns the value of the TargetResource property for this object.- Returns:
- The value of the TargetResource property for this object.
-
targetResourceVersion
The version of the target resource.
- Returns:
- The version of the target resource.
-
resolveTo
The detailed resource this execution resolves to.
- Returns:
- The detailed resource this execution resolves to.
-
executionStartTime
The time the process started.
- Returns:
- The time the process started.
-
executionEndTime
The time the process ended.
- Returns:
- The time the process ended.
-
executionStatus
The status of the execution process.
- Returns:
- The status of the execution process.
-
hasExecutionResult
public final boolean hasExecutionResult()For responses, this returns true if the service returned a value for the ExecutionResult 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. -
executionResult
The result of the execution.
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
hasExecutionResult()
method.- Returns:
- The result of the execution.
-
hasExecutionDetails
public final boolean hasExecutionDetails()For responses, this returns true if the service returned a value for the ExecutionDetails 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. -
executionDetails
Provides detailed information about the execution of your anomaly detection models. This includes model metrics and training timestamps for both training and inference actions.
-
The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.
-
The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
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
hasExecutionDetails()
method.- Returns:
- Provides detailed information about the execution of your anomaly detection models. This includes model
metrics and training timestamps for both training and inference actions.
-
The training action (Amazon Web Services/ANOMALY_DETECTION_TRAINING), includes performance metrics that help you compare different versions of your anomaly detection models. These metrics provide insights into the model's performance during the training process.
-
The inference action (Amazon Web Services/ANOMALY_DETECTION_INFERENCE), includes information about the results of executing your anomaly detection models. This helps you understand the output of your models and assess their performance.
-
-
-
executionEntityVersion
Entity version used for the execution.
- Returns:
- Entity version used for the execution.
-
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<DescribeExecutionResponse.Builder,
DescribeExecutionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
-
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-