client

package
v0.40.3 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2024 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddMetadataPath

func AddMetadataPath() string

AddMetadataPath returns the URL path to the metadata service add HTTP endpoint.

func BuildAddPayload

func BuildAddPayload(metadataAddBody string, metadataAddEntityID string, metadataAddSchema string, metadataAddPolicyID string, metadataAddJWT string, metadataAddContentType string) (*metadata.AddPayload, error)

BuildAddPayload builds the payload for the metadata add endpoint from CLI flags.

func BuildListPayload

func BuildListPayload(metadataListEntityID string, metadataListSchema string, metadataListAspectPath string, metadataListAtTime string, metadataListLimit string, metadataListFilter string, metadataListOrderBy string, metadataListOrderDesc string, metadataListIncludeContent string, metadataListPage string, metadataListJWT string) (*metadata.ListPayload, error)

BuildListPayload builds the payload for the metadata list endpoint from CLI flags.

func BuildReadPayload

func BuildReadPayload(metadataReadID string, metadataReadJWT string) (*metadata.ReadPayload, error)

BuildReadPayload builds the payload for the metadata read endpoint from CLI flags.

func BuildRevokePayload

func BuildRevokePayload(metadataRevokeID string, metadataRevokeJWT string) (*metadata.RevokePayload, error)

BuildRevokePayload builds the payload for the metadata revoke endpoint from CLI flags.

func BuildUpdateRecordPayload

func BuildUpdateRecordPayload(metadataUpdateRecordBody string, metadataUpdateRecordID string, metadataUpdateRecordEntityID string, metadataUpdateRecordSchema string, metadataUpdateRecordPolicyID string, metadataUpdateRecordJWT string, metadataUpdateRecordContentType string) (*metadata.UpdateRecordPayload, error)

BuildUpdateRecordPayload builds the payload for the metadata update_record endpoint from CLI flags.

func DecodeAddResponse

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

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

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

func DecodeListResponse

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

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

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

func DecodeReadResponse

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

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

  • "bad-request" (type *metadata.BadRequestT): http.StatusBadRequest
  • "invalid-scopes" (type *metadata.InvalidScopesT): http.StatusForbidden
  • "not-implemented" (type *metadata.NotImplementedT): http.StatusNotImplemented
  • "not-found" (type *metadata.ResourceNotFoundT): http.StatusNotFound
  • "not-available" (type *metadata.ServiceNotAvailableT): http.StatusServiceUnavailable
  • "not-authorized" (type *metadata.UnauthorizedT): http.StatusUnauthorized
  • error: internal error

func DecodeRevokeResponse

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

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

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

func DecodeUpdateRecordResponse

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

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

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

func EncodeAddRequest

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

EncodeAddRequest returns an encoder for requests sent to the metadata add server.

func EncodeListRequest

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

EncodeListRequest returns an encoder for requests sent to the metadata list server.

func EncodeReadRequest

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

EncodeReadRequest returns an encoder for requests sent to the metadata read server.

func EncodeRevokeRequest

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

EncodeRevokeRequest returns an encoder for requests sent to the metadata revoke server.

func EncodeUpdateRecordRequest

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

EncodeUpdateRecordRequest returns an encoder for requests sent to the metadata update_record server.

func ListMetadataPath

func ListMetadataPath() string

ListMetadataPath returns the URL path to the metadata service list HTTP endpoint.

func NewAddBadRequest

func NewAddBadRequest(body *AddBadRequestResponseBody) *metadata.BadRequestT

NewAddBadRequest builds a metadata service add endpoint bad-request error.

func NewAddInvalidParameter

func NewAddInvalidParameter(body *AddInvalidParameterResponseBody) *metadata.InvalidParameterT

NewAddInvalidParameter builds a metadata service add endpoint invalid-parameter error.

func NewAddInvalidScopes

func NewAddInvalidScopes(body *AddInvalidScopesResponseBody) *metadata.InvalidScopesT

NewAddInvalidScopes builds a metadata service add endpoint invalid-scopes error.

func NewAddMetaRTOK added in v0.30.0

func NewAddMetaRTOK(body *AddResponseBody) *metadata.AddMetaRT

NewAddMetaRTOK builds a "metadata" service "add" endpoint result from a HTTP "OK" response.

func NewAddNotAuthorized

func NewAddNotAuthorized() *metadata.UnauthorizedT

NewAddNotAuthorized builds a metadata service add endpoint not-authorized error.

func NewAddNotAvailable added in v0.39.0

