Package software.amazon.awssdk.services.wellarchitected.model

Class ReviewTemplate

java.lang.Object
software.amazon.awssdk.services.wellarchitected.model.ReviewTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReviewTemplate.Builder,ReviewTemplate>
@Generated("software.amazon.awssdk:codegen") public final class ReviewTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReviewTemplate.Builder,ReviewTemplate>

A review template.

See Also:

  • Method Details

    • description

      public final String description()

      The review template description.

      Returns:
      The review template description.

    • hasLenses

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

    • lenses

      public final List<String> lenses()

      The lenses applied to the review template.

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

      Returns:
      The lenses applied to the review template.

    • notes

      public final String notes()
      Returns the value of the Notes property for this object.
      Returns:
      The value of the Notes property for this object.

    • questionCounts

      public final Map<Question,Integer> questionCounts()

      A count of how many total questions are answered and unanswered in the review template.

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

      Returns:
      A count of how many total questions are answered and unanswered in the review template.

    • hasQuestionCounts

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

    • questionCountsAsStrings

      public final Map<String,Integer> questionCountsAsStrings()

      A count of how many total questions are answered and unanswered in the review template.

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

      Returns:
      A count of how many total questions are answered and unanswered in the review template.

    • owner

      public final String owner()
      Returns the value of the Owner property for this object.
      Returns:
      The value of the Owner property for this object.

    • updatedAt

      public final Instant updatedAt()
      Returns the value of the UpdatedAt property for this object.
      Returns:
      The value of the UpdatedAt property for this object.

    • templateArn

      public final String templateArn()

      The review template ARN.

      Returns:
      The review template ARN.

    • templateName

      public final String templateName()

      The name of the review template.

      Returns:
      The name of the review template.

    • 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 assigned to the review template.

      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 assigned to the review template.

    • updateStatus

      public final ReviewTemplateUpdateStatus updateStatus()

      The latest status of a review template.

      If the service returns an enum value that is not available in the current SDK version, updateStatus will return ReviewTemplateUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().

      Returns:
      The latest status of a review template.
      See Also:

    • updateStatusAsString

      public final String updateStatusAsString()

      The latest status of a review template.

      If the service returns an enum value that is not available in the current SDK version, updateStatus will return ReviewTemplateUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().

      Returns:
      The latest status of a review template.
      See Also:

    • shareInvitationId

      public final String shareInvitationId()

      The ID assigned to the template share invitation.

      Returns:
      The ID assigned to the template share invitation.

    • toBuilder

      public ReviewTemplate.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<ReviewTemplate.Builder,ReviewTemplate>
      Returns:
      a builder for type T

    • builder

      public static ReviewTemplate.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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