Class: MintPress::Aws::S3::ObjectVersion

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb

Properties (Read/Write)

  • #bucket ⇒ [String]
    'The bucket name that contains the objects.'
    Property Attributes
    • list_object_versions_prop ⇒ 'bucket'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

26
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 26

property :bucket, list_object_versions_prop: 'bucket', type: [String], read_only: false, source: "list_object_versions", description: 'The bucket name that contains the objects.'
  • #delimiter ⇒ [String]
    '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.'
    Property Attributes
    • list_object_versions_prop ⇒ 'delimiter'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

27
28
29
30
31
32
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 27

property :delimiter, list_object_versions_prop: 'delimiter', type: [String], read_only: false, source: "list_object_versions", description: '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.'
  • #encoding_type ⇒ [String]
    'Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.'
    Property Attributes
    • list_object_versions_prop ⇒ 'encoding_type'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

33
34
35
36
37
38
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 33

property :encoding_type, list_object_versions_prop: 'encoding_type', type: [String], read_only: false, source: "list_object_versions", description: 'Requests Amazon S3 to encode the object keys in the response and
specifies the encoding method to use. An object key may contain any
Unicode character; however, XML 1.0 parser cannot parse some
characters, such as characters with an ASCII value from 0 to 10. For
characters that are not supported in XML 1.0, you can add this
parameter to request that Amazon S3 encode the keys in the response.'
  • #key_marker ⇒ [String]
    'Specifies the key to start with when listing objects in a bucket.'
    Property Attributes
    • list_object_versions_prop ⇒ 'key_marker'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

39
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 39

property :key_marker, list_object_versions_prop: 'key_marker', type: [String], read_only: false, source: "list_object_versions", description: 'Specifies the key to start with when listing objects in a bucket.'
  • #max_keys ⇒ [Integer]
    'Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains true. To return the additional keys, see key-marker and version-id-marker.'
    Property Attributes
    • list_object_versions_prop ⇒ 'max_keys'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

40
41
42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 40

property :max_keys, list_object_versions_prop: 'max_keys', type: [Integer], read_only: false, source: "list_object_versions", description: 'Sets the maximum number of keys returned in the response. By default
the API returns up to 1,000 key names. The response might contain
fewer keys but will never contain more. If additional keys satisfy the
search criteria, but were not returned because max-keys was exceeded,
the response contains <isTruncated>true</isTruncated>. To
return the additional keys, see key-marker and version-id-marker.'
  • #prefix ⇒ [String]
    'Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you"d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.'
    Property Attributes
    • list_object_versions_prop ⇒ 'prefix'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

46
47
48
49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 46

