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

Module: AWS::S3::ACLObject

Included in:
AccessControlList, AWS::S3::AccessControlList::Grant, AWS::S3::AccessControlList::Grantee, AWS::S3::AccessControlList::Owner, AWS::S3::AccessControlList::Permission
Defined in:
lib/aws/s3/acl_object.rb

Overview

Common methods for AccessControlList and related objects.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(m) ⇒ Object 



258
259
260
 
# File 'lib/aws/s3/acl_object.rb', line 258

def self.included(m)
  m.extend(ClassMethods)
end

Instance Method Details

#to_s ⇒ Object

Returns the XML representation of the object. Generally you'll want to call this on an AccessControlList object, which will yield an XML representation of the ACL that you can send to S3.



42
43
44
45
46
47
48
 
# File 'lib/aws/s3/acl_object.rb', line 42

def to_s
  if body_xml.empty?
    "<#{stag}/>"
  else
    "<#{stag}>#{body_xml}</#{element_name}>"
  end
end

#to_xml ⇒ Object

Returns the XML representation of the object. Generally you'll want to call this on an AccessControlList object, which will yield an XML representation of the ACL that you can send to S3.



51
52
53
 
# File 'lib/aws/s3/acl_object.rb', line 51

def to_xml
  to_s
end

#valid? ⇒ Boolean

Returns true if and only if this object is valid according to S3's published ACL schema. In particular, this will check that all required attributes are provided and that they are of the correct type.

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
 
# File 'lib/aws/s3/acl_object.rb', line 59

def valid?
  validate!
rescue => e
  false
else
  true
end

#validate! ⇒ Object

Raises an exception unless this object is valid according to S3's published ACL schema.

See Also:



70
 
# File 'lib/aws/s3/acl_object.rb', line 70

def validate!; end