Class: Google::Cloud::Storage::Bucket::Acl
- Inherits:
-
Object
- Object
- Google::Cloud::Storage::Bucket::Acl
- Defined in:
- lib/google/cloud/storage/bucket/acl.rb
Overview
Bucket Access Control List
Represents a Bucket's Access Control List.
Instance Method Summary collapse
-
#add_owner(entity) ⇒ Object
Grants owner permission to the bucket.
-
#add_reader(entity) ⇒ Object
Grants reader permission to the bucket.
-
#add_writer(entity) ⇒ Object
Grants writer permission to the bucket.
-
#auth! ⇒ Object
(also: #authenticatedRead!, #auth_read!, #authenticated!, #authenticated_read!)
Convenience method to apply the
authenticatedRead
predefined ACL rule to the bucket. -
#delete(entity) ⇒ Object
Permanently deletes the entity from the bucket's access control list.
-
#owners ⇒ Array<String>
Lists the owners of the bucket.
-
#private! ⇒ Object
Convenience method to apply the
private
predefined ACL rule to the bucket. -
#project_private! ⇒ Object
(also: #projectPrivate!)
Convenience method to apply the
projectPrivate
predefined ACL rule to the bucket. -
#public! ⇒ Object
(also: #publicRead!, #public_read!)
Convenience method to apply the
publicRead
predefined ACL rule to the bucket. -
#public_write! ⇒ Object
(also: #publicReadWrite!)
Convenience method to apply the
publicReadWrite
predefined ACL rule to the bucket. -
#readers ⇒ Array<String>
Lists the readers of the bucket.
-
#reload! ⇒ Object
(also: #refresh!)
Reloads all Access Control List data for the bucket.
-
#writers ⇒ Array<String>
Lists the owners of the bucket.
Instance Method Details
#add_owner(entity) ⇒ Object
Grants owner permission to the bucket.
175 176 177 178 179 180 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 175 def add_owner entity gapi = @service.insert_bucket_acl @bucket, entity, "OWNER" entity = gapi.entity @owners.push entity unless @owners.nil? entity end |
#add_reader(entity) ⇒ Object
Grants reader permission to the bucket.
259 260 261 262 263 264 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 259 def add_reader entity gapi = @service.insert_bucket_acl @bucket, entity, "READER" entity = gapi.entity @readers.push entity unless @readers.nil? entity end |
#add_writer(entity) ⇒ Object
Grants writer permission to the bucket.
217 218 219 220 221 222 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 217 def add_writer entity gapi = @service.insert_bucket_acl @bucket, entity, "WRITER" entity = gapi.entity @writers.push entity unless @writers.nil? entity end |
#auth! ⇒ Object Also known as: authenticatedRead!, auth_read!, authenticated!, authenticated_read!
Convenience method to apply the authenticatedRead
predefined ACL
rule to the bucket.
320 321 322 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 320 def auth! update_predefined_acl! "authenticatedRead" end |
#delete(entity) ⇒ Object
Permanently deletes the entity from the bucket's access control list.
292 293 294 295 296 297 298 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 292 def delete entity @service.delete_bucket_acl @bucket, entity @owners.delete entity unless @owners.nil? @writers.delete entity unless @writers.nil? @readers.delete entity unless @readers.nil? true end |
#owners ⇒ Array<String>
Lists the owners of the bucket.
97 98 99 100 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 97 def owners reload! if @owners.nil? @owners end |
#private! ⇒ Object
Convenience method to apply the private
predefined ACL
rule to the bucket.
341 342 343 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 341 def private! update_predefined_acl! "private" end |
#project_private! ⇒ Object Also known as: projectPrivate!
Convenience method to apply the projectPrivate
predefined ACL
rule to the bucket.
358 359 360 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 358 def project_private! update_predefined_acl! "projectPrivate" end |
#public! ⇒ Object Also known as: publicRead!, public_read!
Convenience method to apply the publicRead
predefined ACL
rule to the bucket.
376 377 378 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 376 def public! update_predefined_acl! "publicRead" end |
#public_write! ⇒ Object Also known as: publicReadWrite!
Convenience method to apply the publicReadWrite
predefined ACL
rule to the bucket.
394 395 396 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 394 def public_write! update_predefined_acl! "publicReadWrite" end |
#readers ⇒ Array<String>
Lists the readers of the bucket.
135 136 137 138 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 135 def readers reload! if @readers.nil? @readers end |
#reload! ⇒ Object Also known as: refresh!
Reloads all Access Control List data for the bucket.
74 75 76 77 78 79 80 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 74 def reload! gapi = @service.list_bucket_acls @bucket acls = Array(gapi.items) @owners = entities_from_acls acls, "OWNER" @writers = entities_from_acls acls, "WRITER" @readers = entities_from_acls acls, "READER" end |
#writers ⇒ Array<String>
Lists the owners of the bucket.
116 117 118 119 |
# File 'lib/google/cloud/storage/bucket/acl.rb', line 116 def writers reload! if @writers.nil? @writers end |