Class DescribeExecutionResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
software.amazon.awssdk.services.iotsitewise.model.DescribeExecutionResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeExecutionResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>

  • Method Details

    • executionId

      public final String executionId()

      The ID of the execution.

      Returns:
      The ID of the execution.

    • actionType

      public final String actionType()

      The type of action exectued.

      Returns:
      The type of action exectued.

    • targetResource

      public final TargetResource targetResource()
      Returns the value of the TargetResource property for this object.
      Returns:
      The value of the TargetResource property for this object.

    • targetResourceVersion

      public final String targetResourceVersion()

      The version of the target resource.

      Returns:
      The version of the target resource.

    • resolveTo

      public final ResolveTo resolveTo()

      The detailed resource this execution resolves to.

      Returns:
      The detailed resource this execution resolves to.

    • executionStartTime

      public final Instant executionStartTime()

      The time the process started.

      Returns:
      The time the process started.

    • executionEndTime

      public final Instant executionEndTime()

      The time the process ended.

      Returns:
      The time the process ended.

    • executionStatus

      public final ExecutionStatus 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 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.

    • executionResult

      public final Map<String,String> 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 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.

    • executionDetails

      public final Map<String,String> 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

      public final String executionEntityVersion()

      Entity version used for the execution.

      Returns:
      Entity version used for the execution.

    • toBuilder

      public DescribeExecutionResponse.Builder 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 interface ToCopyableBuilder<DescribeExecutionResponse.Builder,DescribeExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeExecutionResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeExecutionResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.