func NewAddNotAvailable() *metadata.ServiceNotAvailableT

NewAddNotAvailable builds a metadata service add endpoint not-available error.

func NewAddNotImplemented

func NewAddNotImplemented(body *AddNotImplementedResponseBody) *metadata.NotImplementedT

NewAddNotImplemented builds a metadata service add endpoint not-implemented error.

func NewListBadRequest

func NewListBadRequest(body *ListBadRequestResponseBody) *metadata.BadRequestT

NewListBadRequest builds a metadata service list endpoint bad-request error.

func NewListInvalidParameter

func NewListInvalidParameter(body *ListInvalidParameterResponseBody) *metadata.InvalidParameterT

NewListInvalidParameter builds a metadata service list endpoint invalid-parameter error.

func NewListInvalidScopes

func NewListInvalidScopes(body *ListInvalidScopesResponseBody) *metadata.InvalidScopesT

NewListInvalidScopes builds a metadata service list endpoint invalid-scopes error.

func NewListMetaRTOK added in v0.30.0

func NewListMetaRTOK(body *ListResponseBody) *metadata.ListMetaRT

NewListMetaRTOK builds a "metadata" service "list" endpoint result from a HTTP "OK" response.

func NewListNotAuthorized

func NewListNotAuthorized() *metadata.UnauthorizedT

NewListNotAuthorized builds a metadata service list endpoint not-authorized error.

func NewListNotAvailable added in v0.39.0

func NewListNotAvailable() *metadata.ServiceNotAvailableT

NewListNotAvailable builds a metadata service list endpoint not-available error.

func NewListNotImplemented

func NewListNotImplemented(body *ListNotImplementedResponseBody) *metadata.NotImplementedT

NewListNotImplemented builds a metadata service list endpoint not-implemented error.

func NewReadBadRequest

func NewReadBadRequest(body *ReadBadRequestResponseBody) *metadata.BadRequestT

NewReadBadRequest builds a metadata service read endpoint bad-request error.

func NewReadInvalidScopes

func NewReadInvalidScopes(body *ReadInvalidScopesResponseBody) *metadata.InvalidScopesT

NewReadInvalidScopes builds a metadata service read endpoint invalid-scopes error.

func NewReadMetadataRecordRTOK

func NewReadMetadataRecordRTOK(body *ReadResponseBody) *metadata.MetadataRecordRT

NewReadMetadataRecordRTOK builds a "metadata" service "read" endpoint result from a HTTP "OK" response.

func NewReadNotAuthorized

func NewReadNotAuthorized() *metadata.UnauthorizedT

NewReadNotAuthorized builds a metadata service read endpoint not-authorized error.

func NewReadNotAvailable added in v0.39.0

func NewReadNotAvailable() *metadata.ServiceNotAvailableT

NewReadNotAvailable builds a metadata service read endpoint not-available error.

func NewReadNotFound

func NewReadNotFound(body *ReadNotFoundResponseBody) *metadata.ResourceNotFoundT

NewReadNotFound builds a metadata service read endpoint not-found error.

func NewReadNotImplemented

func NewReadNotImplemented(body *ReadNotImplementedResponseBody) *metadata.NotImplementedT

NewReadNotImplemented builds a metadata service read endpoint not-implemented error.

func NewRevokeBadRequest

func NewRevokeBadRequest(body *RevokeBadRequestResponseBody) *metadata.BadRequestT

NewRevokeBadRequest builds a metadata service revoke endpoint bad-request error.

func NewRevokeInvalidParameter

func NewRevokeInvalidParameter(body *RevokeInvalidParameterResponseBody) *metadata.InvalidParameterT

NewRevokeInvalidParameter builds a metadata service revoke endpoint invalid-parameter error.

func NewRevokeInvalidScopes

func NewRevokeInvalidScopes(body *RevokeInvalidScopesResponseBody) *metadata.InvalidScopesT

NewRevokeInvalidScopes builds a metadata service revoke endpoint invalid-scopes error.

func NewRevokeNotAuthorized

func NewRevokeNotAuthorized() *metadata.UnauthorizedT

NewRevokeNotAuthorized builds a metadata service revoke endpoint not-authorized error.

func NewRevokeNotAvailable added in v0.39.0

func NewRevokeNotAvailable() *metadata.ServiceNotAvailableT

NewRevokeNotAvailable builds a metadata service revoke endpoint not-available error.

func NewRevokeNotImplemented

func NewRevokeNotImplemented(body *RevokeNotImplementedResponseBody) *metadata.NotImplementedT

