Class: NgrokAPI::Models::AgentIngress

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/models/agent_ingress.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ AgentIngress

Returns a new instance of AgentIngress.



17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 17

def initialize(client:, result:)
  @client = client
  @result = result
  @id = @result['id']
  @uri = @result['uri']
  @description = @result['description']
  @metadata = @result['metadata']
  @domain = @result['domain']
  @ns_targets = @result['ns_targets']
  @region_domains = @result['region_domains']
  @created_at = @result['created_at']
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def description
  @description
end

#domain ⇒ Object (readonly)

Returns the value of attribute domain.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def domain
  @domain
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def metadata
  @metadata
end

#ns_targets ⇒ Object (readonly)

Returns the value of attribute ns_targets.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def ns_targets
  @ns_targets
end

#region_domains ⇒ Object (readonly)

Returns the value of attribute region_domains.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def region_domains
  @region_domains
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def result
  @result
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



6
7
8
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 6

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



30
31
32
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 30

def ==(other)
  @result == other.result
end

#delete ⇒ Object

Delete an Agent Ingress by ID

https://ngrok.com/docs/api#api-agent-ingresses-delete



42
43
44
45
46
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 42

def delete
  @client.delete(
    id: @id
  )
end

#to_s ⇒ Object 



34
35
36
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 34

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil) ⇒ Object

Update attributes of an Agent Ingress by ID.

https://ngrok.com/docs/api#api-agent-ingresses-update



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ngrokapi/models/agent_ingress.rb', line 52

def update(
  description: nil,
  metadata: nil
)
  @description = description if description
  @metadata = metadata if metadata
  @client.update(
    id: @id,
    description: description,
    metadata: metadata
  )
end