response

Documentation

Index

• type Error
• type Sink
  • func NewSink(sn core.SinkNode, detailed bool) *Sink
• type Source
  • func NewSource(sn core.SourceNode, detailed bool) *Source
• type Stream
  • func NewStream(bn core.BoxNode, detailed bool) *Stream
• type Topology
  • func NewTopology(t core.Topology) *Topology

Types

type Error

type Error struct {
	Code      string   `json:"code"`
	Message   string   `json:"message"`
	RequestID string   `json:"request_id"`
	Meta      data.Map `json:"meta"`
}

Error has error response information of a request.

type Sink

type Sink struct {
	NodeType string      `json:"node_type"`
	Name     string      `json:"name"`
	State    string      `json:"state"`
	Status   data.Map    `json:"status,omitempty"`
	Meta     interface{} `json:"meta,omitempty"`
}

Sink is a part of the response which is returned by sinks' action.

func NewSink

func NewSink(sn core.SinkNode, detailed bool) *Sink

NewSink returns the result of the sink node. It generates status and meta information if detailed argument is true.

type Source

type Source struct {
	NodeType string      `json:"node_type"`
	Name     string      `json:"name"`
	State    string      `json:"state"`
	Status   data.Map    `json:"status,omitempty"`
	Meta     interface{} `json:"meta,omitempty"`
}

Source is a part of the response which is returned by sources' action.

func NewSource

func NewSource(sn core.SourceNode, detailed bool) *Source

NewSource returns the result of the source node. It generates status and meta information if detailed argument is true.

type Stream

type Stream struct {
	NodeType string      `json:"node_type"`
	Name     string      `json:"name"`
	State    string      `json:"state"`
	Status   data.Map    `json:"status,omitempty"`
	Meta     interface{} `json:"meta,omitempty"`
}

Stream is a part of the response which is returned by streams' action.

func NewStream

func NewStream(bn core.BoxNode, detailed bool) *Stream

NewStream returns the result of the box node. It generates status and meta information if detailed argument is true.

type Topology

type Topology struct {
	// Name is the name of the topology.
	Name string `json:"name"`
}

Topology is a part of the response which topologies.show action returns.

func NewTopology

func NewTopology(t core.Topology) *Topology

NewTopology creates a new response of a topology.