Class ContextContent

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

Typed content structure for a context. Contains application-specific fields that describe the environment used during recommendation generation.

See Also:

  • Method Details

    • hasAccountIds

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

    • accountIds

      public final List<String> accountIds()

      The Amazon Web Services account IDs associated with this application context.

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

      Returns:
      The Amazon Web Services account IDs associated with this application context.

    • hasRegions

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

    • regions

      public final List<String> regions()

      The Amazon Web Services Regions where this application operates.

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

      Returns:
      The Amazon Web Services Regions where this application operates.

    • hasAwsServices

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

    • awsServices

      public final List<String> awsServices()

      The Amazon Web Services services used by this application.

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

      Returns:
      The Amazon Web Services services used by this application.

    • hasResourceTypes

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

    • resourceTypes

      public final List<String> resourceTypes()

      The Amazon Web Services resource types relevant to this application.

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

      Returns:
      The Amazon Web Services resource types relevant to this application.

    • hasResourceTags

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

    • resourceTags

      public final List<ContextResourceTag> resourceTags()

      Resource tags used to scope this application context.

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

      Returns:
      Resource tags used to scope this application context.

    • applicationOverview

      public final String applicationOverview()

      A free-form overview of the application.

      Returns:
      A free-form overview of the application.

    • industry

      public final String industry()

      The industry vertical for this application.

      Returns:
      The industry vertical for this application.

    • applicationType

      public final ApplicationType applicationType()

      The type of the application.

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

      Returns:
      The type of the application.
      See Also:

    • applicationTypeAsString

      public final String applicationTypeAsString()

      The type of the application.

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

      Returns:
      The type of the application.
      See Also:

    • criticality

      public final Criticality criticality()

      The business criticality of the application.

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

      Returns:
      The business criticality of the application.
      See Also:

    • criticalityAsString

      public final String criticalityAsString()

      The business criticality of the application.

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

      Returns:
      The business criticality of the application.
      See Also:

    • architectureOverview

      public final String architectureOverview()

      A free-form description of the application architecture.

      Returns:
      A free-form description of the application architecture.

    • additionalContext

      public final String additionalContext()

      Additional context not captured by other fields.

      Returns:
      Additional context not captured by other fields.

    • toBuilder

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

    • builder

      public static ContextContent.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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