class Google::Cloud::Storage::Bucket::DefaultAcl
# Bucket
Default Access Control List
Represents a Bucket's Default Access Control List
.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.readers.each { |reader| puts reader }
Constants
- RULES
@private
Attributes
A boolean value or a project ID string to indicate the project to be billed for operations on the bucket and its files. If this attribute is set to `true`, transit costs for operations on the bucket will be billed to the current project for this client. (See {Project#project} for the ID of the current project.) If this attribute is set to a project ID, and that project is authorized for the currently authenticated service account, transit costs will be billed to that project. This attribute is required with requester pays-enabled buckets. The default is `nil`.
In general, this attribute should be set when first retrieving the owning bucket by providing the `user_project` option to {Project#bucket}.
See also {Bucket#requester_pays=} and {Bucket#requester_pays}.
Public Class Methods
@private Initialized a new DefaultAcl
object. Must provide a valid Bucket
object.
# File lib/google/cloud/storage/bucket/acl.rb, line 506 def initialize bucket @bucket = bucket.name @service = bucket.service @user_project = bucket.user_project @owners = nil @readers = nil end
@private
# File lib/google/cloud/storage/bucket/acl.rb, line 698 def self.predefined_rule_for rule_name RULES[rule_name.to_s] end
Public Instance Methods
Grants default owner permission to files in the bucket.
@param [String] entity The entity holding the permission, in one of
the following forms: * user-userId * user-email * group-groupId * group-email * domain-domain * project-team-projectId * allUsers * allAuthenticatedUsers
@example Grant access to a user by prepending `“user-”` to an email:
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" email = "heidi@example.net" bucket.default_acl.add_owner "user-#{email}"
@example Grant access to a group by prepending `“group-”` to email:
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" email = "authors@example.net" bucket.default_acl.add_owner "group-#{email}"
# File lib/google/cloud/storage/bucket/acl.rb, line 612 def add_owner entity gapi = @service.insert_default_acl @bucket, entity, "OWNER", user_project: user_project entity = gapi.entity @owners&.push entity entity end
Grants default reader permission to files in the bucket.
@param [String] entity The entity holding the permission, in one of
the following forms: * user-userId * user-email * group-groupId * group-email * domain-domain * project-team-projectId * allUsers * allAuthenticatedUsers
@example Grant access to a user by prepending `“user-”` to an email:
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" email = "heidi@example.net" bucket.default_acl.add_reader "user-#{email}"
@example Grant access to a group by prepending `“group-”` to email:
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" email = "authors@example.net" bucket.default_acl.add_reader "group-#{email}"
# File lib/google/cloud/storage/bucket/acl.rb, line 655 def add_reader entity gapi = @service.insert_default_acl @bucket, entity, "READER", user_project: user_project entity = gapi.entity @readers&.push entity entity end
Convenience method to apply the default `authenticatedRead` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.auth!
# File lib/google/cloud/storage/bucket/acl.rb, line 717 def auth! update_predefined_default_acl! "authenticatedRead" end
Permanently deletes the entity from the bucket's default access control list for files.
@param [String] entity The entity holding the permission, in one of
the following forms: * user-userId * user-email * group-groupId * group-email * domain-domain * project-team-projectId * allUsers * allAuthenticatedUsers
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" email = "heidi@example.net" bucket.default_acl.delete "user-#{email}"
# File lib/google/cloud/storage/bucket/acl.rb, line 689 def delete entity @service.delete_default_acl @bucket, entity, user_project: user_project @owners&.delete entity @readers&.delete entity true end
Convenience method to apply the default `bucketOwnerFullControl` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.owner_full!
# File lib/google/cloud/storage/bucket/acl.rb, line 738 def owner_full! update_predefined_default_acl! "bucketOwnerFullControl" end
Convenience method to apply the default `bucketOwnerRead` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.owner_read!
# File lib/google/cloud/storage/bucket/acl.rb, line 756 def owner_read! update_predefined_default_acl! "bucketOwnerRead" end
Lists the default owners for files in the bucket.
@return [Array<String>]
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.owners.each { |owner| puts owner }
# File lib/google/cloud/storage/bucket/acl.rb, line 553 def owners reload! if @owners.nil? @owners end
Convenience method to apply the default `private` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.private!
# File lib/google/cloud/storage/bucket/acl.rb, line 774 def private! update_predefined_default_acl! "private" end
Convenience method to apply the default `projectPrivate` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.project_private!
# File lib/google/cloud/storage/bucket/acl.rb, line 791 def project_private! update_predefined_default_acl! "projectPrivate" end
Convenience method to apply the default `publicRead` predefined ACL rule to files in the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.public!
# File lib/google/cloud/storage/bucket/acl.rb, line 809 def public! update_predefined_default_acl! "publicRead" end
Lists the default readers for files in the bucket.
@return [Array<String>]
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.readers.each { |reader| puts reader }
# File lib/google/cloud/storage/bucket/acl.rb, line 572 def readers reload! if @readers.nil? @readers end
Reloads all Default Access Control List
data for the bucket.
@example
require "google/cloud/storage" storage = Google::Cloud::Storage.new bucket = storage.bucket "my-bucket" bucket.default_acl.reload!
# File lib/google/cloud/storage/bucket/acl.rb, line 526 def reload! gapi = @service.list_default_acls @bucket, user_project: user_project acls = Array(gapi.items).map do |acl| next acl if acl.is_a? Google::Apis::StorageV1::ObjectAccessControl raise "Unknown ACL format: #{acl.class}" unless acl.is_a? Hash Google::Apis::StorageV1::ObjectAccessControl.from_json acl.to_json end @owners = entities_from_acls acls, "OWNER" @readers = entities_from_acls acls, "READER" end
Protected Instance Methods
# File lib/google/cloud/storage/bucket/acl.rb, line 817 def clear! @owners = nil @readers = nil self end
# File lib/google/cloud/storage/bucket/acl.rb, line 829 def entities_from_acls acls, role selected = acls.select { |acl| acl.role == role } selected.map(&:entity) end
# File lib/google/cloud/storage/bucket/acl.rb, line 823 def update_predefined_default_acl! acl_role @service.patch_bucket @bucket, predefined_default_acl: acl_role, user_project: user_project clear! end