Class: NgrokAPI::Models::IPPolicy
- Inherits:
-
Object
- Object
- NgrokAPI::Models::IPPolicy
- Defined in:
- lib/ngrokapi/models/ip_policy.rb
Instance Attribute Summary collapse
-
#action ⇒ Object
readonly
Returns the value of attribute action.
-
#client ⇒ Object
readonly
Returns the value of attribute client.
-
#created_at ⇒ Object
readonly
Returns the value of attribute created_at.
-
#description ⇒ Object
readonly
Returns the value of attribute description.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#metadata ⇒ Object
readonly
Returns the value of attribute metadata.
-
#result ⇒ Object
readonly
Returns the value of attribute result.
-
#uri ⇒ Object
readonly
Returns the value of attribute uri.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#delete ⇒ Object
Delete an IP policy.
-
#initialize(client:, result:) ⇒ IPPolicy
constructor
A new instance of IPPolicy.
- #to_s ⇒ Object
-
#update(description: nil, metadata: nil) ⇒ Object
Update attributes of an IP policy by ID.
Constructor Details
#initialize(client:, result:) ⇒ IPPolicy
Returns a new instance of IPPolicy.
15 16 17 18 19 20 21 22 23 24 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 15 def initialize(client:, result:) @client = client @result = result @id = @result['id'] @uri = @result['uri'] @created_at = @result['created_at'] @description = @result['description'] @metadata = @result['metadata'] @action = @result['action'] end |
Instance Attribute Details
#action ⇒ Object (readonly)
Returns the value of attribute action.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def action @action end |
#client ⇒ Object (readonly)
Returns the value of attribute client.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.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/ip_policy.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/ip_policy.rb', line 6 def description @description end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def id @id end |
#metadata ⇒ Object (readonly)
Returns the value of attribute metadata.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def @metadata end |
#result ⇒ Object (readonly)
Returns the value of attribute result.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def result @result end |
#uri ⇒ Object (readonly)
Returns the value of attribute uri.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def uri @uri end |
Instance Method Details
#==(other) ⇒ Object
26 27 28 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 26 def ==(other) @result == other.result end |
#delete ⇒ Object
Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
40 41 42 43 44 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 40 def delete @client.delete( id: @id ) end |
#to_s ⇒ Object
30 31 32 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 30 def to_s @result.to_s end |
#update(description: nil, metadata: nil) ⇒ Object
Update attributes of an IP policy by ID
50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 50 def update( description: nil, metadata: nil ) @description = description if description @metadata = if @client.update( id: @id, description: description, metadata: ) end |