Class WorkflowStepSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowStepSummary.Builder,
WorkflowStepSummary>
The summary of the step in a migration workflow.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WorkflowStepSummary.Builder
builder()
final String
The description of the step.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasNext()
For responses, this returns true if the service returned a value for the Next property.final boolean
For responses, this returns true if the service returned a value for the Previous property.final String
name()
The name of the step.next()
The next step.final Integer
The number of servers that have been migrated.final Integer
The number of servers that have failed to migrate.final Owner
owner()
The owner of the step.final String
The owner of the step.previous()
The previous step.final String
The location of the script.static Class
<? extends WorkflowStepSummary.Builder> final StepStatus
status()
The status of the step.final String
The status of the step.final String
The status message of the migration workflow.final StepActionType
The action type of the step.final String
The action type of the step.final String
stepId()
The ID of the step.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The total number of servers that have been migrated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
stepId
The ID of the step.
- Returns:
- The ID of the step.
-
name
The name of the step.
- Returns:
- The name of the step.
-
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 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:
-
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 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:
-
owner
The owner of the step.
If the service returns an enum value that is not available in the current SDK version,
owner
will returnOwner.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromownerAsString()
.- Returns:
- The owner of the step.
- See Also:
-
ownerAsString
The owner of the step.
If the service returns an enum value that is not available in the current SDK version,
owner
will returnOwner.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromownerAsString()
.- Returns:
- The owner of the step.
- See Also:
-
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
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
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
The status of the step.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStepStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the step.
- See Also:
-
statusAsString
The status of the step.
If the service returns an enum value that is not available in the current SDK version,
status
will returnStepStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the step.
- See Also:
-
statusMessage
The status message of the migration workflow.
- Returns:
- The status message of the migration workflow.
-
noOfSrvCompleted
The number of servers that have been migrated.
- Returns:
- The number of servers that have been migrated.
-
noOfSrvFailed
The number of servers that have failed to migrate.
- Returns:
- The number of servers that have failed to migrate.
-
totalNoOfSrv
The total number of servers that have been migrated.
- Returns:
- The total number of servers that have been migrated.
-
description
The description of the step.
- Returns:
- The description of the step.
-
scriptLocation
The location of the script.
- Returns:
- The location of the script.
-
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 interfaceToCopyableBuilder<WorkflowStepSummary.Builder,
WorkflowStepSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-