Class CreateRecommendationTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRecommendationTemplateRequest.Builder,
CreateRecommendationTemplateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Amazon Resource Name (ARN) of the assessment.final String
The name of the Amazon S3 bucket that will contain the recommendation template.builder()
final String
Used for an idempotency token.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final TemplateFormat
format()
The format for the recommendation template.final String
The format for the recommendation template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.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
name()
The name for the recommendation template.Identifiers for the recommendations used to create a 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 CreateRecommendationTemplateRequest.Builder> tags()
Tags assigned to the resource.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 class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
bucketName
The name of the Amazon S3 bucket that will contain the recommendation template.
- Returns:
- The name of the Amazon S3 bucket that will contain the recommendation template.
-
clientToken
Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
- Returns:
- Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.
-
format
The format for 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:
- The format for the recommendation template.
- CfnJson
-
The template is CloudFormation JSON.
- CfnYaml
-
The template is CloudFormation YAML.
- See Also:
-
formatAsString
The format for 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:
- The format for the recommendation template.
- CfnJson
-
The template is CloudFormation JSON.
- CfnYaml
-
The template is CloudFormation YAML.
- See Also:
-
name
The name for the recommendation template.
- Returns:
- The name for the recommendation template.
-
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 to create a 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 to create a 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.
-
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.
-
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<CreateRecommendationTemplateRequest.Builder,
CreateRecommendationTemplateRequest> - Specified by:
toBuilder
in classResiliencehubRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateRecommendationTemplateRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-