client

package
v0.9.0 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AboutAboutPath

func AboutAboutPath() string

AboutAboutPath returns the URL path to the about service about HTTP endpoint.

func BuildAboutPayload

func BuildAboutPayload(aboutAboutToken string) (*about.AboutPayload, error)

BuildAboutPayload builds the payload for the about about endpoint from CLI flags.

func DecodeAboutResponse

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

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

  • "unauthorized" (type about.Unauthorized): http.StatusUnauthorized
  • error: internal error

func EncodeAboutRequest

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

EncodeAboutRequest returns an encoder for requests sent to the about about server.

func NewAboutEnduroAboutOK

func NewAboutEnduroAboutOK(body *AboutResponseBody) *aboutviews.EnduroAboutView

NewAboutEnduroAboutOK builds a "about" service "about" endpoint result from a HTTP "OK" response.

func NewAboutUnauthorized

func NewAboutUnauthorized(body string) about.Unauthorized

NewAboutUnauthorized builds a about service about endpoint unauthorized error.

func ValidateEnduroPoststorageCollectionResponseBody

func ValidateEnduroPoststorageCollectionResponseBody(body EnduroPoststorageCollectionResponseBody) (err error)

ValidateEnduroPoststorageCollectionResponseBody runs the validations defined on EnduroPoststorageCollectionResponseBody

func ValidateEnduroPoststorageResponseBody

func ValidateEnduroPoststorageResponseBody(body *EnduroPoststorageResponseBody) (err error)

ValidateEnduroPoststorageResponseBody runs the validations defined on EnduroPoststorageResponseBody

func ValidateEnduroPreprocessingResponseBody

func ValidateEnduroPreprocessingResponseBody(body *EnduroPreprocessingResponseBody) (err error)

ValidateEnduroPreprocessingResponseBody runs the validations defined on EnduroPreprocessingResponseBody

Types

type AboutResponseBody

type AboutResponseBody struct {
	Version            *string                                 `form:"version,omitempty" json:"version,omitempty" xml:"version,omitempty"`
	PreservationSystem *string                                 `form:"preservation_system,omitempty" json:"preservation_system,omitempty" xml:"preservation_system,omitempty"`
	Preprocessing      *EnduroPreprocessingResponseBody        `form:"preprocessing,omitempty" json:"preprocessing,omitempty" xml:"preprocessing,omitempty"`
	Poststorage        EnduroPoststorageCollectionResponseBody `form:"poststorage,omitempty" json:"poststorage,omitempty" xml:"poststorage,omitempty"`
}

AboutResponseBody is the type of the "about" service "about" endpoint HTTP response body.

type Client

type Client struct {
	// About Doer is the HTTP client used to make requests to the about endpoint.
	AboutDoer 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 about 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 about service servers.

func (*Client) About

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

About returns an endpoint that makes HTTP requests to the about service about server.

func (*Client) BuildAboutRequest

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

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

type EnduroPoststorageCollectionResponseBody

type EnduroPoststorageCollectionResponseBody []*EnduroPoststorageResponseBody

EnduroPoststorageCollectionResponseBody is used to define fields on response body types.

type EnduroPoststorageResponseBody

type EnduroPoststorageResponseBody struct {
	WorkflowName *string `form:"workflow_name,omitempty" json:"workflow_name,omitempty" xml:"workflow_name,omitempty"`
	TaskQueue    *string `form:"task_queue,omitempty" json:"task_queue,omitempty" xml:"task_queue,omitempty"`
}

EnduroPoststorageResponseBody is used to define fields on response body types.

type EnduroPreprocessingResponseBody

type EnduroPreprocessingResponseBody struct {
	Enabled      *bool   `form:"enabled,omitempty" json:"enabled,omitempty" xml:"enabled,omitempty"`
	WorkflowName *string `form:"workflow_name,omitempty" json:"workflow_name,omitempty" xml:"workflow_name,omitempty"`
	TaskQueue    *string `form:"task_queue,omitempty" json:"task_queue,omitempty" xml:"task_queue,omitempty"`
}

EnduroPreprocessingResponseBody is used to define fields on response body types.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL