class NgrokAPI::Services::FailoverBackendsClient

A Failover backend defines failover behavior within a list of referenced

backends. Traffic is sent to the first backend in the list. If that backend
is offline or no connection can be established, ngrok attempts to connect to
the next backend in the list until one is successful.

ngrok.com/docs/api#api-failover-backends

Constants

LIST_PROPERTY

The List Property from the resulting API for list calls

PATH

The API path for the requests

Attributes

client[R]

Public Class Methods

new(client:) click to toggle source
# File lib/ngrokapi/services/failover_backends_client.rb, line 20
def initialize(client:)
  @client = client
end

Public Instance Methods

create(description: "", metadata: "", backends: []) click to toggle source

Create a new Failover backend

@param [string] description human-readable description of this backend. Optional @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional @param [List<string>] backends the ids of the child backends in order @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-create

# File lib/ngrokapi/services/failover_backends_client.rb, line 33
def create(description: "", metadata: "", backends: [])
  path = '/backends/failover'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:backends] = backends if backends
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end
create!(description: "", metadata: "", backends: []) click to toggle source

Create a new Failover backend Throws an exception if API error.

@param [string] description human-readable description of this backend. Optional @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional @param [List<string>] backends the ids of the child backends in order @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-create

# File lib/ngrokapi/services/failover_backends_client.rb, line 55
def create!(description: "", metadata: "", backends: [])
  path = '/backends/failover'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:backends] = backends if backends
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end
delete(id: "") click to toggle source

Delete a Failover backend by ID.

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

ngrok.com/docs/api#api-failover-backends-delete

# File lib/ngrokapi/services/failover_backends_client.rb, line 74
def delete(id: "")
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end
delete!(id: "") click to toggle source

Delete a Failover backend by ID. Throws an exception if API error.

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

ngrok.com/docs/api#api-failover-backends-delete

# File lib/ngrokapi/services/failover_backends_client.rb, line 90
def delete!(id: "")
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end
get(id: "") click to toggle source

Get detailed information about a Failover backend by ID

@param [string] id a resource identifier @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-get

# File lib/ngrokapi/services/failover_backends_client.rb, line 105
def get(id: "")
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end
get!(id: "") click to toggle source

Get detailed information about a Failover backend by ID Throws an exception if API error.

@param [string] id a resource identifier @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-get

# File lib/ngrokapi/services/failover_backends_client.rb, line 123
def get!(id: "")
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end
list(before_id: nil, limit: nil, url: nil) click to toggle source

List all Failover backends on this account

@param [string] before_id @param [string] limit @param [string] url optional and mutually exclusive from before_id and limit @return [NgrokAPI::Models::Listable] result from the API request

ngrok.com/docs/api#api-failover-backends-list

# File lib/ngrokapi/services/failover_backends_client.rb, line 142
def list(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::FailoverBackend
  )
end
list!(before_id: nil, limit: nil, url: nil) click to toggle source

List all Failover backends on this account Throws an exception if API error.

@param [string] before_id @param [string] limit @param [string] url optional and mutually exclusive from before_id and limit @return [NgrokAPI::Models::Listable] result from the API request

ngrok.com/docs/api#api-failover-backends-list

# File lib/ngrokapi/services/failover_backends_client.rb, line 168
def list!(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::FailoverBackend,
    danger: true
  )
end
update(id: "", description: nil, metadata: nil, backends: []) click to toggle source

Update Failover backend by ID

@param [string] id @param [string] description human-readable description of this backend. Optional @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional @param [List<string>] backends the ids of the child backends in order @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-update

# File lib/ngrokapi/services/failover_backends_client.rb, line 196
def update(id: "", description: nil, metadata: nil, backends: [])
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:backends] = backends if backends
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end
update!(id: "", description: nil, metadata: nil, backends: []) click to toggle source

Update Failover backend by ID Throws an exception if API error.

@param [string] id @param [string] description human-readable description of this backend. Optional @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional @param [List<string>] backends the ids of the child backends in order @return [NgrokAPI::Models::FailoverBackend] result from the API request

ngrok.com/docs/api#api-failover-backends-update

# File lib/ngrokapi/services/failover_backends_client.rb, line 220
def update!(id: "", description: nil, metadata: nil, backends: [])
  path = '/backends/failover/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:backends] = backends if backends
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::FailoverBackend.new(client: self, attrs: result)
end