client

package
v0.0.0-...-769f768 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 20, 2020 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildHealthCheckPayload 

func BuildHealthCheckPayload(commonHealthCheckUsername string, commonHealthCheckPassword string) (*common.HealthCheckPayload, error)

BuildHealthCheckPayload builds the payload for the common health_check endpoint from CLI flags.

func DecodeHealthCheckResponse 

func DecodeHealthCheckResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeHealthCheckResponse returns a decoder for responses returned by the common health_check endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeHealthCheckResponse may return the following errors:

  • "bad_request" (type *goa.ServiceError): http.StatusBadRequest
  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not_found" (type *goa.ServiceError): http.StatusNotFound
  • "conflict" (type *goa.ServiceError): http.StatusConflict
  • "too_many_requests" (type *goa.ServiceError): http.StatusTooManyRequests
  • "client_closed_request" (type *goa.ServiceError): 499
  • "internal_server_error" (type *goa.ServiceError): http.StatusInternalServerError
  • "not_implemented" (type *goa.ServiceError): http.StatusNotImplemented
  • "service_unavailable" (type *goa.ServiceError): http.StatusServiceUnavailable
  • "gateway_timeout" (type *goa.ServiceError): http.StatusGatewayTimeout
  • error: internal error

func EncodeHealthCheckRequest 

func EncodeHealthCheckRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeHealthCheckRequest returns an encoder for requests sent to the common health_check server.

func HealthCheckCommonPath 

func HealthCheckCommonPath() string

HealthCheckCommonPath returns the URL path to the common service health_check HTTP endpoint.

func NewHealthCheckBadRequest 

func NewHealthCheckBadRequest(body *HealthCheckBadRequestResponseBody) *goa.ServiceError

NewHealthCheckBadRequest builds a common service health_check endpoint bad_request error.

func NewHealthCheckClientClosedRequest 

func NewHealthCheckClientClosedRequest(body *HealthCheckClientClosedRequestResponseBody) *goa.ServiceError

NewHealthCheckClientClosedRequest builds a common service health_check endpoint client_closed_request error.

func NewHealthCheckConflict 

func NewHealthCheckConflict(body *HealthCheckConflictResponseBody) *goa.ServiceError

NewHealthCheckConflict builds a common service health_check endpoint conflict error.

func NewHealthCheckForbidden 

func NewHealthCheckForbidden(body *HealthCheckForbiddenResponseBody) *goa.ServiceError

NewHealthCheckForbidden builds a common service health_check endpoint forbidden error.

func NewHealthCheckGatewayTimeout 

func NewHealthCheckGatewayTimeout(body *HealthCheckGatewayTimeoutResponseBody) *goa.ServiceError

NewHealthCheckGatewayTimeout builds a common service health_check endpoint gateway_timeout error.

func NewHealthCheckInternalServerError 

func NewHealthCheckInternalServerError(body *HealthCheckInternalServerErrorResponseBody) *goa.ServiceError

NewHealthCheckInternalServerError builds a common service health_check endpoint internal_server_error error.

func NewHealthCheckNotFound 

func NewHealthCheckNotFound(body *HealthCheckNotFoundResponseBody) *goa.ServiceError

NewHealthCheckNotFound builds a common service health_check endpoint not_found error.

func NewHealthCheckNotImplemented 

func NewHealthCheckNotImplemented(body *HealthCheckNotImplementedResponseBody) *goa.ServiceError

NewHealthCheckNotImplemented builds a common service health_check endpoint not_implemented error.

func NewHealthCheckResponseOK 

func NewHealthCheckResponseOK(body *HealthCheckResponseBody) *common.HealthCheckResponse

NewHealthCheckResponseOK builds a "common" service "health_check" endpoint result from a HTTP "OK" response.

func NewHealthCheckServiceUnavailable 

func NewHealthCheckServiceUnavailable(body *HealthCheckServiceUnavailableResponseBody) *goa.ServiceError

NewHealthCheckServiceUnavailable builds a common service health_check endpoint service_unavailable error.

func NewHealthCheckTooManyRequests 

func NewHealthCheckTooManyRequests(body *HealthCheckTooManyRequestsResponseBody) *goa.ServiceError

NewHealthCheckTooManyRequests builds a common service health_check endpoint too_many_requests error.

func NewHealthCheckUnauthorized 

func NewHealthCheckUnauthorized(body *HealthCheckUnauthorizedResponseBody) *goa.ServiceError

NewHealthCheckUnauthorized builds a common service health_check endpoint unauthorized error.

func ValidateHealthCheckBadRequestResponseBody 

func ValidateHealthCheckBadRequestResponseBody(body *HealthCheckBadRequestResponseBody) (err error)

ValidateHealthCheckBadRequestResponseBody runs the validations defined on health_check_bad_request_response_body

func ValidateHealthCheckClientClosedRequestResponseBody 

func ValidateHealthCheckClientClosedRequestResponseBody(body *HealthCheckClientClosedRequestResponseBody) (err error)

ValidateHealthCheckClientClosedRequestResponseBody runs the validations defined on health_check_client_closed_request_response_body

func ValidateHealthCheckConflictResponseBody 

func ValidateHealthCheckConflictResponseBody(body *HealthCheckConflictResponseBody) (err error)

ValidateHealthCheckConflictResponseBody runs the validations defined on health_check_conflict_response_body

func ValidateHealthCheckForbiddenResponseBody 

func ValidateHealthCheckForbiddenResponseBody(body *HealthCheckForbiddenResponseBody) (err error)

ValidateHealthCheckForbiddenResponseBody runs the validations defined on health_check_forbidden_response_body

func ValidateHealthCheckGatewayTimeoutResponseBody 

func ValidateHealthCheckGatewayTimeoutResponseBody(body *HealthCheckGatewayTimeoutResponseBody) (err error)

ValidateHealthCheckGatewayTimeoutResponseBody runs the validations defined on health_check_gateway_timeout_response_body

func ValidateHealthCheckInternalServerErrorResponseBody 

func ValidateHealthCheckInternalServerErrorResponseBody(body *HealthCheckInternalServerErrorResponseBody) (err error)

ValidateHealthCheckInternalServerErrorResponseBody runs the validations defined on health_check_internal_server_error_response_body

func ValidateHealthCheckNotFoundResponseBody 

func ValidateHealthCheckNotFoundResponseBody(body *HealthCheckNotFoundResponseBody) (err error)

ValidateHealthCheckNotFoundResponseBody runs the validations defined on health_check_not_found_response_body

func ValidateHealthCheckNotImplementedResponseBody 

func ValidateHealthCheckNotImplementedResponseBody(body *HealthCheckNotImplementedResponseBody) (err error)

ValidateHealthCheckNotImplementedResponseBody runs the validations defined on health_check_not_implemented_response_body

func ValidateHealthCheckResponseBody 

func ValidateHealthCheckResponseBody(body *HealthCheckResponseBody) (err error)

ValidateHealthCheckResponseBody runs the validations defined on health_check_response_body

func ValidateHealthCheckServiceUnavailableResponseBody 

func ValidateHealthCheckServiceUnavailableResponseBody(body *HealthCheckServiceUnavailableResponseBody) (err error)

ValidateHealthCheckServiceUnavailableResponseBody runs the validations defined on health_check_service_unavailable_response_body

func ValidateHealthCheckTooManyRequestsResponseBody 

func ValidateHealthCheckTooManyRequestsResponseBody(body *HealthCheckTooManyRequestsResponseBody) (err error)

ValidateHealthCheckTooManyRequestsResponseBody runs the validations defined on health_check_too_many_requests_response_body

func ValidateHealthCheckUnauthorizedResponseBody 

func ValidateHealthCheckUnauthorizedResponseBody(body *HealthCheckUnauthorizedResponseBody) (err error)

ValidateHealthCheckUnauthorizedResponseBody runs the validations defined on health_check_unauthorized_response_body

Types

type Client 

type Client struct {
	// HealthCheck Doer is the HTTP client used to make requests to the
	// health_check endpoint.
	HealthCheckDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the common service endpoint HTTP clients.

func NewClient 

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the common service servers.

func (*Client) BuildHealthCheckRequest 

func (c *Client) BuildHealthCheckRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildHealthCheckRequest instantiates a HTTP request object with method and path set to call the "common" service "health_check" endpoint

func (*Client) HealthCheck 

func (c *Client) HealthCheck() goa.Endpoint

HealthCheck returns an endpoint that makes HTTP requests to the common service health_check server.

type HealthCheckBadRequestResponseBody 

type HealthCheckBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckBadRequestResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "bad_request" error.

type HealthCheckClientClosedRequestResponseBody 

type HealthCheckClientClosedRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckClientClosedRequestResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "client_closed_request" error.

type HealthCheckConflictResponseBody 

type HealthCheckConflictResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckConflictResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "conflict" error.

type HealthCheckForbiddenResponseBody 

type HealthCheckForbiddenResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckForbiddenResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "forbidden" error.

type HealthCheckGatewayTimeoutResponseBody 

type HealthCheckGatewayTimeoutResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckGatewayTimeoutResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "gateway_timeout" error.

type HealthCheckInternalServerErrorResponseBody 

type HealthCheckInternalServerErrorResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckInternalServerErrorResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "internal_server_error" error.

type HealthCheckNotFoundResponseBody 

type HealthCheckNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckNotFoundResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "not_found" error.

type HealthCheckNotImplementedResponseBody 

type HealthCheckNotImplementedResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckNotImplementedResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "not_implemented" error.

type HealthCheckResponseBody 

type HealthCheckResponseBody struct {
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
}

HealthCheckResponseBody is the type of the "common" service "health_check" endpoint HTTP response body.

type HealthCheckServiceUnavailableResponseBody 

type HealthCheckServiceUnavailableResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckServiceUnavailableResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "service_unavailable" error.

type HealthCheckTooManyRequestsResponseBody 

type HealthCheckTooManyRequestsResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckTooManyRequestsResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "too_many_requests" error.

type HealthCheckUnauthorizedResponseBody 

type HealthCheckUnauthorizedResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

HealthCheckUnauthorizedResponseBody is the type of the "common" service "health_check" endpoint HTTP response body for the "unauthorized" error.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.