client

Documentation

Index

• Constants
• Variables
• type Graylog
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *Graylog
  • func NewHTTPClient(formats strfmt.Registry) *Graylog
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Graylog
  • func (c *Graylog) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "127.0.0.1:9000"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/api"
)

Variables

var Default = NewHTTPClient(nil)

Default graylog HTTP client.

var DefaultSchemes = []string{"http"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type Graylog

type Graylog struct {
	AlertsCallbacks *alerts_callbacks.Client

	APIDocs *api_docs.Client

	Cluster *cluster.Client

	ClusterInputstates *cluster_inputstates.Client

	ClusterJobs *cluster_jobs.Client

	ClusterMetrics *cluster_metrics.Client

	Dashboards *dashboards.Client

	DashboardsDashboardIDWidgets *dashboards_dashboard_id_widgets.Client

	Messages *messages.Client

	Operations *operations.Client

	PluginsOrgGraylogPluginsCollector *plugins_collector.Client

	PluginsOrgGraylogPluginsCollectorCollectors *plugins_collectors.Client

	PluginsOrgGraylogPluginsMapMapdata *plugins_map_mapdata.Client

	PluginsSystemPipelinesConnections *plugins_system_pipelines_connections.Client

	PluginsSystemPipelinesPipeline *plugins_system_pipelines_pipeline.Client

	PluginsSystemPipelinesSimulate *plugins_system_pipelines_simulate.Client

	Roles *roles.Client

	SearchDecorators *search_decorators.Client

	SearchSaved *search_saved.Client

	SearchUniversalAbsolute *search_universal_absolute.Client

	SearchUniversalKeyword *search_universal_keyword.Client

	SearchUniversalRelative *search_universal_relative.Client

	StreamsAlerts *streams_alerts.Client

	StreamsStreamidAlarmcallbacks *streams_streamid_alarmcallbacks.Client

	StreamsStreamidAlertsAlertIDHistory *streams_streamid_alerts_alert_id_history.Client

	StreamsStreamidOutputs *streams_streamid_outputs.Client

	StreamsStreamidRules *streams_streamid_rules.Client

	System *system.Client

	SystemAuthentication *system_authentication.Client

	SystemBundles *system_bundles.Client

	SystemCluster *system_cluster.Client

	SystemClusterConfig *system_cluster_config.Client

	SystemClusterTraffic *system_cluster_traffic.Client

	SystemConfiguration *system_configuration.Client

	SystemDebugEvents *system_debug_events.Client

	SystemDeflector *system_deflector.Client

	SystemFields *system_fields.Client

	SystemGettingstarted *system_gettingstarted.Client

	SystemGrok *system_grok.Client

	SystemIndexerFailures *system_indexer_failures.Client

	SystemIndexerIndices *system_indexer_indices.Client

	SystemIndexerOverview *system_indexer_overview.Client

	SystemIndicesIndexSets *system_indices_index_sets.Client

	SystemIndicesRanges *system_indices_ranges.Client

	SystemIndicesRetention *system_indices_retention.Client

	SystemInputsInputIDExtractors *system_inputs_input_id_extractors.Client

	SystemInputstates *system_inputstates.Client

	SystemJobs *system_jobs.Client

	SystemJournal *system_journal.Client

	SystemLbstatus *system_lbstatus.Client

	SystemLdap *system_ldap.Client

	SystemLoggers *system_loggers.Client

	SystemLookup *system_lookup.Client

	SystemMessageprocessors *system_messageprocessors.Client

	SystemMessages *system_messages.Client

	SystemMetrics *system_metrics.Client

	SystemMetricsMetricNameHistory *system_metrics_metric_name_history.Client

	SystemNotifications *system_notifications.Client

	SystemOutputs *system_outputs.Client

	SystemPermissions *system_permissions.Client

	SystemPlugins *system_plugins.Client

	SystemServiceManager *system_service_manager.Client

	SystemSessions *system_sessions.Client

	SystemShutdown *system_shutdown.Client

	SystemStats *system_stats.Client

	SystemThroughput *system_throughput.Client

	Users *users.Client

	Transport runtime.ClientTransport
}

Graylog is a client for graylog

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *Graylog

New creates a new graylog client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *Graylog

NewHTTPClient creates a new graylog HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Graylog

NewHTTPClientWithConfig creates a new graylog HTTP client, using a customizable transport config.

func (*Graylog) SetTransport

func (c *Graylog) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.