Class PutTemplateActionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutTemplateActionRequest.Builder,
PutTemplateActionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
actionID()
Template post migration custom action ID.final String
Template post migration custom action name.final Boolean
active()
Template post migration custom action active status.builder()
final ActionCategory
category()
Template post migration custom action category.final String
Template post migration custom action category.final String
Template post migration custom action description.final String
Template post migration custom action document identifier.final String
Template post migration custom action document version.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, SsmExternalParameter> Template post migration custom action external parameters.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 ExternalParameters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final String
Launch configuration template ID.final Boolean
Template post migration custom action must succeed for cutover.final String
Operating system eligible for this template post migration custom action.final Integer
order()
Template post migration custom action order.final Map
<String, List<SsmParameterStoreParameter>> Template post migration custom action parameters.static Class
<? extends PutTemplateActionRequest.Builder> final Integer
Template post migration custom action timeout in seconds.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
-
actionID
Template post migration custom action ID.
- Returns:
- Template post migration custom action ID.
-
actionName
Template post migration custom action name.
- Returns:
- Template post migration custom action name.
-
active
Template post migration custom action active status.
- Returns:
- Template post migration custom action active status.
-
category
Template post migration custom action category.
If the service returns an enum value that is not available in the current SDK version,
category
will returnActionCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- Template post migration custom action category.
- See Also:
-
categoryAsString
Template post migration custom action category.
If the service returns an enum value that is not available in the current SDK version,
category
will returnActionCategory.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryAsString()
.- Returns:
- Template post migration custom action category.
- See Also:
-
description
Template post migration custom action description.
- Returns:
- Template post migration custom action description.
-
documentIdentifier
Template post migration custom action document identifier.
- Returns:
- Template post migration custom action document identifier.
-
documentVersion
Template post migration custom action document version.
- Returns:
- Template post migration custom action document version.
-
hasExternalParameters
public final boolean hasExternalParameters()For responses, this returns true if the service returned a value for the ExternalParameters 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. -
externalParameters
Template post migration custom action external parameters.
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
hasExternalParameters()
method.- Returns:
- Template post migration custom action external parameters.
-
launchConfigurationTemplateID
Launch configuration template ID.
- Returns:
- Launch configuration template ID.
-
mustSucceedForCutover
Template post migration custom action must succeed for cutover.
- Returns:
- Template post migration custom action must succeed for cutover.
-
operatingSystem
Operating system eligible for this template post migration custom action.
- Returns:
- Operating system eligible for this template post migration custom action.
-
order
Template post migration custom action order.
- Returns:
- Template post migration custom action order.
-
hasParameters
public final boolean hasParameters()For responses, this returns true if the service returned a value for the Parameters 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. -
parameters
Template post migration custom action parameters.
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
hasParameters()
method.- Returns:
- Template post migration custom action parameters.
-
timeoutSeconds
Template post migration custom action timeout in seconds.
- Returns:
- Template post migration custom action timeout in seconds.
-
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<PutTemplateActionRequest.Builder,
PutTemplateActionRequest> - Specified by:
toBuilder
in classMgnRequest
- 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
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
-