Class DescribeSnapshotsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest
software.amazon.awssdk.services.elasticache.model.DescribeSnapshotsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeSnapshotsRequest extends ElastiCacheRequest implements ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>

Represents the input of a DescribeSnapshotsMessage operation.

  • Method Details

    • replicationGroupId

      public final String replicationGroupId()

      A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

      Returns:
      A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

    • cacheClusterId

      public final String cacheClusterId()

      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

      Returns:
      A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

    • snapshotName

      public final String snapshotName()

      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

      Returns:
      A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

    • snapshotSource

      public final String snapshotSource()

      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

      Returns:
      If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

    • marker

      public final String marker()

      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Returns:
      An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • maxRecords

      public final Integer maxRecords()

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

      Returns:
      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

      Default: 50

      Constraints: minimum 20; maximum 50.

    • showNodeGroupConfig

      public final Boolean showNodeGroupConfig()

      A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

      Returns:
      A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

    • toBuilder

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

    • builder

      public static DescribeSnapshotsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeSnapshotsRequest.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.