Class DescribeAssessmentResponse

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

  • Method Details

    • assessmentArn

      public final String assessmentArn()

      The ARN associated with the assessment.

      Returns:
      The ARN associated with the assessment.

    • assessmentId

      public final String assessmentId()

      The unique ID of the assessment.

      Returns:
      The unique ID of the assessment.

    • frameworkId

      public final String frameworkId()

      The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0).

      Returns:
      The identifier of the framework that was evaluated by this assessment, in the format frameworkId@version (for example, AMISecurity@1.0).

    • assessmentTargetSummary

      public final AssessmentTargetSummary assessmentTargetSummary()

      Identifies the entity or change set that was assessed.

      Returns:
      Identifies the entity or change set that was assessed.

    • frameworkSummary

      public final FrameworkSummary frameworkSummary()

      The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId.

      Returns:
      The framework-specific details of the assessed resource. The set member corresponds to the framework identified by FrameworkId.

    • assessmentResult

      public final AssessmentResult assessmentResult()

      The overall result of the assessment.

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

      Returns:
      The overall result of the assessment.
      See Also:

    • assessmentResultAsString

      public final String assessmentResultAsString()

      The overall result of the assessment.

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

      Returns:
      The overall result of the assessment.
      See Also:

    • createdAt

      public final String createdAt()

      The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z).

      Returns:
      The date and time the assessment was created, in ISO 8601 format (2018-02-27T13:45:22Z).

    • expiresAt

      public final String expiresAt()

      The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z).

      Returns:
      The date and time the assessment expires, in ISO 8601 format (2018-02-27T13:45:22Z).

    • hasControlAssessments

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

    • controlAssessments

      public final List<ControlAssessment> controlAssessments()

      An array of ControlAssessment objects, each containing the result of an individual control evaluated as part of the assessment.

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

      Returns:
      An array of ControlAssessment objects, each containing the result of an individual control evaluated as part of the assessment.

    • nextToken

      public final String nextToken()

      The value of the next token, if it exists. null if there are no more results.

      Returns:
      The value of the next token, if it exists. null if there are no more results.

    • toBuilder

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

    • builder

      public static DescribeAssessmentResponse.Builder builder()

    • serializableBuilderClass

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