class Itly::Plugin::Snowplow::Options

Options for the Snowplow plugin class

Attributes

buffer_size[R]
disabled[R]
endpoint[R]
method[R]
protocol[R]

Public Class Methods

new(endpoint:, protocol: 'http', method: 'get', buffer_size: nil, disabled: false) click to toggle source

Instantiate a new Options

@param [String] endpoint: specify the Snowplow endpoint @param [String] protocol: specify the protocol to connect to the Snowplow endpoint.

Can be 'http' or 'https'. Default to 'http'

@param [String] method: specify the HTTP verb to use when sending events to the Snowplow endpoint.

Can be 'get' or 'post'. Default to 'get'

@param [Integer] buffer_size: specify the buffer size before flushing event to the Snowplow endpoint.

Leave it to +nil+ to set it's default value. Default to 1 for GET method, and 10 for POST

@param [TrueClass/FalseClass] disabled: set to true to disable the plugin. Default to false

Calls superclass method
# File lib/itly/plugin/snowplow/options.rb, line 26
def initialize(endpoint:, protocol: 'http', method: 'get', buffer_size: nil, disabled: false)
  super()
  @endpoint = endpoint
  @protocol = protocol
  @method = method
  @buffer_size = buffer_size
  @disabled = disabled
end