Class RecommendationTemplate
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RecommendationTemplate.Builder,
RecommendationTemplate>
Defines a recommendation template created with the CreateRecommendationTemplate action.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
appArn()
Amazon Resource Name (ARN) of the Resilience Hub application.final String
Amazon Resource Name (ARN) of the assessment.builder()
final Instant
endTime()
The end time for the action.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final TemplateFormat
format()
Format of the recommendation template.final String
Format of the recommendation template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecommendationIds property.final boolean
For responses, this returns true if the service returned a value for the RecommendationTypes property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
message()
Message for the recommendation template.final String
name()
Name for the recommendation template.final Boolean
Indicates if replacements are needed.Identifiers for the recommendations used in the recommendation template.final String
Amazon Resource Name (ARN) for the recommendation template.final List
<RenderRecommendationType> An array of strings that specify the recommendation template type or types.An array of strings that specify the recommendation template type or types.static Class
<? extends RecommendationTemplate.Builder> final Instant
The start time for the action.status()
Status of the action.final String
Status of the action.tags()
Tags assigned to the resource.final S3Location
The file location of the template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The end time for the action.
- Returns:
- The end time for the action.
-
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 returnTemplateFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- Format of the recommendation template.
- CfnJson
-
The template is CloudFormation JSON.
- CfnYaml
-
The template is CloudFormation YAML.
- See Also:
-
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 returnTemplateFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- Format of the recommendation template.
- CfnJson
-
The template is CloudFormation JSON.
- CfnYaml
-
The template is CloudFormation YAML.
- See Also:
-
message
Message for the recommendation template.
- Returns:
- Message for the recommendation template.
-
name
Name for the recommendation template.
- Returns:
- Name for the recommendation template.
-
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 theisEmpty()
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
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
Amazon Resource Name (ARN) for the recommendation template.
- Returns:
- Amazon Resource Name (ARN) for the recommendation template.
-
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 theisEmpty()
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
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
The start time for the action.
- Returns:
- The start time for the action.
-
status
Status of the action.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRecommendationTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Status of the action.
- See Also:
-
statusAsString
Status of the action.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRecommendationTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 theisEmpty()
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
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
The file location of the template.
- Returns:
- The file location of the template.
-
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 interfaceToCopyableBuilder<RecommendationTemplate.Builder,
RecommendationTemplate> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-