response

Documentation

Index

• Constants
• type Args
  • func (a *Args) CreateGenericErrorResponse() CommonError
• type CommonError
• type ErrArgs
• type ErrorClass
• type Msg
• type RPC
  • func (resp *RPC) CreateInternalErrorResponse(errorMessage string)
• type Response
  • func (r *Response) CreateGenericResponse(statusMessage string)

Constants

const (
	//ErrorHelperMessage holds helper error message sent in error response
	ErrorHelperMessage = "An error has occurred. See ExtendedInfo for more information."
	//ErrorMessageOdataType holds message registry version
	ErrorMessageOdataType = "#Message.v1_1_2.Message"
)

const (
	// BaseVersion defines the latest version of Base
	BaseVersion = "Base.1.13.0."
	// Created is the message for successful creation
	Created = BaseVersion + "Created"
	// ExtendedInfo message
	ExtendedInfo = BaseVersion + "ExtendedInfo"
	// AccountRemoved is the message for successful removal of account
	AccountRemoved = BaseVersion + "AccountRemoved"
	// Success is the message for successful completion
	Success = BaseVersion + "Success"
	// AccountModified is the message for successful account modification
	AccountModified = BaseVersion + "AccountModified"
	// GeneralError defines the code at the time of General Error
	GeneralError = BaseVersion + "GeneralError"
	// Failure code for failed message
	Failure = BaseVersion + "Failed"
	// InsufficientPrivilege defines the status message at the time of Insufficient Privileges
	InsufficientPrivilege = BaseVersion + "InsufficientPrivilege"
	// InternalError defines the status message at the time of Internal Error
	InternalError = BaseVersion + "InternalError"
	// PropertyMissing defines the status message at the time of Property Missing
	PropertyMissing = BaseVersion + "PropertyMissing"
	// PropertyUnknown defines the status message at the time of Property Unknown
	PropertyUnknown = BaseVersion + "PropertyUnknown"
	// ResourceNotFound defines the status message at the time of Resource Not Found
	ResourceNotFound = BaseVersion + "ResourceNotFound"
	// MalformedJSON defines the status message at the time of Malformed JSON
	MalformedJSON = BaseVersion + "MalformedJSON"
	// PropertyValueNotInList defines the status message at the time of Property Value Not In List
	PropertyValueNotInList = BaseVersion + "PropertyValueNotInList"
	// NoValidSession defines the status message at the time of No Valid Session
	NoValidSession = BaseVersion + "NoValidSession"
	// ResourceInUse defines events aleady subscribed
	ResourceInUse = BaseVersion + "ResourceInUse"
	// PropertyValueFormatError defines the status message  given the correct value type but the value of that property was not supported
	PropertyValueFormatError = BaseVersion + "PropertyValueFormatError"
	// PropertyValueTypeError defines the message that the property is value given is having a different format
	PropertyValueTypeError = BaseVersion + "PropertyValueTypeError"
	// ResourceAtURIUnauthorized defines the authorization failure with plugin or other resources
	ResourceAtURIUnauthorized = BaseVersion + "ResourceAtUriUnauthorized"
	// CouldNotEstablishConnection defines the connection failure with plugin or other resources
	CouldNotEstablishConnection = BaseVersion + "CouldNotEstablishConnection"
	// QueryCombinationInvalid defines the status message at the time of invalid query
	QueryCombinationInvalid = BaseVersion + "QueryCombinationInvalid"
	// QueryNotSupported defines the status message at the time of not supported query
	QueryNotSupported = BaseVersion + "QueryNotSupported"
	// ResourceRemoved is the message for successful removal of resource
	ResourceRemoved = "ResourceEvent.1.2.1.ResourceRemoved"
	// ResourceCreated is the message for successful creation of resource
	ResourceCreated = "ResourceEvent.1.2.1.ResourceCreated"
	// TaskStarted is the message for denoting the starting of the task
	TaskStarted = "TaskEvent.1.0.3.TaskStarted"
	// ActionNotSupported defines requested POST operation is not supported by the resource
	ActionNotSupported = BaseVersion + "ActionNotSupported"
	// ResourceAlreadyExists indicates the request is for creation of a resource, which already exists
	ResourceAlreadyExists = BaseVersion + "ResourceAlreadyExists"
	// ActionParameterNotSupported indicates that the parameter supplied for the action is not supported on the resource.
	ActionParameterNotSupported = BaseVersion + "ActionParameterNotSupported"
	// ResourceCannotBeDeleted indicates the requested delete operation cannot be performed
	ResourceCannotBeDeleted = BaseVersion + "ResourceCannotBeDeleted"
	// PropertyValueConflict indicates that the requested write of a property value could not be completed, because of a conflict with another property value.
	PropertyValueConflict = BaseVersion + "PropertyValueConflict"
	// NoOperation  defines the status message at the time of of there is no opeartion need to be performed.
	NoOperation = BaseVersion + "NoOperation"
	// RateLimitExceeded  defines exceded the number of requests/resources.
	RateLimitExceeded = "RateLimitExceeded"
	// SessionLimitExceeded Indicates that a session establishment has been
	// requested but the operation failed due to the number of simultaneous
	// sessions exceeding the limit of the implementation.
	SessionLimitExceeded = BaseVersion + "SessionLimitExceeded"
	// InvalidURI defines the status message at the time of URL Not Found
	InvalidURI = BaseVersion + "InvalidURI"
	//Indicates that no more resources can be created on the resource as
	// it has reached its create limit.
	CreateLimitReachedForResource = BaseVersion + "CreateLimitReachedForResource"
)