NewRevokeNotImplemented builds a metadata service revoke endpoint not-implemented error.

func NewUpdateRecordAddMetaRTOK

func NewUpdateRecordAddMetaRTOK(body *UpdateRecordResponseBody) *metadata.AddMetaRT

NewUpdateRecordAddMetaRTOK builds a "metadata" service "update_record" endpoint result from a HTTP "OK" response.

func NewUpdateRecordBadRequest

func NewUpdateRecordBadRequest(body *UpdateRecordBadRequestResponseBody) *metadata.BadRequestT

NewUpdateRecordBadRequest builds a metadata service update_record endpoint bad-request error.

func NewUpdateRecordInvalidParameter

func NewUpdateRecordInvalidParameter(body *UpdateRecordInvalidParameterResponseBody) *metadata.InvalidParameterT

NewUpdateRecordInvalidParameter builds a metadata service update_record endpoint invalid-parameter error.

func NewUpdateRecordInvalidScopes

func NewUpdateRecordInvalidScopes(body *UpdateRecordInvalidScopesResponseBody) *metadata.InvalidScopesT

NewUpdateRecordInvalidScopes builds a metadata service update_record endpoint invalid-scopes error.

func NewUpdateRecordNotAuthorized

func NewUpdateRecordNotAuthorized() *metadata.UnauthorizedT

NewUpdateRecordNotAuthorized builds a metadata service update_record endpoint not-authorized error.

func NewUpdateRecordNotAvailable added in v0.39.0

func NewUpdateRecordNotAvailable() *metadata.ServiceNotAvailableT

NewUpdateRecordNotAvailable builds a metadata service update_record endpoint not-available error.

func NewUpdateRecordNotImplemented

func NewUpdateRecordNotImplemented(body *UpdateRecordNotImplementedResponseBody) *metadata.NotImplementedT

NewUpdateRecordNotImplemented builds a metadata service update_record endpoint not-implemented error.

func ReadMetadataPath

func ReadMetadataPath(id string) string

ReadMetadataPath returns the URL path to the metadata service read HTTP endpoint.

func RevokeMetadataPath

func RevokeMetadataPath(id string) string

RevokeMetadataPath returns the URL path to the metadata service revoke HTTP endpoint.

func UpdateRecordMetadataPath

func UpdateRecordMetadataPath(id string) string

UpdateRecordMetadataPath returns the URL path to the metadata service update_record HTTP endpoint.

func ValidateAddBadRequestResponseBody

func ValidateAddBadRequestResponseBody(body *AddBadRequestResponseBody) (err error)

ValidateAddBadRequestResponseBody runs the validations defined on add_bad-request_response_body

func ValidateAddInvalidParameterResponseBody

func ValidateAddInvalidParameterResponseBody(body *AddInvalidParameterResponseBody) (err error)

ValidateAddInvalidParameterResponseBody runs the validations defined on add_invalid-parameter_response_body

func ValidateAddInvalidScopesResponseBody

func ValidateAddInvalidScopesResponseBody(body *AddInvalidScopesResponseBody) (err error)

ValidateAddInvalidScopesResponseBody runs the validations defined on add_invalid-scopes_response_body

func ValidateAddNotImplementedResponseBody

func ValidateAddNotImplementedResponseBody(body *AddNotImplementedResponseBody) (err error)

ValidateAddNotImplementedResponseBody runs the validations defined on add_not-implemented_response_body

func ValidateAddResponseBody added in v0.30.0

func ValidateAddResponseBody(body *AddResponseBody) (err error)

ValidateAddResponseBody runs the validations defined on AddResponseBody

func ValidateLinkTResponseBody added in v0.30.0

func ValidateLinkTResponseBody(body *LinkTResponseBody) (err error)

ValidateLinkTResponseBody runs the validations defined on LinkTResponseBody

func ValidateListBadRequestResponseBody

func ValidateListBadRequestResponseBody(body *ListBadRequestResponseBody) (err error)

ValidateListBadRequestResponseBody runs the validations defined on list_bad-request_response_body

func ValidateListInvalidParameterResponseBody

func ValidateListInvalidParameterResponseBody(body *ListInvalidParameterResponseBody) (err error)

ValidateListInvalidParameterResponseBody runs the validations defined on list_invalid-parameter_response_body

func ValidateListInvalidScopesResponseBody

func ValidateListInvalidScopesResponseBody(body *ListInvalidScopesResponseBody) (err error)

ValidateListInvalidScopesResponseBody runs the validations defined on list_invalid-scopes_response_body