property :prefix, list_object_versions_prop: 'prefix', type: [String], read_only: false, source: "list_object_versions", description: 'Use this parameter to select only those keys that begin with the
specified prefix. You can use prefixes to separate a bucket into
different groupings of keys. (You can think of using prefix to make
groups in the same way you"d use a folder in a file system.) You can
use prefix with delimiter to roll up numerous objects into a single
result under CommonPrefixes.'
  • #version_id_marker ⇒ [String]
    'Specifies the object version you want to start listing from.'
    Property Attributes
    • list_object_versions_prop ⇒ 'version_id_marker'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 52

property :version_id_marker, list_object_versions_prop: 'version_id_marker', type: [String], read_only: false, source: "list_object_versions", description: 'Specifies the object version you want to start listing from.'
  • #expected_bucket_owner ⇒ [String]
    'The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.'
    Property Attributes
    • list_object_versions_prop ⇒ 'expected_bucket_owner'
    • read_only ⇒ false
    • source ⇒ "list_object_versions"
    

53
54
55
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 53

property :expected_bucket_owner, list_object_versions_prop: 'expected_bucket_owner', type: [String], read_only: false, source: "list_object_versions", description: 'The account id of the expected bucket owner. If the bucket is owned by
a different account, the request will fail with an HTTP 403 (Access
Denied) error.'
  • #object ⇒ [MintPress::Aws::S3::Object] (Default Value: MintPress::Aws::S3::Object.new)

    Property Attributes
    • disposition ⇒ :association
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'object'
    • default ⇒ MintPress::Aws::S3::Object.new
    

59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 59

property :object, disposition: :association, source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'object', type: [MintPress::Aws::S3::Object], default: MintPress::Aws::S3::Object.new
  • #name ⇒ [String]

    Property Attributes 
    

60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 60

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

64
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 64

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

67
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 67

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

  • #etag ⇒ [String]
    'The entity tag is an MD5 hash of that version of the object.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'etag'
    • read_only ⇒ true
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 19

property :etag, disposition: :read_only_attribute, description: 'The entity tag is an MD5 hash of that version of the object.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'etag', type: [String], read_only: true
  • #is_latest ⇒ [TrueClass,FalseClass]
    'Specifies whether the object is (true) or is not (false) the latest version of an object.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'is_latest'
    • read_only ⇒ true
    

20
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 20

property :is_latest, disposition: :read_only_attribute, description: 'Specifies whether the object is (true) or is not (false) the latest version of an object.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'is_latest', type: [TrueClass,FalseClass], read_only: true
  • #key ⇒ [String]
    'The object key.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'key'
    • read_only ⇒ true
    

21
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 21

property :key, disposition: :read_only_attribute, description: 'The object key.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'key', type: [String], read_only: true
  • #last_modified ⇒ [Time]
    'Date and time the object was last modified.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'last_modified'
    • read_only ⇒ true
    

22
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 22

property :last_modified, disposition: :read_only_attribute, description: 'Date and time the object was last modified.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'last_modified', type: [Time], read_only: true
  • #owner ⇒ [MintPress::Aws::S3::Owner] (Default Value: MintPress::Aws::S3::Owner.new)
    'Specifies the owner of the object.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'owner'
    • default ⇒ MintPress::Aws::S3::Owner.new
    • read_only ⇒ true
    

23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 23

property :owner, disposition: :read_only_attribute, description: 'Specifies the owner of the object.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'owner', type: [MintPress::Aws::S3::Owner], default: MintPress::Aws::S3::Owner.new, read_only: true
  • #size ⇒ [Integer]
    'Size in bytes of the object.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'size'
    • read_only ⇒ true
    

24
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 24

property :size, disposition: :read_only_attribute, description: 'Size in bytes of the object.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'size', type: [Integer], read_only: true
  • #storage_class ⇒ [String]
    'The class of storage used to store the object.'
    Property Attributes
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'storage_class'
    • read_only ⇒ true
    

25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 25

property :storage_class, disposition: :read_only_attribute, description: 'The class of storage used to store the object.', source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'storage_class', type: [String], read_only: true
  • #bucket_name ⇒ [String] (Default Value: Proc.new { self.name })

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'bucket_name'
    • default ⇒ Proc.new { self.name }
    

56
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 56

property :bucket_name, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'bucket_name', type: [String], default: Proc.new { self.name }
  • #id ⇒ [String]
    'Version ID of an object.'
    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'version_id'
    

57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 57

property :id, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'version_id', type: [String], description: 'Version ID of an object.', array: false, hash: false
  • #object_key ⇒ [String]

    Property Attributes
    • read_only ⇒ true
    • disposition ⇒ :read_only_attribute
    • source ⇒ "MintPress::Aws::S3::ObjectVersion"
    • orig_name ⇒ 'object_key'
    

58
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/s3/object_version.rb', line 58

property :object_key, read_only: true, disposition: :read_only_attribute, source: "MintPress::Aws::S3::ObjectVersion", orig_name: 'object_key', type: [String]

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ ObjectVersion

Returns a new instance of ObjectVersion.

Instance Method Details

#list ⇒ Object