Types

type Args

type Args struct {
	Code      string `json:"code"`
	Message   string `json:"message"`
	ErrorArgs []ErrArgs
}

Args holds the slice of ErrArgs

func (*Args) CreateGenericErrorResponse

func (a *Args) CreateGenericErrorResponse() CommonError

CreateGenericErrorResponse will fill the error response with respective data

type CommonError

type CommonError struct {
	Error ErrorClass `json:"error"`
}

CommonError holds the error response from odimra

type ErrArgs

type ErrArgs struct {
	StatusMessage string
	ErrorMessage  string
	MessageArgs   []interface{}
}

ErrArgs holds the parameters to build error response

type ErrorClass

type ErrorClass struct {
	Code                string `json:"code"`
	Message             string `json:"message"`
	MessageExtendedInfo []Msg  `json:"@Message.ExtendedInfo,omitempty"`
}

ErrorClass holds the properties that describe error from odimra

Code indicates a specific MessageId from a Message Registry. Message contains error message corresponding to the message in a Message Registry. MessageExtendedInfo is an message objects describing one or more error messages.

type Msg

type Msg struct {
	OdataType   string        `json:"@odata.type,omitempty"`
	MessageID   string        `json:"MessageId,omitempty"`
	Message     string        `json:"Message,omitempty"`
	Severity    string        `json:"Severity,omitempty"`
	MessageArgs []interface{} `json:"MessageArgs,omitempty"`
	Resolution  string        `json:"Resolution,omitempty"`
}

Msg holds the properties of Message object

type RPC

type RPC struct {
	Context       context.Context
	StatusCode    int32
	StatusMessage string
	Header        map[string]string
	Body          interface{}
}

RPC defines the reponse which odimra service returns back as part of the RPC call.

StatusCode defines the status code of the requested service operation. StatusMessage defines the message regarding the status of the requested operation. Header defines the headers required to create a proper response from the api gateway. Body defines the actual response of the requested service operation.

func (*RPC) CreateInternalErrorResponse

func (resp *RPC) CreateInternalErrorResponse(errorMessage string)

CreateInternalErrorResponse is used to create internal server error response

type Response

type Response struct {
	OdataType    string   `json:"@odata.type"`
	OdataID      string   `json:"@odata.id"`
	OdataContext string   `json:"@odata.context,omitempty"`
	Description  string   `json:"Description,omitempty"`
	ID           string   `json:"Id,omitempty"`
	Name         string   `json:"Name"`
	Message      string   `json:"Message,omitempty"`
	MessageID    string   `json:"MessageId,omitempty"`
	MessageArgs  []string `json:"MessageArgs,omitempty"`
	NumberOfArgs int      `json:"NumberOfArgs,omitempty"`
	Severity     string   `json:"Severity,omitempty"`
	Resolution   string   `json:"Resolution,omitempty"`
}

Response holds the generic response from odimra

func (*Response) CreateGenericResponse

func (r *Response) CreateGenericResponse(statusMessage string)

CreateGenericResponse will fill the response with respective data