Class RecommendationTemplate

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

Defines a recommendation template created with the CreateRecommendationTemplate action.

See Also:

  • Method Details

    • appArn

      public final String appArn()

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      Returns:
      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • assessmentArn

      public final String assessmentArn()

      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      Returns:
      Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :resiliencehub:region:account:app-assessment/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • endTime

      public final Instant endTime()

      The end time for the action.

      Returns:
      The end time for the action.

    • format

      public final TemplateFormat format()

      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

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

      Returns:
      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      See Also:

    • formatAsString

      public final String formatAsString()

      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

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

      Returns:
      Format of the recommendation template.

      CfnJson

      The template is CloudFormation JSON.

      CfnYaml

      The template is CloudFormation YAML.

      See Also:

    • message

      public final String message()

      Message for the recommendation template.

      Returns:
      Message for the recommendation template.

    • name

      public final String name()

      Name for the recommendation template.

      Returns:
      Name for the recommendation template.

    • needsReplacements

      public final Boolean needsReplacements()

      Indicates if replacements are needed.

      Returns:
      Indicates if replacements are needed.

    • hasRecommendationIds

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

    • recommendationIds

      public final List<String> recommendationIds()

      Identifiers for the recommendations used in the recommendation 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 hasRecommendationIds() method.

      Returns:
      Identifiers for the recommendations used in the recommendation template.

    • recommendationTemplateArn

      public final String recommendationTemplateArn()

      Amazon Resource Name (ARN) for the recommendation template.

      Returns:
      Amazon Resource Name (ARN) for the recommendation template.

    • recommendationTypes

      public final List<RenderRecommendationType> recommendationTypes()

      An array of strings that specify the recommendation template type or types.

      Alarm

      The template is an AlarmRecommendation template.

      Sop

      The template is a SopRecommendation template.

      Test

      The template is a TestRecommendation 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 hasRecommendationTypes() method.

      Returns:
      An array of strings that specify the recommendation template type or types.

      Alarm

      The template is an AlarmRecommendation template.

      Sop

      The template is a SopRecommendation template.

      Test

      The template is a TestRecommendation template.

    • hasRecommendationTypes

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

    • recommendationTypesAsStrings

      public final List<String> recommendationTypesAsStrings()

      An array of strings that specify the recommendation template type or types.

      Alarm

      The template is an AlarmRecommendation template.

      Sop

      The template is a SopRecommendation template.

      Test

      The template is a TestRecommendation 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 hasRecommendationTypes() method.

      Returns:
      An array of strings that specify the recommendation template type or types.

      Alarm

      The template is an AlarmRecommendation template.

      Sop

      The template is a SopRecommendation template.

      Test

      The template is a TestRecommendation template.

    • startTime

      public final Instant startTime()

      The start time for the action.

      Returns:
      The start time for the action.

    • status

      public final RecommendationTemplateStatus status()

      Status of the action.

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

      Returns:
      Status of the action.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the action.

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

      Returns:
      Status of the action.
      See Also:

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

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

      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:
      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • templatesLocation

      public final S3Location templatesLocation()

      The file location of the template.

      Returns:
      The file location of the template.

    • toBuilder

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

    • builder

      public static RecommendationTemplate.Builder builder()

    • serializableBuilderClass

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