module BWAPI::Client::Projects::StreamDashboards::Streams

Streams module for projects/stream_dashboards/streams endpoints

Public Instance Methods

create_stream(project_id, stream_dashboard_id, opts = {}) click to toggle source

Create a stream in a stream dashboard

@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the stream @option opts [String] name Name of the stream @option opts [String] created Creation date of stream @option opts [String] filter Filter of the stream @option opts [String] settings Settings of the stream @option opts [String] lastModified Last modification date of stream @return [Hash] Specific stream

# File lib/bwapi/client/projects/stream_dashboards/streams.rb, line 40
def create_stream(project_id, stream_dashboard_id, opts = {})
  post "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams", opts
end
delete_stream(project_id, stream_dashboard_id, stream_id) click to toggle source

Delete a stream in a stream dashboard

@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @param stream_id [Integer] Id of the stream @return [Hash] Deleted stream

# File lib/bwapi/client/projects/stream_dashboards/streams.rb, line 67
def delete_stream(project_id, stream_dashboard_id, stream_id)
  delete "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
end
get_stream(project_id, stream_dashboard_id, stream_id) click to toggle source

Get a stream in a stream dashboard

@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @param stream_id [Integer] Id of the stream @return [Hash] Specific stream

# File lib/bwapi/client/projects/stream_dashboards/streams.rb, line 24
def get_stream(project_id, stream_dashboard_id, stream_id)
  get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}"
end
get_streams(project_id, stream_dashboard_id) click to toggle source

Get all streams in a stream dashboard

@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] page Page of results to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All stream dashboards for project

# File lib/bwapi/client/projects/stream_dashboards/streams.rb, line 14
def get_streams(project_id, stream_dashboard_id)
  get "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams"
end
update_stream(project_id, stream_dashboard_id, stream_id, opts = {}) click to toggle source

Update a stream in a stream dashboard

@param project_id [Integer] Id of project @param stream_dashboard_id [Integer] Id of stream dashboard @param stream_id [Integer] Id of the stream @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the stream @option opts [String] name Name of the stream @option opts [String] created Creation date of stream @option opts [String] filter Filter of the stream @option opts [String] settings Settings of the stream @option opts [String] lastModified Last modification date of stream @return [Hash] Updated stream

# File lib/bwapi/client/projects/stream_dashboards/streams.rb, line 57
def update_stream(project_id, stream_dashboard_id, stream_id, opts = {})
  put "projects/#{project_id}/streamDashboards/#{stream_dashboard_id}/streams/#{stream_id}", opts
end