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.
-
#attrs ⇒ Object
readonly
Returns the value of attribute attrs.
-
#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.
-
#uri ⇒ Object
readonly
Returns the value of attribute uri.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#delete ⇒ Object
Delete an IP policy.
-
#initialize(client: nil, attrs: {}) ⇒ IPPolicy
constructor
A new instance of IPPolicy.
- #to_h ⇒ Object
- #to_s ⇒ Object
-
#update(description: nil, metadata: nil) ⇒ Object
Update attributes of an IP policy by ID.
Constructor Details
#initialize(client: nil, attrs: {}) ⇒ 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: nil, attrs: {}) @client = client @attrs = attrs @id = @attrs['id'] @uri = @attrs['uri'] @created_at = @attrs['created_at'] @description = @attrs['description'] @metadata = @attrs['metadata'] @action = @attrs['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 |
#attrs ⇒ Object (readonly)
Returns the value of attribute attrs.
6 7 8 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 6 def attrs @attrs 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 |
#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) @attrs == other.attrs 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.
44 45 46 47 48 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 44 def delete @client.delete( id: @id ) end |
#to_h ⇒ Object
34 35 36 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 34 def to_h @attrs.to_h end |
#to_s ⇒ Object
30 31 32 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 30 def to_s @attrs.to_s end |
#update(description: nil, metadata: nil) ⇒ Object
Update attributes of an IP policy by ID
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/ngrokapi/models/ip_policy.rb', line 54 def update( description: nil, metadata: nil ) @description = description if description @metadata = if @client.update( id: @id, description: description, metadata: ) end |