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

Class GetWorkflowStepResponse

    • Method Detail

      • name

        public final String name()

        The name of the step.

        Returns:
        The name of the step.

      • stepGroupId

        public final String stepGroupId()

        The ID of the step group.

        Returns:
        The ID of the step group.

      • workflowId

        public final String workflowId()

        The ID of the migration workflow.

        Returns:
        The ID of the migration workflow.

      • stepId

        public final String stepId()

        The ID of the step.

        Returns:
        The ID of the step.

      • description

        public final String description()

        The description of the step.

        Returns:
        The description 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

      • 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

      • workflowStepAutomationConfiguration

        public final WorkflowStepAutomationConfiguration workflowStepAutomationConfiguration()

        The custom script to run tests on source or target environments.

        Returns:
        The custom script to run tests on source or target environments.

      • hasStepTarget

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

      • stepTarget

        public final List<String> stepTarget()

        The servers on which a step will be run.

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

        Returns:
        The servers on which a step will be run.

      • hasOutputs

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

      • outputs

        public final List<WorkflowStepOutput> outputs()

        The outputs of the 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 hasOutputs() method.

        Returns:
        The outputs of the step.

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

      • statusMessage

        public final String statusMessage()

        The status message of the migration workflow.

        Returns:
        The status message of the migration workflow.

      • scriptOutputLocation

        public final String scriptOutputLocation()

        The output location of the script.

        Returns:
        The output location of the script.

      • creationTime

        public final Instant creationTime()

        The time at which the step was created.

        Returns:
        The time at which the step was created.

      • lastStartTime

        public final Instant lastStartTime()

        The time at which the workflow was last started.

        Returns:
        The time at which the workflow was last started.

      • endTime

        public final Instant endTime()

        The time at which the step ended.

        Returns:
        The time at which the step ended.

      • noOfSrvCompleted

        public final Integer noOfSrvCompleted()

        The number of servers that have been migrated.

        Returns:
        The number of servers that have been migrated.

      • noOfSrvFailed

        public final Integer noOfSrvFailed()

        The number of servers that have failed to migrate.

        Returns:
        The number of servers that have failed to migrate.

      • totalNoOfSrv

        public final Integer totalNoOfSrv()

        The total number of servers that have been migrated.

        Returns:
        The total number of servers that have been migrated.

      • 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