Class UpdateWorkflowStepRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.migrationhuborchestrator.model.MigrationHubOrchestratorRequest
-
- software.amazon.awssdk.services.migrationhuborchestrator.model.UpdateWorkflowStepRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateWorkflowStepRequest.Builder,UpdateWorkflowStepRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateWorkflowStepRequest extends MigrationHubOrchestratorRequest implements ToCopyableBuilder<UpdateWorkflowStepRequest.Builder,UpdateWorkflowStepRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateWorkflowStepRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateWorkflowStepRequest.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.booleanhasOutputs()For responses, this returns true if the service returned a value for the Outputs property.booleanhasPrevious()For responses, this returns true if the service returned a value for the Previous property.booleanhasStepTarget()For responses, this returns true if the service returned a value for the StepTarget property.Stringid()The ID of the step.Stringname()The name of the step.List<String>next()The next step.List<WorkflowStepOutput>outputs()The outputs of a step.List<String>previous()The previous step.List<SdkField<?>>sdkFields()static Class<? extends UpdateWorkflowStepRequest.Builder>serializableBuilderClass()StepStatusstatus()The status of the step.StringstatusAsString()The status of the step.StepActionTypestepActionType()The action type of the step.StringstepActionTypeAsString()The action type of the step.StringstepGroupId()The ID of the step group.List<String>stepTarget()The servers on which a step will be run.UpdateWorkflowStepRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkflowId()The ID of the migration workflow.WorkflowStepAutomationConfigurationworkflowStepAutomationConfiguration()The custom script to run tests on the source and target environments.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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.
-
workflowId
public final String workflowId()
The ID of the migration workflow.
- Returns:
- The ID of the migration workflow.
-
name
public final String name()
The name of the step.
- Returns:
- The name 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,
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
-
workflowStepAutomationConfiguration
public final WorkflowStepAutomationConfiguration workflowStepAutomationConfiguration()
The custom script to run tests on the source and target environments.
- Returns:
- The custom script to run tests on the source and 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 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.
-
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 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.
-
outputs
public final List<WorkflowStepOutput> outputs()
The outputs of a 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 a 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 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
-
toBuilder
public UpdateWorkflowStepRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateWorkflowStepRequest.Builder,UpdateWorkflowStepRequest>- Specified by:
toBuilderin classMigrationHubOrchestratorRequest
-
builder
public static UpdateWorkflowStepRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateWorkflowStepRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-