software.amazon.awssdk.services.resiliencehub.model

Class CreateRecommendationTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resiliencehub.model.ResiliencehubRequest

software.amazon.awssdk.services.resiliencehub.model.CreateRecommendationTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRecommendationTemplateRequest.Builder,CreateRecommendationTemplateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRecommendationTemplateRequest
extends ResiliencehubRequest
implements ToCopyableBuilder<CreateRecommendationTemplateRequest.Builder,CreateRecommendationTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRecommendationTemplateRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assessmentArn() The Amazon Resource Name (ARN) of the assessment.
String	bucketName() The name of the Amazon S3 bucket that will contain the recommendation template.
static CreateRecommendationTemplateRequest.Builder	builder()
String	clientToken() Used for an idempotency token.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
TemplateFormat	format() The format for the recommendation template.
String	formatAsString() The format for the recommendation template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecommendationIds() For responses, this returns true if the service returned a value for the RecommendationIds property.
boolean	hasRecommendationTypes() For responses, this returns true if the service returned a value for the RecommendationTypes property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name for the recommendation template.
List<String>	recommendationIds() Identifiers for the recommendations used to create a recommendation template.
List<RenderRecommendationType>	recommendationTypes() An array of strings that specify the recommendation template type or types.
List<String>	recommendationTypesAsStrings() An array of strings that specify the recommendation template type or types.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRecommendationTemplateRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags assigned to the resource.
CreateRecommendationTemplateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

assessmentArn

public final String assessmentArn()

The 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 AWS General Reference.

Returns:

The 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 AWS General Reference.

bucketName

public final String 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

public final String 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

public final TemplateFormat 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 return TemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

See Also:

TemplateFormat

formatAsString

public final String 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 return TemplateFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format for the recommendation template.

CfnJson

The template is CloudFormation JSON.

CfnYaml

The template is CloudFormation YAML.

See Also:

TemplateFormat

name

public final String 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 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 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

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.

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

The 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:

The 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

public CreateRecommendationTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRecommendationTemplateRequest.Builder,CreateRecommendationTemplateRequest>

Specified by:

toBuilder in class ResiliencehubRequest

builder

public static CreateRecommendationTemplateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRecommendationTemplateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo