Class PutTemplateActionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mgn.model.MgnRequest
software.amazon.awssdk.services.mgn.model.PutTemplateActionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutTemplateActionRequest.Builder,PutTemplateActionRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutTemplateActionRequest extends MgnRequest implements ToCopyableBuilder<PutTemplateActionRequest.Builder,PutTemplateActionRequest>

  • Method Details

    • actionID

      public final String actionID()

      Template post migration custom action ID.

      Returns:
      Template post migration custom action ID.

    • actionName

      public final String actionName()

      Template post migration custom action name.

      Returns:
      Template post migration custom action name.

    • active

      public final Boolean active()

      Template post migration custom action active status.

      Returns:
      Template post migration custom action active status.

    • category

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

      Returns:
      Template post migration custom action category.
      See Also:

    • categoryAsString

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

      Returns:
      Template post migration custom action category.
      See Also:

    • description

      public final String description()

      Template post migration custom action description.

      Returns:
      Template post migration custom action description.

    • documentIdentifier

      public final String documentIdentifier()

      Template post migration custom action document identifier.

      Returns:
      Template post migration custom action document identifier.

    • documentVersion

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

    • externalParameters

      public final Map<String,SsmExternalParameter> 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

      public final String launchConfigurationTemplateID()

      Launch configuration template ID.

      Returns:
      Launch configuration template ID.

    • mustSucceedForCutover

      public final Boolean mustSucceedForCutover()

      Template post migration custom action must succeed for cutover.

      Returns:
      Template post migration custom action must succeed for cutover.

    • operatingSystem

      public final String operatingSystem()

      Operating system eligible for this template post migration custom action.

      Returns:
      Operating system eligible for this template post migration custom action.

    • order

      public final Integer 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 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.

    • parameters

      public final Map<String,List<SsmParameterStoreParameter>> 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

      public final Integer timeoutSeconds()

      Template post migration custom action timeout in seconds.

      Returns:
      Template post migration custom action timeout in seconds.

    • toBuilder

      public PutTemplateActionRequest.Builder 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 interface ToCopyableBuilder<PutTemplateActionRequest.Builder,PutTemplateActionRequest>
      Specified by:
      toBuilder in class MgnRequest
      Returns:
      a builder for type T

    • builder

      public static PutTemplateActionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutTemplateActionRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.