Module AWS::S3::PrefixedCollection
In: lib/aws/s3/prefixed_collection.rb

Methods

Included Modules

PaginatedCollection

Attributes

prefix  [R]  @return [String,nil] The prefix of this collection.

Public Class methods

@private

Public Instance methods

Returns a new collection with a different prefix

@example

  objects = collection.with_prefix('photos')
  objects.prefix #=> 'photos'

@example Chaining with_prefix replaces previous prefix

  objects = collection.with_prefix('photos').with_prefix('videos')
  objects.prefix #=> 'videos'

@example Chaining with_prefix with :append

  objects = collection.with_prefix('a/').with_prefix('b/', :append)
  objects.prefix #=> 'a/b/'

@example Chaining with_prefix with :prepend

  objects = collection.with_prefix('a/').with_prefix('b/', :prepend)
  objects.prefix #=> 'b/a/'

@param [String] prefix The prefix condition that limits what objects

  are returned by this collection.

@param [Symbol] mode (:replace) If you chain calls to with_prefix

  the +mode+ affects if the prefix prepends, appends, or replaces.
  Valid modes are:
  * +:replace+
  * +:append+
  * +:prepend+

@return [Collection] Returns a new collection with a modified prefix.

Protected Instance methods

[Validate]