api

Documentation

Index

• type AnyValue
• type Error
• type ErrorDetail
• type EventSource
• type PublishEventParameters
• type PublishEventResponses
• type PublishRequest
• type PublishResponse
• type SendEventParameters
• type SendEventResponse

Types

type AnyValue

type AnyValue interface {
}

AnyValue implements the service definition of AnyValue

type Error

type Error struct {
	Status   int           `json:"status,omitempty"`
	Type     string        `json:"type,omitempty"`
	Message  string        `json:"message,omitempty"`
	MoreInfo string        `json:"moreInfo,omitempty"`
	Details  []ErrorDetail `json:"details,omitempty"`
}

Error implements the service definition of APIError

type ErrorDetail

type ErrorDetail struct {
	Field    string `json:"field,omitempty"`
	Type     string `json:"type,omitempty"`
	Message  string `json:"message,omitempty"`
	MoreInfo string `json:"moreInfo,omitempty"`
}

ErrorDetail implements the service definition of APIErrorDetail

type EventSource

type EventSource struct {
	SourceNamespace   string `json:"source-namespace,omitempty"`
	SourceType        string `json:"source-type,omitempty"`
	SourceEnvironment string `json:"source-environment,omitempty"`
}

EventSource implements the Source definition of the outbound messaging API

type PublishEventParameters

type PublishEventParameters struct {
	Publishrequest PublishRequest `json:"publishrequest,omitempty"`
}

PublishEventParameters holds parameters to PublishEvent

type PublishEventResponses

type PublishEventResponses struct {
	Ok    *PublishResponse
	Error *Error
}

PublishEventResponses holds responses of PublishEvent

type PublishRequest

type PublishRequest struct {
	EventType        string   `json:"event-type,omitempty"`
	EventTypeVersion string   `json:"event-type-version,omitempty"`
	EventId          string   `json:"event-id,omitempty"`
	EventTime        string   `json:"event-time,omitempty"`
	Data             AnyValue `json:"data,omitempty"`
}

PublishRequest implements the service definition of PublishRequest

type PublishResponse

type PublishResponse struct {
	EventId string `json:"event-id,omitempty"`
}

PublishResponse implements the service definition of PublishResponse

type SendEventParameters

type SendEventParameters struct {
	Eventsource      EventSource `json:"source,omitempty"`
	EventType        string      `json:"event-type,omitempty"`
	EventTypeVersion string      `json:"event-type-version,omitempty"`
	EventId          string      `json:"event-id,omitempty"`
	EventTime        string      `json:"event-time,omitempty"`
	Data             AnyValue    `json:"data,omitempty"`
}

SendEventParameters implements the request to the outbound messaging API

type SendEventResponse

type SendEventResponse PublishEventResponses

SendEventResponse holds the response from outbound messaging API