Module: Idcf::Ilb::ClientExtensions::Fwgroup

Included in:
Idcf::Ilb::Client
Defined in:
lib/idcf/ilb/client_extensions/fwgroup.rb

Overview

SDK APIs for fwgroup resource

Instance Method Summary collapse

Instance Method Details

#create_fwgroup(attributes, headers = {}) ⇒ Response

Create a new fwgroup.

Parameters:

  • attributes (Hash) —

    request attributes

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

    HTTP request headers

Options Hash (attributes):

  • :name (String) —

    unique name of fwgroup (required)

Returns:



12
13
14
15
16
 
# File 'lib/idcf/ilb/client_extensions/fwgroup.rb', line 12

def create_fwgroup(attributes, headers = {})
  Validators::Fwgroup.validate_attributes!(attributes, :create)
  res = post!("fwgroups", attributes, headers)
  check_job(res.body["job_id"], headers, ["get_fwgroup"])
end

#delete_fwgroup(id, headers = {}) ⇒ Boolean

Delete a fwgroup

Parameters:

  • id (String) —

    ID of target fwgroup

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

    HTTP request headers

Returns:

  • (Boolean) —

    delete success = true



40
41
42
43
 
# File 'lib/idcf/ilb/client_extensions/fwgroup.rb', line 40

def delete_fwgroup(id, headers = {})
  res = delete!("fwgroups/#{id}", {}, headers)
  check_job(res.body["job_id"], headers)
end

#fwgroups(headers = {}) ⇒ Array<Resources::Fwgroup>

Get an array of existing fwgroup objects.

Parameters:

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

    HTTP request headers

Returns:



49
50
51
52
53
 
# File 'lib/idcf/ilb/client_extensions/fwgroup.rb', line 49

def fwgroups(headers = {})
  list_fwgroups(headers).resources.map do |fwgroup|
    Resources::Fwgroup.new(self, fwgroup)
  end
end

#get_fwgroup(id, headers = {}) ⇒ Response

Get a fwgroup

Parameters:

  • id (String) —

    ID of target fwgroup

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

    HTTP request headers

Returns:



31
32
33
 
# File 'lib/idcf/ilb/client_extensions/fwgroup.rb', line 31

def get_fwgroup(id, headers = {})
  get!("fwgroups/#{id}", {}, headers)
end

#list_fwgroups(headers = {}) ⇒ Response

Get list of existing fwgroups

Parameters:

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

    HTTP request headers

Returns:



22
23
24
 
# File 'lib/idcf/ilb/client_extensions/fwgroup.rb', line 22

def list_fwgroups(headers = {})
  get!("fwgroups", {}, headers)
end