Package software.amazon.awssdk.services.migrationhuborchestrator.model

Class TemplateStepSummary

    • Method Detail

      • id

        public final String id()

        The ID of the step.

        Returns:
        The ID of the step.

      • stepGroupId

        public final String stepGroupId()

        The ID of the step group.

        Returns:
        The ID of the step group.

      • templateId

        public final String templateId()

        The ID of the template.

        Returns:
        The ID of the template.

      • name

        public final String name()

        The name of the step.

        Returns:
        The name of the step.

      • stepActionType

        public final StepActionType stepActionType()

        The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

        If the service returns an enum value that is not available in the current SDK version, stepActionType will return StepActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepActionTypeAsString().

        Returns:
        The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
        See Also:
        StepActionType

      • stepActionTypeAsString

        public final String stepActionTypeAsString()

        The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

        If the service returns an enum value that is not available in the current SDK version, stepActionType will return StepActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepActionTypeAsString().

        Returns:
        The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.
        See Also:
        StepActionType

      • targetTypeAsString

        public final String targetTypeAsString()

        The servers on which to run the script.

        If the service returns an enum value that is not available in the current SDK version, targetType will return TargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

        Returns:
        The servers on which to run the script.
        See Also:
        TargetType

      • owner

        public final Owner owner()

        The owner of the step.

        If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

        Returns:
        The owner of the step.
        See Also:
        Owner

      • ownerAsString

        public final String ownerAsString()

        The owner of the step.

        If the service returns an enum value that is not available in the current SDK version, owner will return Owner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

        Returns:
        The owner of the step.
        See Also:
        Owner

      • hasPrevious

        public final boolean hasPrevious()
        For responses, this returns true if the service returned a value for the Previous 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.

      • previous

        public final List<String> previous()

        The previous step.

        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 hasPrevious() method.

        Returns:
        The previous step.

      • hasNext

        public final boolean hasNext()
        For responses, this returns true if the service returned a value for the Next 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.

      • next

        public final List<String> next()

        The next step.

        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 hasNext() method.

        Returns:
        The next step.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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