Class: Aws::RDS::DBLogFile

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-rds/db_log_file.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_id, name, options = {}) ⇒ DBLogFile #initialize(options = {}) ⇒ DBLogFile

Returns a new instance of DBLogFile.

Overloads:

  • #initialize(instance_id, name, options = {}) ⇒ DBLogFile

    Parameters:

    • instance_id (String)
    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBLogFile

    Options Hash (options):

    • :instance_id (required, String)
    • :name (required, String)
    • :client (Client) 


24
25
26
27
28
29
30
31
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 24

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @instance_id = extract_instance_id(args, options)
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#client ⇒ Client

Returns:



61
62
63
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 61

def client
  @client
end

#data ⇒ Types::DescribeDBLogFilesDetails

Returns the data for this Aws::RDS::DBLogFile.

Returns:

Raises:

  • (NotImplementedError) —

    Raises when #data_loaded? is ‘false`.



76
77
78
79
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 76

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



84
85
86
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 84

def data_loaded?
  !!@data
end

#download(options = {}) ⇒ Types::DownloadDBLogFilePortionDetails

Examples:

Request syntax with placeholder values


db_log_file.download({
  marker: "String",
  number_of_lines: 1,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :marker (String) —

    The pagination token provided in the previous request or “0”. If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

  • :number_of_lines (Integer) —

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

    • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

    • If NumberOfLines is specified and Marker isn’t specified, then the most recent lines from the end of the log file are returned.

    • If Marker is specified as “0”, then the specified number of lines from the beginning of the log file are returned.

    • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of “0” for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

Returns:



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 226

def download(options = {})
  options = options.merge(
    db_instance_identifier: @instance_id,
    log_file_name: @name
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.download_db_log_file_portion(options)
  end
  resp.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.

Deprecated. 


239
240
241
242
243
244
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 239

def identifiers
  {
    instance_id: @instance_id,
    name: @name
  }
end

#instance_id ⇒ String

Returns:

  • (String) 


36
37
38
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 36

def instance_id
  @instance_id
end

#last_written ⇒ Integer

A POSIX timestamp when the last log entry was written.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 48

def last_written
  data[:last_written]
end

#load ⇒ Object Also known as: reload

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.

Raises:

  • (NotImplementedError) 


67
68
69
70
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 67

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#name ⇒ String Also known as: log_file_name

Returns:

  • (String) 


41
42
43
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 41

def name
  @name
end

#size ⇒ Integer

The size, in bytes, of the log file for the specified DB instance.

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 54

def size
  data[:size]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

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(options) {|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

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/aws-sdk-rds/db_log_file.rb', line 168

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end