software.amazon.awssdk.services.migrationhuborchestrator.model

Class CreateWorkflowStepRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWorkflowStepRequest.Builder,CreateWorkflowStepRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateWorkflowStepRequest
extends MigrationHubOrchestratorRequest
implements ToCopyableBuilder<CreateWorkflowStepRequest.Builder,CreateWorkflowStepRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateWorkflowStepRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateWorkflowStepRequest.Builder	builder()
String	description() The description of the step.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNext() For responses, this returns true if the service returned a value for the Next property.
boolean	hasOutputs() For responses, this returns true if the service returned a value for the Outputs property.
boolean	hasPrevious() For responses, this returns true if the service returned a value for the Previous property.
boolean	hasStepTarget() For responses, this returns true if the service returned a value for the StepTarget property.
String	name() The name of the step.
List<String>	next() The next step.
List<WorkflowStepOutput>	outputs() The key value pairs added for the expected output.
List<String>	previous() The previous step.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWorkflowStepRequest.Builder>	serializableBuilderClass()
StepActionType	stepActionType() The action type of the step.
String	stepActionTypeAsString() The action type of the step.
String	stepGroupId() The ID of the step group.
List<String>	stepTarget() The servers on which a step will be run.
CreateWorkflowStepRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	workflowId() The ID of the migration workflow.
WorkflowStepAutomationConfiguration	workflowStepAutomationConfiguration() The custom script to run tests on source or 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

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.

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

description

public final String description()

The description of the step.

Returns:

The description of the step.

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 key value pairs added for the expected output.

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 key value pairs added for the expected output.

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.

toBuilder

public CreateWorkflowStepRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWorkflowStepRequest.Builder,CreateWorkflowStepRequest>

Specified by:

toBuilder in class MigrationHubOrchestratorRequest

builder

public static CreateWorkflowStepRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateWorkflowStepRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo