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

Class GetWorkflowResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.migrationhuborchestrator.model.MigrationHubOrchestratorResponse
software.amazon.awssdk.services.migrationhuborchestrator.model.GetWorkflowResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetWorkflowResponse extends MigrationHubOrchestratorResponse implements ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>

  • Method Details

    • id

      public final String id()

      The ID of the migration workflow.

      Returns:
      The ID of the migration workflow.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the migration workflow.

      Returns:
      The Amazon Resource Name (ARN) of the migration workflow.

    • name

      public final String name()

      The name of the migration workflow.

      Returns:
      The name of the migration workflow.

    • description

      public final String description()

      The description of the migration workflow.

      Returns:
      The description of the migration workflow.

    • templateId

      public final String templateId()

      The ID of the template.

      Returns:
      The ID of the template.

    • adsApplicationConfigurationId

      public final String adsApplicationConfigurationId()

      The configuration ID of the application configured in Application Discovery Service.

      Returns:
      The configuration ID of the application configured in Application Discovery Service.

    • adsApplicationName

      public final String adsApplicationName()

      The name of the application configured in Application Discovery Service.

      Returns:
      The name of the application configured in Application Discovery Service.

    • status

      public final MigrationWorkflowStatusEnum status()

      The status of the migration workflow.

      If the service returns an enum value that is not available in the current SDK version, status will return MigrationWorkflowStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the migration workflow.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the migration workflow.

      If the service returns an enum value that is not available in the current SDK version, status will return MigrationWorkflowStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the migration workflow.
      See Also:

    • statusMessage

      public final String statusMessage()

      The status message of the migration workflow.

      Returns:
      The status message of the migration workflow.

    • creationTime

      public final Instant creationTime()

      The time at which the migration workflow was created.

      Returns:
      The time at which the migration workflow was created.

    • lastStartTime

      public final Instant lastStartTime()

      The time at which the migration workflow was last started.

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

    • lastStopTime

      public final Instant lastStopTime()

      The time at which the migration workflow was last stopped.

      Returns:
      The time at which the migration workflow was last stopped.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time at which the migration workflow was last modified.

      Returns:
      The time at which the migration workflow was last modified.

    • endTime

      public final Instant endTime()

      The time at which the migration workflow ended.

      Returns:
      The time at which the migration workflow ended.

    • hasTools

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

    • tools

      public final List<Tool> tools()

      List of AWS services utilized in a migration workflow.

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

      Returns:
      List of AWS services utilized in a migration workflow.

    • totalSteps

      public final Integer totalSteps()

      The total number of steps in the migration workflow.

      Returns:
      The total number of steps in the migration workflow.

    • completedSteps

      public final Integer completedSteps()

      Get a list of completed steps in the migration workflow.

      Returns:
      Get a list of completed steps in the migration workflow.

    • hasWorkflowInputs

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

    • workflowInputs

      public final Map<String,StepInput> workflowInputs()

      The inputs required for creating the migration workflow.

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

      Returns:
      The inputs required for creating the migration workflow.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags added to the migration workflow.

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

      Returns:
      The tags added to the migration workflow.

    • workflowBucket

      public final String workflowBucket()

      The Amazon S3 bucket where the migration logs are stored.

      Returns:
      The Amazon S3 bucket where the migration logs are stored.

    • toBuilder

      public GetWorkflowResponse.Builder 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 interface ToCopyableBuilder<GetWorkflowResponse.Builder,GetWorkflowResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetWorkflowResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.