func ValidateListNotImplementedResponseBody

func ValidateListNotImplementedResponseBody(body *ListNotImplementedResponseBody) (err error)

ValidateListNotImplementedResponseBody runs the validations defined on list_not-implemented_response_body

func ValidateListResponseBody added in v0.30.0

func ValidateListResponseBody(body *ListResponseBody) (err error)

ValidateListResponseBody runs the validations defined on ListResponseBody

func ValidateMetadataListItemRTResponseBody

func ValidateMetadataListItemRTResponseBody(body *MetadataListItemRTResponseBody) (err error)

ValidateMetadataListItemRTResponseBody runs the validations defined on MetadataListItemRTResponseBody

func ValidateReadBadRequestResponseBody

func ValidateReadBadRequestResponseBody(body *ReadBadRequestResponseBody) (err error)

ValidateReadBadRequestResponseBody runs the validations defined on read_bad-request_response_body

func ValidateReadInvalidScopesResponseBody

func ValidateReadInvalidScopesResponseBody(body *ReadInvalidScopesResponseBody) (err error)

ValidateReadInvalidScopesResponseBody runs the validations defined on read_invalid-scopes_response_body

func ValidateReadNotFoundResponseBody

func ValidateReadNotFoundResponseBody(body *ReadNotFoundResponseBody) (err error)

ValidateReadNotFoundResponseBody runs the validations defined on read_not-found_response_body

func ValidateReadNotImplementedResponseBody

func ValidateReadNotImplementedResponseBody(body *ReadNotImplementedResponseBody) (err error)

ValidateReadNotImplementedResponseBody runs the validations defined on read_not-implemented_response_body

func ValidateReadResponseBody added in v0.30.0

func ValidateReadResponseBody(body *ReadResponseBody) (err error)

ValidateReadResponseBody runs the validations defined on ReadResponseBody

func ValidateRevokeBadRequestResponseBody

func ValidateRevokeBadRequestResponseBody(body *RevokeBadRequestResponseBody) (err error)

ValidateRevokeBadRequestResponseBody runs the validations defined on revoke_bad-request_response_body

func ValidateRevokeInvalidParameterResponseBody

func ValidateRevokeInvalidParameterResponseBody(body *RevokeInvalidParameterResponseBody) (err error)

ValidateRevokeInvalidParameterResponseBody runs the validations defined on revoke_invalid-parameter_response_body

func ValidateRevokeInvalidScopesResponseBody

func ValidateRevokeInvalidScopesResponseBody(body *RevokeInvalidScopesResponseBody) (err error)

ValidateRevokeInvalidScopesResponseBody runs the validations defined on revoke_invalid-scopes_response_body

func ValidateRevokeNotImplementedResponseBody

func ValidateRevokeNotImplementedResponseBody(body *RevokeNotImplementedResponseBody) (err error)

ValidateRevokeNotImplementedResponseBody runs the validations defined on revoke_not-implemented_response_body

func ValidateUpdateRecordBadRequestResponseBody

func ValidateUpdateRecordBadRequestResponseBody(body *UpdateRecordBadRequestResponseBody) (err error)

ValidateUpdateRecordBadRequestResponseBody runs the validations defined on update_record_bad-request_response_body

func ValidateUpdateRecordInvalidParameterResponseBody

func ValidateUpdateRecordInvalidParameterResponseBody(body *UpdateRecordInvalidParameterResponseBody) (err error)

ValidateUpdateRecordInvalidParameterResponseBody runs the validations defined on update_record_invalid-parameter_response_body

func ValidateUpdateRecordInvalidScopesResponseBody

func ValidateUpdateRecordInvalidScopesResponseBody(body *UpdateRecordInvalidScopesResponseBody) (err error)

ValidateUpdateRecordInvalidScopesResponseBody runs the validations defined on update_record_invalid-scopes_response_body

func ValidateUpdateRecordNotImplementedResponseBody

func ValidateUpdateRecordNotImplementedResponseBody(body *UpdateRecordNotImplementedResponseBody) (err error)

ValidateUpdateRecordNotImplementedResponseBody runs the validations defined on update_record_not-implemented_response_body

func ValidateUpdateRecordResponseBody added in v0.30.0

func ValidateUpdateRecordResponseBody(body *UpdateRecordResponseBody) (err error)

ValidateUpdateRecordResponseBody runs the validations defined on update_record_response_body

Types

type AddBadRequestResponseBody

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

AddBadRequestResponseBody is the type of the "metadata" service "add" endpoint HTTP response body for the "bad-request" error.

type AddInvalidParameterResponseBody

type AddInvalidParameterResponseBody 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"`
}

AddInvalidParameterResponseBody is the type of the "metadata" service "add" endpoint HTTP response body for the "invalid-parameter" error.

type AddInvalidScopesResponseBody

type AddInvalidScopesResponseBody 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"`
}

AddInvalidScopesResponseBody is the type of the "metadata" service "add" endpoint HTTP response body for the "invalid-scopes" error.

type AddNotImplementedResponseBody

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

AddNotImplementedResponseBody is the type of the "metadata" service "add" endpoint HTTP response body for the "not-implemented" error.

type AddResponseBody

type AddResponseBody struct {
	// Reference to record created
	RecordID *string `form:"record-id,omitempty" json:"record-id,omitempty" xml:"record-id,omitempty"`
}

AddResponseBody is the type of the "metadata" service "add" endpoint HTTP response body.

type Client

type Client struct {
	// Read Doer is the HTTP client used to make requests to the read endpoint.
	ReadDoer goahttp.Doer

	// List Doer is the HTTP client used to make requests to the list endpoint.
	ListDoer goahttp.Doer

	// Add Doer is the HTTP client used to make requests to the add endpoint.
	AddDoer goahttp.Doer

	// UpdateRecord Doer is the HTTP client used to make requests to the
	// update_record endpoint.
	UpdateRecordDoer goahttp.Doer

	// Revoke Doer is the HTTP client used to make requests to the revoke endpoint.
	RevokeDoer 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 metadata 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 metadata service servers.

func (*Client) Add

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

Add returns an endpoint that makes HTTP requests to the metadata service add server.

func (*Client) BuildAddRequest

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

BuildAddRequest instantiates a HTTP request object with method and path set to call the "metadata" service "add" endpoint

func (*Client) BuildListRequest

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

BuildListRequest instantiates a HTTP request object with method and path set to call the "metadata" service "list" endpoint

func (*Client) BuildReadRequest

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

BuildReadRequest instantiates a HTTP request object with method and path set to call the "metadata" service "read" endpoint

func (*Client) BuildRevokeRequest

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

BuildRevokeRequest instantiates a HTTP request object with method and path set to call the "metadata" service "revoke" endpoint

func (*Client) BuildUpdateRecordRequest

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

BuildUpdateRecordRequest instantiates a HTTP request object with method and path set to call the "metadata" service "update_record" endpoint

func (*Client) List

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

List returns an endpoint that makes HTTP requests to the metadata service list server.

func (*Client) Read

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

Read returns an endpoint that makes HTTP requests to the metadata service read server.

func (*Client) Revoke

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

Revoke returns an endpoint that makes HTTP requests to the metadata service revoke server.

func (*Client) UpdateRecord

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

UpdateRecord returns an endpoint that makes HTTP requests to the metadata service update_record server.

type LinkTResponseBody added in v0.30.0

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 ListBadRequestResponseBody

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

ListBadRequestResponseBody is the type of the "metadata" service "list" endpoint HTTP response body for the "bad-request" error.

type ListInvalidParameterResponseBody

type ListInvalidParameterResponseBody 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"`
}

ListInvalidParameterResponseBody is the type of the "metadata" service "list" endpoint HTTP response body for the "invalid-parameter" error.

type ListInvalidScopesResponseBody

type ListInvalidScopesResponseBody 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"`
}

ListInvalidScopesResponseBody is the type of the "metadata" service "list" endpoint HTTP response body for the "invalid-scopes" error.

type ListNotImplementedResponseBody

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

ListNotImplementedResponseBody is the type of the "metadata" service "list" endpoint HTTP response body for the "not-implemented" error.

type ListResponseBody

type ListResponseBody struct {
	// List of metadata records
	Items []*MetadataListItemRTResponseBody `form:"items,omitempty" json:"items,omitempty" xml:"items,omitempty"`
	// Entity for which to request metadata
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Optional schema to filter on
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Optional json path to further filter on returned list
	AspectPath *string `form:"aspect-path,omitempty" json:"aspect-path,omitempty" xml:"aspect-path,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"`
}

ListResponseBody is the type of the "metadata" service "list" endpoint HTTP response body.

type MetadataListItemRTResponseBody

type MetadataListItemRTResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Entity ID
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Schema ID
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Attached metadata aspect
	Aspect any `form:"aspect,omitempty" json:"aspect,omitempty" xml:"aspect,omitempty"`
	// If aspectPath was defined, this is what matched the query
	AspectContext *string `form:"aspect-context,omitempty" json:"aspect-context,omitempty" xml:"aspect-context,omitempty"`
}

