client

package
v1.7.1 Latest Latest
Warning

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

Go to latest
Published: Mar 17, 2022 License: Apache-2.0 Imports: 11 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildVersionsByIDPayload

func BuildVersionsByIDPayload(resourceVersionsByIDID string) (*resource.VersionsByIDPayload, error)

BuildVersionsByIDPayload builds the payload for the resource VersionsByID endpoint from CLI flags.

func DecodeListResponse

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

DecodeListResponse returns a decoder for responses returned by the resource List endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeVersionsByIDResponse

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

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

  • "internal-error" (type *goa.ServiceError): http.StatusInternalServerError
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • error: internal error

func ListResourcePath

func ListResourcePath() string

ListResourcePath returns the URL path to the resource service List HTTP endpoint.

func NewListResourcesMovedPermanently

func NewListResourcesMovedPermanently(body *ListResponseBody) *resourceviews.ResourcesView

NewListResourcesMovedPermanently builds a "resource" service "List" endpoint result from a HTTP "MovedPermanently" response.

func NewVersionsByIDInternalError

func NewVersionsByIDInternalError(body *VersionsByIDInternalErrorResponseBody) *goa.ServiceError

NewVersionsByIDInternalError builds a resource service VersionsByID endpoint internal-error error.

func NewVersionsByIDNotFound

func NewVersionsByIDNotFound(body *VersionsByIDNotFoundResponseBody) *goa.ServiceError

NewVersionsByIDNotFound builds a resource service VersionsByID endpoint not-found error.

func NewVersionsByIDResourceVersionsOK

func NewVersionsByIDResourceVersionsOK(body *VersionsByIDResponseBody) *resourceviews.ResourceVersionsView

NewVersionsByIDResourceVersionsOK builds a "resource" service "VersionsByID" endpoint result from a HTTP "OK" response.

func ValidateCatalogResponseBody

func ValidateCatalogResponseBody(body *CatalogResponseBody) (err error)

ValidateCatalogResponseBody runs the validations defined on CatalogResponseBody

func ValidateCategoryResponseBody

func ValidateCategoryResponseBody(body *CategoryResponseBody) (err error)

ValidateCategoryResponseBody runs the validations defined on CategoryResponseBody

func ValidatePlatformResponseBody

func ValidatePlatformResponseBody(body *PlatformResponseBody) (err error)

ValidatePlatformResponseBody runs the validations defined on PlatformResponseBody

func ValidateResourceDataCollectionResponseBody

func ValidateResourceDataCollectionResponseBody(body ResourceDataCollectionResponseBody) (err error)

ValidateResourceDataCollectionResponseBody runs the validations defined on ResourceDataCollectionResponseBody

func ValidateResourceDataResponseBody

func ValidateResourceDataResponseBody(body *ResourceDataResponseBody) (err error)

ValidateResourceDataResponseBody runs the validations defined on ResourceDataResponseBody

func ValidateResourceVersionDataResponseBody

func ValidateResourceVersionDataResponseBody(body *ResourceVersionDataResponseBody) (err error)

ValidateResourceVersionDataResponseBody runs the validations defined on ResourceVersionDataResponseBody

func ValidateTagResponseBody

func ValidateTagResponseBody(body *TagResponseBody) (err error)

ValidateTagResponseBody runs the validations defined on TagResponseBody

func ValidateVersionsByIDInternalErrorResponseBody

func ValidateVersionsByIDInternalErrorResponseBody(body *VersionsByIDInternalErrorResponseBody) (err error)

ValidateVersionsByIDInternalErrorResponseBody runs the validations defined on VersionsByID_internal-error_Response_Body

func ValidateVersionsByIDNotFoundResponseBody

func ValidateVersionsByIDNotFoundResponseBody(body *VersionsByIDNotFoundResponseBody) (err error)

ValidateVersionsByIDNotFoundResponseBody runs the validations defined on VersionsByID_not-found_Response_Body

func ValidateVersionsResponseBody

func ValidateVersionsResponseBody(body *VersionsResponseBody) (err error)

ValidateVersionsResponseBody runs the validations defined on VersionsResponseBody

func VersionsByIDResourcePath

func VersionsByIDResourcePath(id uint) string

VersionsByIDResourcePath returns the URL path to the resource service VersionsByID HTTP endpoint.

Types

type CatalogResponseBody

type CatalogResponseBody struct {
	// ID is the unique id of the catalog
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of catalog
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Type of catalog
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// URL of catalog
	URL *string `form:"url,omitempty" json:"url,omitempty" xml:"url,omitempty"`
	// Provider of catalog
	Provider *string `form:"provider,omitempty" json:"provider,omitempty" xml:"provider,omitempty"`
}

CatalogResponseBody is used to define fields on response body types.

type CategoryResponseBody

type CategoryResponseBody struct {
	// ID is the unique id of the category
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of category
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
}

CategoryResponseBody is used to define fields on response body types.

type Client

type Client struct {
	// List Doer is the HTTP client used to make requests to the List endpoint.
	ListDoer goahttp.Doer

	// VersionsByID Doer is the HTTP client used to make requests to the
	// VersionsByID endpoint.
	VersionsByIDDoer 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 resource 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 resource service servers.

func (*Client) BuildListRequest

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

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

func (*Client) BuildVersionsByIDRequest

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

BuildVersionsByIDRequest instantiates a HTTP request object with method and path set to call the "resource" service "VersionsByID" endpoint

func (*Client) List

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

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

func (*Client) VersionsByID

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

VersionsByID returns an endpoint that makes HTTP requests to the resource service VersionsByID server.

type ListResponseBody

type ListResponseBody struct {
	Data ResourceDataCollectionResponseBody `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

ListResponseBody is the type of the "resource" service "List" endpoint HTTP response body.

type PlatformResponseBody

type PlatformResponseBody struct {
	// ID is the unique id of platform
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of platform
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
}

PlatformResponseBody is used to define fields on response body types.

type ResourceDataCollectionResponseBody

type ResourceDataCollectionResponseBody []*ResourceDataResponseBody

ResourceDataCollectionResponseBody is used to define fields on response body types.

type ResourceDataResponseBody

type ResourceDataResponseBody struct {
	// ID is the unique id of the resource
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of resource
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Type of catalog to which resource belongs
	Catalog *CatalogResponseBody `form:"catalog,omitempty" json:"catalog,omitempty" xml:"catalog,omitempty"`
	// Categories related to resource
	Categories []*CategoryResponseBody `form:"categories,omitempty" json:"categories,omitempty" xml:"categories,omitempty"`
	// Kind of resource
	Kind *string `form:"kind,omitempty" json:"kind,omitempty" xml:"kind,omitempty"`
	// Url path of the resource in hub
	HubURLPath *string `form:"hubURLPath,omitempty" json:"hubURLPath,omitempty" xml:"hubURLPath,omitempty"`
	// Latest version of resource
	LatestVersion *ResourceVersionDataResponseBody `form:"latestVersion,omitempty" json:"latestVersion,omitempty" xml:"latestVersion,omitempty"`
	// Tags related to resource
	Tags []*TagResponseBody `form:"tags,omitempty" json:"tags,omitempty" xml:"tags,omitempty"`
	// Platforms related to resource
	Platforms []*PlatformResponseBody `form:"platforms,omitempty" json:"platforms,omitempty" xml:"platforms,omitempty"`
	// Rating of resource
	Rating *float64 `form:"rating,omitempty" json:"rating,omitempty" xml:"rating,omitempty"`
	// List of all versions of a resource
	Versions []*ResourceVersionDataResponseBody `form:"versions,omitempty" json:"versions,omitempty" xml:"versions,omitempty"`
}

ResourceDataResponseBody is used to define fields on response body types.

type ResourceVersionDataResponseBody

type ResourceVersionDataResponseBody struct {
	// ID is the unique id of resource's version
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Version of resource
	Version *string `form:"version,omitempty" json:"version,omitempty" xml:"version,omitempty"`
	// Display name of version
	DisplayName *string `form:"displayName,omitempty" json:"displayName,omitempty" xml:"displayName,omitempty"`
	// Deprecation status of a version
	Deprecated *bool `form:"deprecated,omitempty" json:"deprecated,omitempty" xml:"deprecated,omitempty"`
	// Description of version
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Minimum pipelines version the resource's version is compatible with
	MinPipelinesVersion *string `form:"minPipelinesVersion,omitempty" json:"minPipelinesVersion,omitempty" xml:"minPipelinesVersion,omitempty"`
	// Raw URL of resource's yaml file of the version
	RawURL *string `form:"rawURL,omitempty" json:"rawURL,omitempty" xml:"rawURL,omitempty"`
	// Web URL of resource's yaml file of the version
	WebURL *string `form:"webURL,omitempty" json:"webURL,omitempty" xml:"webURL,omitempty"`
	// Timestamp when version was last updated
	UpdatedAt *string `form:"updatedAt,omitempty" json:"updatedAt,omitempty" xml:"updatedAt,omitempty"`
	// Platforms related to resource version
	Platforms []*PlatformResponseBody `form:"platforms,omitempty" json:"platforms,omitempty" xml:"platforms,omitempty"`
	// Url path of the resource in hub
	HubURLPath *string `form:"hubURLPath,omitempty" json:"hubURLPath,omitempty" xml:"hubURLPath,omitempty"`
	// Resource to which the version belongs
	Resource *ResourceDataResponseBody `form:"resource,omitempty" json:"resource,omitempty" xml:"resource,omitempty"`
}

ResourceVersionDataResponseBody is used to define fields on response body types.

type TagResponseBody

type TagResponseBody struct {
	// ID is the unique id of tag
	ID *uint `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Name of tag
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
}

TagResponseBody is used to define fields on response body types.

type VersionsByIDInternalErrorResponseBody

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

VersionsByIDInternalErrorResponseBody is the type of the "resource" service "VersionsByID" endpoint HTTP response body for the "internal-error" error.

type VersionsByIDNotFoundResponseBody

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

VersionsByIDNotFoundResponseBody is the type of the "resource" service "VersionsByID" endpoint HTTP response body for the "not-found" error.

type VersionsByIDResponseBody

type VersionsByIDResponseBody struct {
	Data *VersionsResponseBody `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

VersionsByIDResponseBody is the type of the "resource" service "VersionsByID" endpoint HTTP response body.

type VersionsResponseBody

type VersionsResponseBody struct {
	// Latest Version of resource
	Latest *ResourceVersionDataResponseBody `form:"latest,omitempty" json:"latest,omitempty" xml:"latest,omitempty"`
	// List of all versions of resource
	Versions []*ResourceVersionDataResponseBody `form:"versions,omitempty" json:"versions,omitempty" xml:"versions,omitempty"`
}

VersionsResponseBody 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