Class: Aws::S3::BucketLogging
- Inherits:
-
Object
- Object
- Aws::S3::BucketLogging
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-s3/bucket_logging.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
- #bucket_name ⇒ String
-
#logging_enabled ⇒ Types::LoggingEnabled
Container for logging information.
Actions collapse
Associations collapse
- #bucket ⇒ Bucket
- #identifiers ⇒ Object deprecated private Deprecated.
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::GetBucketLoggingOutput
Returns the data for this BucketLogging.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ BucketLogging
constructor
A new instance of BucketLogging.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current BucketLogging.
-
#wait_until(options = {}, &block) ⇒ Resource
deprecated
Deprecated.
Use [Aws::S3::Client] #wait_until instead
Constructor Details
#initialize(bucket_name, options = {}) ⇒ BucketLogging #initialize(options = {}) ⇒ BucketLogging
Returns a new instance of BucketLogging.
19 20 21 22 23 24 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 19 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @bucket_name = extract_bucket_name(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#bucket ⇒ Bucket
209 210 211 212 213 214 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 209 def bucket Bucket.new( name: @bucket_name, client: @client ) end |
#bucket_name ⇒ String
29 30 31 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 29 def bucket_name @bucket_name end |
#data ⇒ Types::GetBucketLoggingOutput
Returns the data for this Aws::S3::BucketLogging. Calls Client#get_bucket_logging if #data_loaded? is ‘false`.
64 65 66 67 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 64 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
72 73 74 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 72 def data_loaded? !!@data 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.
218 219 220 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 218 def identifiers { bucket_name: @bucket_name } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::S3::BucketLogging. Returns ‘self` making it possible to chain methods.
bucket_logging.reload.data
54 55 56 57 58 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 54 def load resp = @client.get_bucket_logging(bucket: @bucket_name) @data = resp.data self end |
#logging_enabled ⇒ Types::LoggingEnabled
Container for logging information. Presence of this element indicates that logging is enabled. Parameters TargetBucket and TargetPrefix are required in this case.
37 38 39 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 37 def logging_enabled data[:logging_enabled] end |
#put(options = {}) ⇒ EmptyStructure
200 201 202 203 204 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 200 def put( = {}) = .merge(bucket: @bucket_name) resp = @client.put_bucket_logging() resp.data end |
#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }
## 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
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/aws-sdk-s3/bucket_logging.rb', line 154 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 |