Class ReplicationRun

java.lang.Object
software.amazon.awssdk.services.sms.model.ReplicationRun
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReplicationRun.Builder,ReplicationRun>

@Generated("software.amazon.awssdk:codegen") public final class ReplicationRun extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationRun.Builder,ReplicationRun>

Represents a replication run.

See Also:
  • Method Details

    • replicationRunId

      public final String replicationRunId()

      The ID of the replication run.

      Returns:
      The ID of the replication run.
    • state

      public final ReplicationRunState state()

      The state of the replication run.

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

      Returns:
      The state of the replication run.
      See Also:
    • stateAsString

      public final String stateAsString()

      The state of the replication run.

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

      Returns:
      The state of the replication run.
      See Also:
    • type

      public final ReplicationRunType type()

      The type of replication run.

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

      Returns:
      The type of replication run.
      See Also:
    • typeAsString

      public final String typeAsString()

      The type of replication run.

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

      Returns:
      The type of replication run.
      See Also:
    • stageDetails

      public final ReplicationRunStageDetails stageDetails()

      Details about the current stage of the replication run.

      Returns:
      Details about the current stage of the replication run.
    • statusMessage

      public final String statusMessage()

      The description of the current status of the replication job.

      Returns:
      The description of the current status of the replication job.
    • amiId

      public final String amiId()

      The ID of the Amazon Machine Image (AMI) from the replication run.

      Returns:
      The ID of the Amazon Machine Image (AMI) from the replication run.
    • scheduledStartTime

      public final Instant scheduledStartTime()

      The start time of the next replication run.

      Returns:
      The start time of the next replication run.
    • completedTime

      public final Instant completedTime()

      The completion time of the last replication run.

      Returns:
      The completion time of the last replication run.
    • description

      public final String description()

      The description of the replication run.

      Returns:
      The description of the replication run.
    • encrypted

      public final Boolean encrypted()

      Indicates whether the replication run should produce an encrypted AMI.

      Returns:
      Indicates whether the replication run should produce an encrypted AMI.
    • kmsKeyId

      public final String kmsKeyId()

      The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to the KMS key ID

      • ARN referring to the KMS key alias

      If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

      Returns:
      The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:

      • KMS key ID

      • KMS key alias

      • ARN referring to the KMS key ID

      • ARN referring to the KMS key alias

      If encrypted is true but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.

    • toBuilder

      public ReplicationRun.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<ReplicationRun.Builder,ReplicationRun>
      Returns:
      a builder for type T
    • builder

      public static ReplicationRun.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ReplicationRun.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.