Class WorkflowStepSummary
- java.lang.Object
-
- software.amazon.awssdk.services.migrationhuborchestrator.model.WorkflowStepSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<WorkflowStepSummary.Builder,WorkflowStepSummary>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowStepSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowStepSummary.Builder,WorkflowStepSummary>
The summary of the step in a migration workflow.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWorkflowStepSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WorkflowStepSummary.Builderbuilder()Stringdescription()The description of the step.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasNext()For responses, this returns true if the service returned a value for the Next property.booleanhasPrevious()For responses, this returns true if the service returned a value for the Previous property.Stringname()The name of the step.List<String>next()The next step.IntegernoOfSrvCompleted()The number of servers that have been migrated.IntegernoOfSrvFailed()The number of servers that have failed to migrate.Ownerowner()The owner of the step.StringownerAsString()The owner of the step.List<String>previous()The previous step.StringscriptLocation()The location of the script.List<SdkField<?>>sdkFields()static Class<? extends WorkflowStepSummary.Builder>serializableBuilderClass()StepStatusstatus()The status of the step.StringstatusAsString()The status of the step.StringstatusMessage()The status message of the migration workflow.StepActionTypestepActionType()The action type of the step.StringstepActionTypeAsString()The action type of the step.StringstepId()The ID of the step.WorkflowStepSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegertotalNoOfSrv()The total number of servers that have been migrated.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
stepId
public final String stepId()
The ID of the step.
- Returns:
- The ID of the step.
-
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,
stepActionTypewill returnStepActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstepActionTypeAsString().- 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,
stepActionTypewill returnStepActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstepActionTypeAsString().- 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,
ownerwill returnOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromownerAsString().- 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,
ownerwill returnOwner.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromownerAsString().- 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 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.
-
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 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.
-
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.
-
status
public final StepStatus status()
The status of the step.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStepStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the step.
- See Also:
StepStatus
-
statusAsString
public final String statusAsString()
The status of the step.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStepStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the step.
- See Also:
StepStatus
-
statusMessage
public final String statusMessage()
The status message of the migration workflow.
- Returns:
- The status message of the migration workflow.
-
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.
-
description
public final String description()
The description of the step.
- Returns:
- The description of the step.
-
scriptLocation
public final String scriptLocation()
The location of the script.
- Returns:
- The location of the script.
-
toBuilder
public WorkflowStepSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<WorkflowStepSummary.Builder,WorkflowStepSummary>
-
builder
public static WorkflowStepSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowStepSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-