Class: Aws::S3::Types::ListObjectsV2Output
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListObjectsV2Output
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
Instance Attribute Summary collapse
-
#common_prefixes ⇒ Array<Types::CommonPrefix>
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter.
-
#contents ⇒ Array<Types::Object>
Metadata about each object returned.
-
#continuation_token ⇒ String
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.
-
#delimiter ⇒ String
A delimiter is a character you use to group keys.
-
#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_count ⇒ Integer
KeyCount is the number of keys returned with this request.
-
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response.
-
#name ⇒ String
Name of the bucket to list.
-
#next_continuation_token ⇒ String
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed.
-
#prefix ⇒ String
Limits the response to keys that begin with the specified prefix.
-
#start_after ⇒ String
StartAfter is where you want Amazon S3 to start listing from.
Instance Attribute Details
#common_prefixes ⇒ Array<Types::CommonPrefix>
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#contents ⇒ Array<Types::Object>
Metadata about each object returned.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#continuation_token ⇒ String
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#delimiter ⇒ String
A delimiter is a character you use to group keys.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#encoding_type ⇒ String
Encoding type used by Amazon S3 to encode object keys in the response.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) 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.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#key_count ⇒ Integer
KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#max_keys ⇒ Integer
Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#name ⇒ String
Name of the bucket to list.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#next_continuation_token ⇒ String
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#prefix ⇒ String
Limits the response to keys that begin with the specified prefix.
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |
#start_after ⇒ String
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket
5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 |
# File 'lib/aws-sdk-s3/types.rb', line 5302 class ListObjectsV2Output < Struct.new( :is_truncated, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :key_count, :continuation_token, :next_continuation_token, :start_after) include Aws::Structure end |