Module: Idcf::Ilb::ClientExtensions::Sslcert

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

Overview

SDK APIs for sslcert resource

Instance Method Summary collapse

Instance Method Details

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

Create a new sslcert.

Parameters:

  • attributes (Hash)

    request attributes

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

    HTTP request headers

Options Hash (attributes):

  • :name (String)

    unique name of sslcert (required)

Returns:



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

def create_sslcert(attributes, headers = {})
  fixed_attributes = { type: "system" }
  attributes.merge!(fixed_attributes)
  Validators::Sslcert.validate_attributes!(attributes, :create)
  res = post!("sslcerts", attributes, headers)
  check_job(res.body["job_id"], headers, ["get_sslcert"])
end

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

Delete a sslcert

Parameters:

  • id (String)

    ID of target sslcert

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

    HTTP request headers

Returns:

  • (Boolean)

    delete success = true



62
63
64
65
# File 'lib/idcf/ilb/client_extensions/sslcert.rb', line 62

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

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

Get a sslcert

Parameters:

  • id (String)

    ID of target sslcert

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

    HTTP request headers

Returns:



53
54
55
# File 'lib/idcf/ilb/client_extensions/sslcert.rb', line 53

def get_sslcert(id, headers = {})
  get!("sslcerts/#{id}", {}, headers)
end

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

Get list of existing sslcerts

Parameters:

  • attributes (Hash) (defaults to: {})

    request attributes

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

    HTTP request headers

Options Hash (attributes):

  • :name (String)

    unique name of sslcert (optional)

Returns:



43
44
45
46
# File 'lib/idcf/ilb/client_extensions/sslcert.rb', line 43

def list_sslcerts(attributes = {}, headers = {})
  Validators::Sslcert.validate_attributes!(attributes, :list)
  get!("sslcerts", attributes, headers)
end

#sslcerts(headers = {}) ⇒ Array<Resources::Sslcert>

Get an array of existing sslcert objects.

Parameters:

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

    HTTP request headers

Returns:



71
72
73
74
75
# File 'lib/idcf/ilb/client_extensions/sslcert.rb', line 71

def sslcerts(headers = {})
  list_sslcerts({}, headers).resources.map do |sslcert|
    Resources::Sslcert.new(self, sslcert)
  end
end

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

Upload a sslcert.

Parameters:

  • attributes (Hash)

    request attributes

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

    HTTP request headers

Options Hash (attributes):

  • :name (String)

    unique name of sslcert (required)

  • :certificate (String)

    certificate of sslcert (required)

  • :private_key (String)

    private_key of sslcert (required)

  • :certificate_chain (String)

    certificate_chain of sslcert (optional)

Returns:



29
30
31
32
33
34
35
# File 'lib/idcf/ilb/client_extensions/sslcert.rb', line 29

def upload_sslcert(attributes, headers = {})
  fixed_attributes = { type: "self" }
  attributes.merge!(fixed_attributes)
  Validators::Sslcert.validate_attributes!(attributes, :upload)
  res = post!("sslcerts", attributes, headers)
  check_job(res.body["job_id"], headers, ["get_sslcert"])
end