client

package
v0.44.0 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildSearchPayload 

func BuildSearchPayload(searchSearchBody string, searchSearchAtTime string, searchSearchLimit string, searchSearchPage string, searchSearchJWT string, searchSearchContentType string) (*search.SearchPayload, error)

BuildSearchPayload builds the payload for the search search endpoint from CLI flags.

func DecodeSearchResponse 

func DecodeSearchResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

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

  • "bad-request" (type *search.BadRequestT): http.StatusBadRequest
  • "invalid-parameter" (type *search.InvalidParameterT): http.StatusUnprocessableEntity
  • "invalid-scopes" (type *search.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *search.NotImplementedT): http.StatusNotImplemented
  • "not-available" (type *search.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *search.UnauthorizedT): http.StatusUnauthorized
  • "unsupported-content-type" (type *search.UnsupportedContentTypeT): http.StatusUnsupportedMediaType
  • error: internal error

func EncodeSearchRequest 

func EncodeSearchRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeSearchRequest returns an encoder for requests sent to the search search server.

func NewSearchBadRequest 

func NewSearchBadRequest(body *SearchBadRequestResponseBody) *search.BadRequestT

NewSearchBadRequest builds a search service search endpoint bad-request error.

func NewSearchInvalidParameter 

func NewSearchInvalidParameter(body *SearchInvalidParameterResponseBody) *search.InvalidParameterT

NewSearchInvalidParameter builds a search service search endpoint invalid-parameter error.

func NewSearchInvalidScopes 

func NewSearchInvalidScopes(body *SearchInvalidScopesResponseBody) *search.InvalidScopesT

NewSearchInvalidScopes builds a search service search endpoint invalid-scopes error.

func NewSearchListRTOK 

func NewSearchListRTOK(body *SearchResponseBody) *search.SearchListRT

NewSearchListRTOK builds a "search" service "search" endpoint result from a HTTP "OK" response.

func NewSearchNotAuthorized 

func NewSearchNotAuthorized() *search.UnauthorizedT

NewSearchNotAuthorized builds a search service search endpoint not-authorized error.

func NewSearchNotAvailable added in v0.39.0 

func NewSearchNotAvailable() *search.ServiceNotAvailableT

NewSearchNotAvailable builds a search service search endpoint not-available error.

func NewSearchNotImplemented 

func NewSearchNotImplemented(body *SearchNotImplementedResponseBody) *search.NotImplementedT

NewSearchNotImplemented builds a search service search endpoint not-implemented error.

func NewSearchUnsupportedContentType 

func NewSearchUnsupportedContentType(body *SearchUnsupportedContentTypeResponseBody) *search.UnsupportedContentTypeT

NewSearchUnsupportedContentType builds a search service search endpoint unsupported-content-type error.

func SearchSearchPath 

func SearchSearchPath() string

SearchSearchPath returns the URL path to the search service search HTTP endpoint.

func ValidateLinkTResponseBody 

func ValidateLinkTResponseBody(body *LinkTResponseBody) (err error)

ValidateLinkTResponseBody runs the validations defined on LinkTResponseBody

func ValidateSearchBadRequestResponseBody 

func ValidateSearchBadRequestResponseBody(body *SearchBadRequestResponseBody) (err error)

ValidateSearchBadRequestResponseBody runs the validations defined on search_bad-request_response_body

func ValidateSearchInvalidParameterResponseBody 

func ValidateSearchInvalidParameterResponseBody(body *SearchInvalidParameterResponseBody) (err error)

ValidateSearchInvalidParameterResponseBody runs the validations defined on search_invalid-parameter_response_body

func ValidateSearchInvalidScopesResponseBody 

func ValidateSearchInvalidScopesResponseBody(body *SearchInvalidScopesResponseBody) (err error)

ValidateSearchInvalidScopesResponseBody runs the validations defined on search_invalid-scopes_response_body

func ValidateSearchNotImplementedResponseBody 

func ValidateSearchNotImplementedResponseBody(body *SearchNotImplementedResponseBody) (err error)

ValidateSearchNotImplementedResponseBody runs the validations defined on search_not-implemented_response_body

func ValidateSearchResponseBody 

func ValidateSearchResponseBody(body *SearchResponseBody) (err error)

ValidateSearchResponseBody runs the validations defined on SearchResponseBody

func ValidateSearchUnsupportedContentTypeResponseBody 

func ValidateSearchUnsupportedContentTypeResponseBody(body *SearchUnsupportedContentTypeResponseBody) (err error)

ValidateSearchUnsupportedContentTypeResponseBody runs the validations defined on search_unsupported-content-type_response_body

Types

type Client 

type Client struct {
	// Search Doer is the HTTP client used to make requests to the search endpoint.
	SearchDoer goahttp.Doer

	// CORS Doer is the HTTP client used to make requests to the  endpoint.
	CORSDoer 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 search 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 search service servers.

func (*Client) BuildSearchRequest 

func (c *Client) BuildSearchRequest(ctx context.Context, v any) (*http.Request, error)

BuildSearchRequest instantiates a HTTP request object with method and path set to call the "search" service "search" endpoint

func (*Client) Search 

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

Search returns an endpoint that makes HTTP requests to the search service search server.

type LinkTResponseBody 

type LinkTResponseBody struct {
	// relation type
	Rel *string `form:"rel,omitempty" json:"rel,omitempty" xml:"rel,omitempty"`
	// mime type
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// web link
	Href *string `form:"href,omitempty" json:"href,omitempty" xml:"href,omitempty"`
}

LinkTResponseBody is used to define fields on response body types.

type SearchBadRequestResponseBody 

type SearchBadRequestResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

SearchBadRequestResponseBody is the type of the "search" service "search" endpoint HTTP response body for the "bad-request" error.

type SearchInvalidParameterResponseBody 

type SearchInvalidParameterResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// name of parameter.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// provided parameter value.
	Value *string `form:"value,omitempty" json:"value,omitempty" xml:"value,omitempty"`
}

SearchInvalidParameterResponseBody is the type of the "search" service "search" endpoint HTTP response body for the "invalid-parameter" error.

type SearchInvalidScopesResponseBody 

type SearchInvalidScopesResponseBody struct {
	// ID of involved resource
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message of error
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

SearchInvalidScopesResponseBody is the type of the "search" service "search" endpoint HTTP response body for the "invalid-scopes" error.

type SearchNotImplementedResponseBody 

type SearchNotImplementedResponseBody struct {
	// Information message
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

SearchNotImplementedResponseBody is the type of the "search" service "search" endpoint HTTP response body for the "not-implemented" error.

type SearchResponseBody 

type SearchResponseBody struct {
	// List of search result
	Items []any `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Time at which this list was valid
	AtTime *string              `form:"at-time,omitempty" json:"at-time,omitempty" xml:"at-time,omitempty"`
	Links  []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

SearchResponseBody is the type of the "search" service "search" endpoint HTTP response body.

type SearchUnsupportedContentTypeResponseBody 

type SearchUnsupportedContentTypeResponseBody struct {
	// message describing expected type or pattern.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
}

SearchUnsupportedContentTypeResponseBody is the type of the "search" service "search" endpoint HTTP response body for the "unsupported-content-type" 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.