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: nil, attrs: {}) ⇒ 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: nil, attrs: {})
  @client = client
  @attrs = attrs
  @id = @attrs['id']
  @uri = @attrs['uri']
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @domain = @attrs['domain']
  @ns_targets = @attrs['ns_targets']
  @region_domains = @attrs['region_domains']
  @created_at = @attrs['created_at']
end

Instance Attribute Details

#attrsObject (readonly)

Returns the value of attribute attrs.



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

def attrs
  @attrs
end

#clientObject (readonly)

Returns the value of attribute client.



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

def client
  @client
end

#created_atObject (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

#descriptionObject (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#domainObject (readonly)

Returns the value of attribute domain.



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

def domain
  @domain
end

#idObject (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metadataObject (readonly)

Returns the value of attribute metadata.



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

def 
  @metadata
end

#ns_targetsObject (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_domainsObject (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

#uriObject (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)
  @attrs == other.attrs
end

#deleteObject

Delete an Agent Ingress by ID

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



46
47
48
49
50
# File 'lib/ngrokapi/models/agent_ingress.rb', line 46

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

#to_hObject



38
39
40
# File 'lib/ngrokapi/models/agent_ingress.rb', line 38

def to_h
  @attrs.to_h
end

#to_sObject



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

def to_s
  @attrs.to_s
end

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

Update attributes of an Agent Ingress by ID.

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



56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/ngrokapi/models/agent_ingress.rb', line 56

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