Class UpdatePlanRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePlanRequest.Builder,
UpdatePlanRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the plan.final Map
<String, AssociatedAlarm> The updated CloudWatch alarms associated with the plan.static UpdatePlanRequest.Builder
builder()
final String
The updated description for the Region switch plan.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AssociatedAlarms property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Triggers property.final boolean
For responses, this returns true if the service returned a value for the Workflows property.final Integer
The updated target recovery time objective (RTO) in minutes for the plan.static Class
<? extends UpdatePlanRequest.Builder> 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.triggers()
The updated conditions that can automatically trigger the execution of the plan.The updated workflows for the Region switch plan.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the plan.
- Returns:
- The Amazon Resource Name (ARN) of the plan.
-
description
The updated description for the Region switch plan.
- Returns:
- The updated description for the Region switch plan.
-
hasWorkflows
public final boolean hasWorkflows()For responses, this returns true if the service returned a value for the Workflows 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. -
workflows
The updated workflows for the Region switch plan.
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
hasWorkflows()
method.- Returns:
- The updated workflows for the Region switch plan.
-
executionRole
The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
- Returns:
- The updated IAM role ARN that grants Region switch the permissions needed to execute the plan steps.
-
recoveryTimeObjectiveMinutes
The updated target recovery time objective (RTO) in minutes for the plan.
- Returns:
- The updated target recovery time objective (RTO) in minutes for the plan.
-
hasAssociatedAlarms
public final boolean hasAssociatedAlarms()For responses, this returns true if the service returned a value for the AssociatedAlarms 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. -
associatedAlarms
The updated CloudWatch alarms associated with the plan.
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
hasAssociatedAlarms()
method.- Returns:
- The updated CloudWatch alarms associated with the plan.
-
hasTriggers
public final boolean hasTriggers()For responses, this returns true if the service returned a value for the Triggers 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. -
triggers
The updated conditions that can automatically trigger the execution of the plan.
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
hasTriggers()
method.- Returns:
- The updated conditions that can automatically trigger the execution of the plan.
-
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<UpdatePlanRequest.Builder,
UpdatePlanRequest> - Specified by:
toBuilder
in classArcRegionSwitchRequest
- Returns:
- a builder for type T
-
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
-
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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-