Class StartMigrationRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartMigrationRequest.Builder,StartMigrationRequest>

@Generated("software.amazon.awssdk:codegen") public final class StartMigrationRequest extends ElastiCacheRequest implements ToCopyableBuilder<StartMigrationRequest.Builder,StartMigrationRequest>
  • Method Details

    • serverlessCacheName

      public final String serverlessCacheName()

      The name of the serverless cache to which data is being migrated.

      Returns:
      The name of the serverless cache to which data is being migrated.
    • replicationGroupId

      public final String replicationGroupId()

      The ID of the replication group to which data should be migrated.

      Returns:
      The ID of the replication group to which data should be migrated.
    • hasCustomerNodeEndpointList

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

      public final List<CustomerNodeEndpoint> customerNodeEndpointList()

      The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. For serverless cache migrations, ElastiCache uses the endpoint that you provided in PrepareMigration.

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

      Returns:
      The list of endpoints from which to migrate data. For Valkey or Redis OSS (cluster mode disabled), the list should have only one element. For serverless cache migrations, ElastiCache uses the endpoint that you provided in PrepareMigration.
    • autoCutover

      public final Boolean autoCutover()

      Specifies whether ElastiCache automatically attempts to complete the migration after data sync is established.

      Returns:
      Specifies whether ElastiCache automatically attempts to complete the migration after data sync is established.
    • clearTargetCacheData

      public final Boolean clearTargetCacheData()

      Specifies whether ElastiCache deletes existing data in the serverless cache before migration begins. After StopMigration, StartMigration requires this option to restart the data sync.

      Returns:
      Specifies whether ElastiCache deletes existing data in the serverless cache before migration begins. After StopMigration, StartMigration requires this option to restart the data sync.
    • toBuilder

      public StartMigrationRequest.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<StartMigrationRequest.Builder,StartMigrationRequest>
      Specified by:
      toBuilder in class ElastiCacheRequest
      Returns:
      a builder for type T
    • builder

      public static StartMigrationRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends StartMigrationRequest.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)
      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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.