_id
stringlengths
2
7
text
stringlengths
6
2.61k
title
stringclasses
1 value
c15400
// Auth Middleware for REST API
c15401
// CORS origins have to be turned on explicitly in the global config. // Otherwise, it defaults to the same origin.
c15402
// NewCronSchedule creates and starts new cron schedule and returns an instance of CronSchedule
c15403
// Validate returns error if cron entry doesn't match crontab format
c15404
// Wait waits as long as specified in cron entry
c15405
// Adds a ConfigDataNode at the provided namespace.
c15406
// Returns a ConfigDataNode that is a merged version of the namespace provided.
c15407
// CacheTTL is an option that can be be provided to the func NewPluginMeta.
c15408
// NewPluginMeta constructs and returns a PluginMeta struct
c15409
// Select selects an available plugin using the config based plugin strategy.
c15410
// GobEcode encodes a ConfigDataNode in go binary format
c15411
// GobDecode decodes a GOB into a ConfigDataNode
c15412
// UnmarshalJSON unmarshals JSON into a ConfigDataNode
c15413
// Returns a new and empty node.
c15414
// Adds an item to the ConfigDataNode.
c15415
// Merges a ConfigDataNode with this one but does not overwrite any // conflicting values. Any conflicts are decided by the callers value.
c15416
// Merges a ConfigDataNode with a copy of the current ConfigDataNode and returns // the copy. The merge does not overwrite any conflicting values. // Any conflicts are decided by the callers value.
c15417
// ApplyDefaults will set default values if the given ConfigDataNode doesn't // already have a value for the given configuration.
c15418
// Deletes a field in ConfigDataNode. If the field does not exist Delete is // considered a no-op
c15419
// broadcast takes a tribe message type, encodes it for the wire, and queues // the broadcast. If a notify channel is given, this channel will be closed // when the broadcast is sent.
c15420
// GetDefaultConfig gets the default snapteld configuration
c15421
// TaskDeadlineDuration sets the tasks deadline. // The deadline is the amount of time that can pass before a worker begins // processing the tasks collect job.
c15422
// TaskStopOnFailure sets the tasks stopOnFailure // The stopOnFailure is the number of consecutive task failures that will // trigger disabling the task
c15423
// CacheExpiration is the PluginControlOpt which sets the global metric cache TTL
c15424
// OptSetConfig sets the plugin control configuration.
c15425
// OptSetTags sets the plugin control tags.
c15426
// New returns a new pluginControl instance
c15427
// Load is the public method to load a plugin into // the LoadedPlugins array and issue an event when // successful.
c15428
// SubscribeDeps will subscribe to collectors, processors and publishers. The collectors are subscribed by mapping the provided // array of core.RequestedMetrics to the corresponding plugins while processors and publishers provided in the array of core.Plugin // will be subscribed directly. The ID provides a logical ...
c15429
// UnsubscribeDeps unsubscribes a group of dependencies provided the subscription group ID
c15430
// SetMonitorOptions exposes monitors options
c15431
// CollectMetrics is a blocking call to collector plugins returning a collection // of metrics and errors. If an error is encountered no metrics will be // returned.
c15432
// New returns an instance of the scheduler // The MetricManager must be set before the scheduler can be started. // The MetricManager must be started before it can be used.
c15433
// CreateTask creates and returns task
c15434
// GetTasks returns a copy of the tasks in a map where the task id is the key
c15435
// GetTask provided the task id a task is returned
c15436
// StartTask provided a task id a task is started
c15437
// StopTask provided a task id a task is stopped
c15438
//EnableTask changes state from disabled to stopped
c15439
// Set metricManager for scheduler
c15440
// Central handling for all async events in scheduler
c15441
//enableTask changes the task state from Disabled to Stopped
c15442
// Manifest returns the ImageManifest inside the ACI file
c15443
// Extract expands the ACI file to a temporary directory, returning // the directory path where the ACI was expanded or an error
c15444
// Validate makes sure the archive is valid. Otherwise, // an error is returned
c15445
// Remove removes a subscription group given a subscription group ID.
c15446
// validatePluginUnloading checks if process of unloading the plugin is safe for existing running tasks. // If the plugin is used by running task and there is no replacements, return an error with appropriate message // containing ids of tasks which use the plugin, what blocks unloading process until they are stopped
c15447
// pluginIsSubscribed returns true if a provided plugin has been found among subscribed plugins // in the following subscription group
c15448
// validatePluginUnloading verifies if a given plugin might be unloaded without causing running task failures
c15449
// comparePlugins compares the new state of plugins with the previous state. // It returns an array of plugins that need to be subscribed and an array of // plugins that need to be unsubscribed.
c15450
// LoadPlugin loads plugins for the given plugin names. // A slide of loaded plugins returns if succeeded. Otherwise, an error is returned.
c15451
// UnloadPlugin unloads a plugin given plugin type, name, and version through an HTTP DELETE request. // The unloaded plugin returns if succeeded. Otherwise, an error is returned.
c15452
// GetPlugins returns the loaded and available plugins through an HTTP GET request. // By specifying the details flag to tweak output info. An error returns if it failed.
c15453
// GetPlugin returns the requested plugin through an HTTP GET request. An error returns if it failed.
c15454
// Close stops watching a task. Cannot be restarted.
c15455
// Insert inserts an AvailablePlugin into the pool
c15456
// applyPluginMeta is called when the first plugin is added to the pool
c15457
// subscribe adds a subscription to the pool. // Using subscribe is idempotent.
c15458
// unsubscribe removes a subscription from the pool. // Using unsubscribe is idempotent.
c15459
// Eligible returns a bool indicating whether the pool is eligible to grow
c15460
// kill kills and removes the available plugin from its pool. // Using kill is idempotent.
c15461
// Kill all instances of a plugin
c15462
// SelectAndKill selects, kills and removes the available plugin from the pool
c15463
// remove removes an available plugin from the the pool. // using remove is idempotent.
c15464
// Count returns the number of plugins in the pool
c15465
// SubscriptionCount returns the number of subscriptions in the pool
c15466
// SelectAP selects an available plugin from the pool // the method is not thread safe, it should be protected outside of the body
c15467
// generatePID returns the next available pid for the pool
c15468
// CacheTTL returns the cacheTTL for the pool
c15469
//ValidateSignature is exported for plugin authoring
c15470
// Returns a slice of string keywords for the types supported by ConfigValue.
c15471
// NewExecutablePlugin returns a new ExecutablePlugin.
c15472
// Run executes the plugin and waits for a response, or times out.
c15473
// Strings returns an array of strings that represent the elements of the // namespace.
c15474
// getSeparator returns the highest suitable separator from the nsPriorityList. // Otherwise the core separator is returned.
c15475
// initSeparatorMap populates the local map of nsPriorityList.
c15476
// NewNamespace takes an array of strings and returns a Namespace. A Namespace // is an array of NamespaceElements. The provided array of strings is used to // set the corresponding Value fields in the array of NamespaceElements.
c15477
// AddDynamicElement adds a dynamic element to the given Namespace. A dynamic // NamespaceElement is defined by having a nonempty Name field.
c15478
// AddStaticElement adds a static element to the given Namespace. A static // NamespaceElement is defined by having an empty Name field.
c15479
// AddStaticElements adds a static elements to the given Namespace. A static // NamespaceElement is defined by having an empty Name field.
c15480
// begin a worker
c15481
// FetchMetrics retrieves the metric catalog given metric namespace and version through an HTTP GET request. // It returns the corresponding metric catalog if succeeded. Otherwise, an error is returned.
c15482
// GetMetricVersions retrieves all versions of a metric at a given namespace.
c15483
// GetFirstChar returns the first character from the input string.
c15484
// GobEncode returns the encoded ConfigTree. Otherwise, // an error is returned
c15485
// GobDecode decodes the ConfigTree.
c15486
// MarshalJSON marshals ConfigTree
c15487
// Add adds a new tree node
c15488
// Get returns a tree node given the namespace
c15489
// MarshalJSON marshals the ConfigTree.
c15490
// GobEncode encodes every member of node struct instance
c15491
// GobDecode decodes every member of node struct instance
c15492
// MarshalJSON marshals a FloatRule into JSON
c15493
// GobEncode encodes a FloatRule into a GOB
c15494
// Default returns the rule's default value
c15495
// Checks validity of URL
c15496
//Password is an option than can be provided to the func client.New.
c15497
//Timeout is an option that can be provided to the func client.New in order to set HTTP connection timeout.
c15498
// New returns a pointer to a snap api client // if ver is an empty string, v1 is used by default
c15499
// Passthrough for tribe request to allow use of client auth.