Class: NgrokAPI::Models::EventStream

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ EventStream

Returns a new instance of EventStream.



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

def initialize(client:, result:)
  @client = client
  @result = result
  @id = @result['id']
  @uri = @result['uri']
  @created_at = @result['created_at']
  @metadata = @result['metadata']
  @description = @result['description']
  @fields = @result['fields']
  @event_type = @result['event_type']
  @destination_ids = @result['destination_ids']
  @sampling_rate = @result['sampling_rate']
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/event_stream.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/event_stream.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/event_stream.rb', line 6

def description
  @description
end

#destination_ids ⇒ Object (readonly)

Returns the value of attribute destination_ids.



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

def destination_ids
  @destination_ids
end

#event_type ⇒ Object (readonly)

Returns the value of attribute event_type.



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

def event_type
  @event_type
end

#fields ⇒ Object (readonly)

Returns the value of attribute fields.



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

def fields
  @fields
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



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

def result
  @result
end

#sampling_rate ⇒ Object (readonly)

Returns the value of attribute sampling_rate.



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

def sampling_rate
  @sampling_rate
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



32
33
34
 
# File 'lib/ngrokapi/models/event_stream.rb', line 32

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

#delete ⇒ Object

Delete an Event Stream. Associated Event Destinations will be preserved.

ngrok.com/docs/api#api-event-streams-delete



44
45
46
47
48
 
# File 'lib/ngrokapi/models/event_stream.rb', line 44

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

#to_s ⇒ Object 



36
37
38
 
# File 'lib/ngrokapi/models/event_stream.rb', line 36

def to_s
  @result.to_s
end

#update(metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) ⇒ Object

Update attributes of an Event Stream by ID.

ngrok.com/docs/api#api-event-streams-update



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/ngrokapi/models/event_stream.rb', line 54

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