Class: Aws::S3::ObjectAcl
- Inherits:
-
Object
- Object
- Aws::S3::ObjectAcl
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/object_acl.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#grants ⇒ Array<Types::Grant>
A list of grants.
- #object_key ⇒ String
-
#owner ⇒ Types::Owner
Container for the bucket owner’s display name and ID.
-
#request_charged ⇒ String
If present, indicates that the requester was successfully charged for the request.
Actions collapse
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #object ⇒ Object
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetObjectAclOutput
Returns the data for this ObjectAcl.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ ObjectAcl
constructor
A new instance of ObjectAcl.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, object_key, options = {}) ⇒ ObjectAcl #initialize(options = {}) ⇒ ObjectAcl
Returns a new instance of ObjectAcl.
24 25 26 27 28 29 30 31 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 24 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @object_key = extract_object_key(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#bucket_name ⇒ String
36 37 38 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 36 def bucket_name @bucket_name end |
#data ⇒ Types::GetObjectAclOutput
Returns the data for this Aws::S3::ObjectAcl. Calls Client#get_object_acl if #data_loaded? is ‘false`.
90 91 92 93 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 90 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
98 99 100 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 98 def data_loaded? !!@data end |
#grants ⇒ Array<Types::Grant>
A list of grants.
53 54 55 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 53 def grants data[:grants] end |
#identifiers ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
334 335 336 337 338 339 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 334 def identifiers { bucket_name: @bucket_name, object_key: @object_key } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::ObjectAcl. Returns ‘self` making it possible to chain methods.
object_acl.reload.data
77 78 79 80 81 82 83 84 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 77 def load resp = @client.get_object_acl( bucket: @bucket_name, key: @object_key ) @data = resp.data self end |
#object ⇒ Object
324 325 326 327 328 329 330 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 324 def object Object.new( bucket_name: @bucket_name, key: @object_key, client: @client ) end |
#object_key ⇒ String
41 42 43 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 41 def object_key @object_key end |
#owner ⇒ Types::Owner
Container for the bucket owner’s display name and ID.
47 48 49 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 47 def owner data[:owner] end |
#put(options = {}) ⇒ Types::PutObjectAclOutput
312 313 314 315 316 317 318 319 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 312 def put( = {}) = .merge( bucket: @bucket_name, key: @object_key ) resp = @client.put_object_acl() resp.data end |
#request_charged ⇒ String
If present, indicates that the requester was successfully charged for the request.
60 61 62 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 60 def request_charged data[:request_charged] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::S3::Client] #wait_until instead
The waiting operation is performed on a copy. The original resource remains unchanged.
Waiter polls an API operation until a resource enters a desired state.
## Basic Usage
Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop until condition is true
resource.wait_until() {|resource| condition}
## Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
## Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
# File 'lib/aws-sdk-s3/object_acl.rb', line 182 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |