messages

Documentation

Overview

Package messages provides the Messages and Message type to represent messages returned by the Splunk REST API.

Index

• type Message
  • func (m Message) String() string
• type Messages
  • func (m Messages) String() string

Types

type Message

type Message struct {
	Value string `json:"text" xml:",chardata"`
	Code  string `json:"type" xml:"code,attr"`
}

Message represents the <msg> element of a <messages> entry.

func (Message) String

func (m Message) String() string

String returns the string representation of a message. It will be in the form:

Code: Value

type Messages

type Messages struct {
	XMLName string    `xml:"messages"`
	Items   []Message `json:"messages" xml:"msg"`
}

Messages represents the <messages> element of a <response> entry.

func (Messages) String

func (m Messages) String() string

String returns the string representation of Messages. If multiple Message items are present, they will be comma-separated.