MetadataListItemRTResponseBody is used to define fields on response body types.

type ReadBadRequestResponseBody

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

ReadBadRequestResponseBody is the type of the "metadata" service "read" endpoint HTTP response body for the "bad-request" error.

type ReadInvalidScopesResponseBody

type ReadInvalidScopesResponseBody 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"`
}

ReadInvalidScopesResponseBody is the type of the "metadata" service "read" endpoint HTTP response body for the "invalid-scopes" error.

type ReadNotFoundResponseBody

type ReadNotFoundResponseBody struct {
	// ID of missing 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"`
}

ReadNotFoundResponseBody is the type of the "metadata" service "read" endpoint HTTP response body for the "not-found" error.

type ReadNotImplementedResponseBody

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

ReadNotImplementedResponseBody is the type of the "metadata" service "read" endpoint HTTP response body for the "not-implemented" error.

type ReadResponseBody

type ReadResponseBody struct {
	// ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Entity ID
	Entity *string `form:"entity,omitempty" json:"entity,omitempty" xml:"entity,omitempty"`
	// Schema ID
	Schema *string `form:"schema,omitempty" json:"schema,omitempty" xml:"schema,omitempty"`
	// Attached metadata aspect
	Aspect any `form:"aspect,omitempty" json:"aspect,omitempty" xml:"aspect,omitempty"`
	// Time this record was asserted
	ValidFrom *string `form:"valid-from,omitempty" json:"valid-from,omitempty" xml:"valid-from,omitempty"`
	// Time this record was retracted
	ValidTo *string `form:"valid-to,omitempty" json:"valid-to,omitempty" xml:"valid-to,omitempty"`
	// Entity asserting this metadata record at 'valid-from'
	Asserter *string `form:"asserter,omitempty" json:"asserter,omitempty" xml:"asserter,omitempty"`
	// Entity revoking this record at 'valid-to'
	Revoker *string              `form:"revoker,omitempty" json:"revoker,omitempty" xml:"revoker,omitempty"`
	Links   []*LinkTResponseBody `form:"links,omitempty" json:"links,omitempty" xml:"links,omitempty"`
}

ReadResponseBody is the type of the "metadata" service "read" endpoint HTTP response body.

type RevokeBadRequestResponseBody

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

RevokeBadRequestResponseBody is the type of the "metadata" service "revoke" endpoint HTTP response body for the "bad-request" error.

type RevokeInvalidParameterResponseBody

type RevokeInvalidParameterResponseBody 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"`
}

RevokeInvalidParameterResponseBody is the type of the "metadata" service "revoke" endpoint HTTP response body for the "invalid-parameter" error.

type RevokeInvalidScopesResponseBody

type RevokeInvalidScopesResponseBody 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"`
}

RevokeInvalidScopesResponseBody is the type of the "metadata" service "revoke" endpoint HTTP response body for the "invalid-scopes" error.

type RevokeNotImplementedResponseBody

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

RevokeNotImplementedResponseBody is the type of the "metadata" service "revoke" endpoint HTTP response body for the "not-implemented" error.

type UpdateRecordBadRequestResponseBody

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

UpdateRecordBadRequestResponseBody is the type of the "metadata" service "update_record" endpoint HTTP response body for the "bad-request" error.

type UpdateRecordInvalidParameterResponseBody

type UpdateRecordInvalidParameterResponseBody 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"`
}

UpdateRecordInvalidParameterResponseBody is the type of the "metadata" service "update_record" endpoint HTTP response body for the "invalid-parameter" error.

type UpdateRecordInvalidScopesResponseBody

type UpdateRecordInvalidScopesResponseBody 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"`
}

UpdateRecordInvalidScopesResponseBody is the type of the "metadata" service "update_record" endpoint HTTP response body for the "invalid-scopes" error.

type UpdateRecordNotImplementedResponseBody

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

UpdateRecordNotImplementedResponseBody is the type of the "metadata" service "update_record" endpoint HTTP response body for the "not-implemented" error.

type UpdateRecordResponseBody

type UpdateRecordResponseBody struct {
	// Reference to record created
	RecordID *string `form:"record-id,omitempty" json:"record-id,omitempty" xml:"record-id,omitempty"`
}

UpdateRecordResponseBody is the type of the "metadata" service "update_record" endpoint HTTP response body.

Jump to

Keyboard shortcuts

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