Package software.amazon.awssdk.services.ebs.model

Class ListSnapshotBlocksRequest

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

  • Method Details

    • snapshotId

      public final String snapshotId()

      The ID of the snapshot from which to get block indexes and block tokens.

      Returns:
      The ID of the snapshot from which to get block indexes and block tokens.

    • nextToken

      public final String nextToken()

      The token to request the next page of results.

      If you specify NextToken, then StartingBlockIndex is ignored.

      Returns:
      The token to request the next page of results.

      If you specify NextToken, then StartingBlockIndex is ignored.

    • maxResults

      public final Integer maxResults()

      The maximum number of blocks to be returned by the request.

      Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

      To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

      Returns:
      The maximum number of blocks to be returned by the request.

      Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

      To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

    • startingBlockIndex

      public final Integer startingBlockIndex()

      The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

      If you specify NextToken, then StartingBlockIndex is ignored.

      Returns:
      The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

      If you specify NextToken, then StartingBlockIndex is ignored.

    • toBuilder

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

    • builder

      public static ListSnapshotBlocksRequest.Builder builder()

    • serializableBuilderClass

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