Class DescribeComputationModelResponse

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.DescribeComputationModelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeComputationModelResponse.Builder,DescribeComputationModelResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeComputationModelResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeComputationModelResponse.Builder,DescribeComputationModelResponse>

  • Method Details

    • computationModelId

      public final String computationModelId()

      The ID of the computation model.

      Returns:
      The ID of the computation model.

    • computationModelArn

      public final String computationModelArn()

      The ARN of the computation model, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}

      Returns:
      The ARN of the computation model, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}

    • computationModelName

      public final String computationModelName()

      The name of the computation model.

      Returns:
      The name of the computation model.

    • computationModelDescription

      public final String computationModelDescription()

      The description of the computation model.

      Returns:
      The description of the computation model.

    • computationModelConfiguration

      public final ComputationModelConfiguration computationModelConfiguration()

      The configuration for the computation model.

      Returns:
      The configuration for the computation model.

    • hasComputationModelDataBinding

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

    • computationModelDataBinding

      public final Map<String,ComputationModelDataBindingValue> computationModelDataBinding()

      The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

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

      Returns:
      The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

    • computationModelCreationDate

      public final Instant computationModelCreationDate()

      The model creation date, in Unix epoch time.

      Returns:
      The model creation date, in Unix epoch time.

    • computationModelLastUpdateDate

      public final Instant computationModelLastUpdateDate()

      The date the model was last updated, in Unix epoch time.

      Returns:
      The date the model was last updated, in Unix epoch time.

    • computationModelStatus

      public final ComputationModelStatus computationModelStatus()

      The current status of the asset model, which contains a state and an error message if any.

      Returns:
      The current status of the asset model, which contains a state and an error message if any.

    • computationModelVersion

      public final String computationModelVersion()

      The version of the computation model.

      Returns:
      The version of the computation model.

    • hasActionDefinitions

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

    • actionDefinitions

      public final List<ActionDefinition> actionDefinitions()

      The available actions for this computation model.

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

      Returns:
      The available actions for this computation model.

    • toBuilder

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

    • builder

      public static DescribeComputationModelResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeComputationModelResponse.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.