Class PutTemplateActionResponse

    • Method Detail

      • 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.
      • 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:
        ActionCategory
      • 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.
      • 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.
      • 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