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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectVersionsOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb,
lib/aws-sdk-s3/customizations/types/list_object_versions_output.rb

Overview

See Also:

• AWS API Documentation

Instance Attribute Summary

• #common_prefixes ⇒ Array<Types::CommonPrefix>
• #delete_markers ⇒ Array<Types::DeleteMarkerEntry>
• #delimiter ⇒ String
• #encoding_type ⇒ String

  Encoding type used by Amazon S3 to encode object keys in the response.

• #is_truncated ⇒ Boolean

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

• #key_marker ⇒ String

  Marks the last Key returned in a truncated response.

• #max_keys ⇒ Integer
• #name ⇒ String
• #next_key_marker ⇒ String

  Use this value for the key marker request parameter in a subsequent request.

• #next_version_id_marker ⇒ String

  Use this value for the next version id marker parameter in a subsequent request.

• #prefix ⇒ String
• #version_id_marker ⇒ String
• #versions ⇒ Array<Types::ObjectVersion>

Instance Method Summary

• #versions_delete_markers ⇒ Object private

  TODO : Remove this customization once the resource code generator correct handles the JMESPath || expression.

Instance Attribute Details

#common_prefixes ⇒ Array<Types::CommonPrefix>

Returns:

• (Array<Types::CommonPrefix>)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#delete_markers ⇒ Array<Types::DeleteMarkerEntry>

Returns:

• (Array<Types::DeleteMarkerEntry>)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#delimiter ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode object keys in the response.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#is_truncated ⇒ Boolean

A flag that indicates whether or not 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)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#key_marker ⇒ String

Marks the last Key returned in a truncated response.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#max_keys ⇒ Integer

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#name ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#next_key_marker ⇒ String

Use this value for the key marker request parameter in a subsequent request.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#next_version_id_marker ⇒ String

Use this value for the next version id marker parameter in a subsequent request.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#prefix ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#version_id_marker ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#versions ⇒ Array<Types::ObjectVersion>

Returns:

• (Array<Types::ObjectVersion>)

# File 'lib/aws-sdk-s3/types.rb', line 5043

class ListObjectVersionsOutput < Struct.new(
  :is_truncated,
  :key_marker,
  :version_id_marker,
  :next_key_marker,
  :next_version_id_marker,
  :versions,
  :delete_markers,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

Instance Method Details

#versions_delete_markers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

TODO : Remove this customization once the resource code

generator correct handles the JMESPath || expression.
Only used by the Bucket#object_versions collection.

# File 'lib/aws-sdk-s3/customizations/types/list_object_versions_output.rb', line 7

def versions_delete_markers
  versions + delete_markers
end