You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::ListObjectVersionsOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#common_prefixes ⇒ Array<Types::CommonPrefix>

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

Returns:

  • (Array<Types::CommonPrefix>) —

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

#delete_markers ⇒ Array<Types::DeleteMarkerEntry>

Container for an object that is a delete marker.

Returns:

#delimiter ⇒ String

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

Returns:

  • (String) —

    The delimiter grouping the included keys.

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

Possible values:

  • url

Returns:

  • (String) —

    Encoding type used by Amazon S3 to encode object key names in the XML response.

#is_truncated ⇒ Boolean

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

Returns:

  • (Boolean) —

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

#key_marker ⇒ String

Marks the last key returned in a truncated response.

Returns:

  • (String) —

    Marks the last key returned in a truncated response.

#max_keys ⇒ Integer

Specifies the maximum number of objects to return.

Returns:

  • (Integer) —

    Specifies the maximum number of objects to return.

#name ⇒ String

The bucket name.

Returns:

  • (String) —

    The bucket name.

#next_key_marker ⇒ String

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

Returns:

  • (String) —

    When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria.

#next_version_id_marker ⇒ String

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Returns:

  • (String) —

    When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria.

#prefix ⇒ String

Selects objects that start with the value supplied by this parameter.

Returns:

  • (String) —

    Selects objects that start with the value supplied by this parameter.

#version_id_marker ⇒ String

Marks the last version of the key returned in a truncated response.

Returns:

  • (String) —

    Marks the last version of the key returned in a truncated response.

#versions ⇒ Array<Types::ObjectVersion>

Container for version information.

Returns: