common

Documentation

Index

• type BaseRequest
  • func NewBaseRequest() BaseRequest
• type BaseResponse
  • func NewBaseResponse(requestId string, message string, statusCode int) BaseResponse
• type BaseWithConfigResponse
• type BaseWithIdResponse
  • func NewBaseWithIdResponse(requestId string, message string, statusCode int, id string) BaseWithIdResponse
• type BaseWithServiceNameResponse
• type BaseWithTotalCountResponse
  • func NewBaseWithTotalCountResponse(requestId string, message string, statusCode int, totalCount uint32) BaseWithTotalCountResponse
• type ConfigResponse
  • func NewConfigResponse(serviceConfig interface{}, serviceName string) ConfigResponse
• type CountResponse
  • func NewCountResponse(requestId string, message string, statusCode int, count uint32) CountResponse
• type PingResponse
  • func NewPingResponse(serviceName string) PingResponse
• type SecretDataKeyValue
• type SecretRequest
  • func NewSecretRequest(secretName string, secretData []SecretDataKeyValue) SecretRequest
  • func (sr *SecretRequest) UnmarshalJSON(b []byte) error
  • func (sr *SecretRequest) Validate() error
• type VersionResponse
  • func NewVersionResponse(version string, serviceName string) VersionResponse
• type VersionSdkResponse
  • func NewVersionSdkResponse(appVersion string, sdkVersion string, serviceName string) VersionSdkResponse
• type Versionable
  • func NewVersionable() Versionable

Types

type BaseRequest

type BaseRequest struct {
	Versionable `json:",inline"`
	RequestId   string `json:"requestId" validate:"len=0|uuid"`
}

BaseRequest defines the base content for request DTOs (data transfer objects).

func NewBaseRequest

func NewBaseRequest() BaseRequest

type BaseResponse

type BaseResponse struct {
	Versionable `json:",inline"`
	RequestId   string `json:"requestId,omitempty"`
	Message     string `json:"message,omitempty"`
	StatusCode  int    `json:"statusCode"`
}

BaseResponse defines the base content for response DTOs (data transfer objects).

func NewBaseResponse

func NewBaseResponse(requestId string, message string, statusCode int) BaseResponse

type BaseWithConfigResponse

type BaseWithConfigResponse struct {
	BaseResponse `json:",inline"`
	ServiceName  string      `json:"serviceName"`
	Config       interface{} `json:"config"`
}

BaseWithConfigResponse defines the base content for response DTOs (data transfer objects).

type BaseWithIdResponse

type BaseWithIdResponse struct {
	BaseResponse `json:",inline"`
	Id           string `json:"id"`
}

BaseWithIdResponse defines the base content for response DTOs (data transfer objects).

func NewBaseWithIdResponse

func NewBaseWithIdResponse(requestId string, message string, statusCode int, id string) BaseWithIdResponse

type BaseWithServiceNameResponse

type BaseWithServiceNameResponse struct {
	BaseResponse `json:",inline"`
	ServiceName  string `json:"serviceName"`
}

BaseWithServiceNameResponse defines the base content for response DTOs (data transfer objects).

type BaseWithTotalCountResponse

type BaseWithTotalCountResponse struct {
	BaseResponse `json:",inline"`
	TotalCount   uint32 `json:"totalCount"`
}

BaseWithTotalCountResponse defines the base content for response DTOs (data transfer objects).

func NewBaseWithTotalCountResponse

func NewBaseWithTotalCountResponse(requestId string, message string, statusCode int, totalCount uint32) BaseWithTotalCountResponse

type ConfigResponse

type ConfigResponse struct {
	Versionable `json:",inline"`
	Config      interface{} `json:"config"`
	ServiceName string      `json:"serviceName"`
}

ConfigResponse defines the configuration for the targeted service.

func NewConfigResponse

func NewConfigResponse(serviceConfig interface{}, serviceName string) ConfigResponse

NewConfigResponse creates new ConfigResponse with all fields set appropriately

type CountResponse

type CountResponse struct {
	BaseResponse `json:",inline"`
	Count        uint32
}

CountResponse defines the Response Content for GET count DTO.

func NewCountResponse

func NewCountResponse(requestId string, message string, statusCode int, count uint32) CountResponse

NewCountResponse creates new CountResponse with all fields set appropriately

type PingResponse

type PingResponse struct {
	Versionable `json:",inline"`
	Timestamp   string `json:"timestamp"`
	ServiceName string `json:"serviceName"`
}

PingResponse defines the content of response content for GET Ping DTO

func NewPingResponse

func NewPingResponse(serviceName string) PingResponse

NewPingResponse creates new PingResponse with all fields set appropriately

type SecretDataKeyValue

type SecretDataKeyValue struct {
	Key   string `json:"key" validate:"required"`
	Value string `json:"value" validate:"required"`
}

SecretDataKeyValue is a key/value pair to be stored in the Secret Store as part of the Secret Data

type SecretRequest

type SecretRequest struct {
	BaseRequest `json:",inline"`
	SecretName  string               `json:"secretName" validate:"required"`
	SecretData  []SecretDataKeyValue `json:"secretData" validate:"required,gt=0,dive"`
}

SecretRequest is the request DTO for storing supplied secret at a given SecretName in the Secret Store

func NewSecretRequest

func NewSecretRequest(secretName string, secretData []SecretDataKeyValue) SecretRequest

func (*SecretRequest) UnmarshalJSON

func (sr *SecretRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the SecretRequest type

func (*SecretRequest) Validate

func (sr *SecretRequest) Validate() error

Validate satisfies the Validator interface

type VersionResponse

type VersionResponse struct {
	Versionable `json:",inline"`
	Version     string `json:"version"`
	ServiceName string `json:"serviceName"`
}

VersionResponse defines the latest version supported by the service.

func NewVersionResponse

func NewVersionResponse(version string, serviceName string) VersionResponse

NewVersionResponse creates new VersionResponse with all fields set appropriately

type VersionSdkResponse

type VersionSdkResponse struct {
	VersionResponse `json:",inline"`
	SdkVersion      string `json:"sdk_version"`
}

VersionSdkResponse defines the latest sdk version supported by the service.

func NewVersionSdkResponse

func NewVersionSdkResponse(appVersion string, sdkVersion string, serviceName string) VersionSdkResponse

NewVersionSdkResponse creates new VersionSdkResponse with all fields set appropriately

type Versionable

type Versionable struct {
	ApiVersion string `json:"apiVersion" yaml:"apiVersion" validate:"required"`
}

Versionable shows the API version in DTOs

func NewVersionable

func NewVersionable() Versionable