Class: RubyAem::Resources::FlushAgent

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_aem/resources/flush_agent.rb

Overview

FlushAgent class contains API calls related to managing an AEM flush agent.

Instance Method Summary collapse

Constructor Details

#initialize(client, run_mode, name) ⇒ Object

Initialise a flush agent.

Parameters:

  • client —

    RubyAem::Client

  • run_mode —

    AEM run mode: author or publish

  • name —

    the flush agent’s name, e.g. some-flush-agent



28
29
30
31
32
33
34
 
# File 'lib/ruby_aem/resources/flush_agent.rb', line 28

def initialize(client, run_mode, name)
  @client = client
  @call_params = {
    run_mode: run_mode,
    name: name
  }
end

Instance Method Details

#create_update(title, description, dest_base_url, opts = { log_level: 'error', retry_delay: 30000 }) ⇒ Object

Create or update a flush agent.

  • log_level: error, info, debug, default is error

  • retry_delay: in milliseconds, default is 30000

Parameters:

  • title —

    flush agent title

  • description —

    flush agent description

  • dest_base_url —

    base URL of the agent target destination, e.g. somedispatcher:8080

  • opts (defaults to: { log_level: 'error', retry_delay: 30000 }) —

    optional parameters:

Returns:

  • RubyAem::Result



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ruby_aem/resources/flush_agent.rb', line 45

def create_update(title, description, dest_base_url,
    opts = {
      log_level: 'error',
      retry_delay: 30000
    })
  @call_params[:title] = title
  @call_params[:description] = description
  @call_params[:dest_base_url] = dest_base_url
  @call_params = @call_params.merge(opts)
  @client.call(self.class, __callee__.to_s, @call_params)
end

#delete ⇒ Object

Delete the flush agent.

Returns:

  • RubyAem::Result



60
61
62
 
# File 'lib/ruby_aem/resources/flush_agent.rb', line 60

def delete()
  @client.call(self.class, __callee__.to_s, @call_params)
end

#exists ⇒ Object

Check whether the flush agent exists or not. If the flush agent exists, this method returns a true result data, false otherwise.

Returns:

  • RubyAem::Result



69
70
71
 
# File 'lib/ruby_aem/resources/flush_agent.rb', line 69

def exists()
  @client.call(self.class, __callee__.to_s, @call_params)
end