client

package
v0.0.0-...-b9360c4 Latest Latest
Warning

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

Go to latest
Published: Dec 15, 2023 License: BSD-3-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildCsvPayload

func BuildCsvPayload(exportCsvStart string, exportCsvEnd string, exportCsvStations string, exportCsvSensors string, exportCsvResolution string, exportCsvAggregate string, exportCsvComplete string, exportCsvTail string, exportCsvAuth string) (*export.CsvPayload, error)

BuildCsvPayload builds the payload for the export csv endpoint from CLI flags.

func BuildDownloadPayload

func BuildDownloadPayload(exportDownloadID string, exportDownloadAuth string) (*export.DownloadPayload, error)

BuildDownloadPayload builds the payload for the export download endpoint from CLI flags.

func BuildJSONLinesPayload

func BuildJSONLinesPayload(exportJSONLinesStart string, exportJSONLinesEnd string, exportJSONLinesStations string, exportJSONLinesSensors string, exportJSONLinesResolution string, exportJSONLinesAggregate string, exportJSONLinesComplete string, exportJSONLinesTail string, exportJSONLinesAuth string) (*export.JSONLinesPayload, error)

BuildJSONLinesPayload builds the payload for the export json lines endpoint from CLI flags.

func BuildListMinePayload

func BuildListMinePayload(exportListMineAuth string) (*export.ListMinePayload, error)

BuildListMinePayload builds the payload for the export list mine endpoint from CLI flags.

func BuildStatusPayload

func BuildStatusPayload(exportStatusID string, exportStatusAuth string) (*export.StatusPayload, error)

BuildStatusPayload builds the payload for the export status endpoint from CLI flags.

func CsvExportPath

func CsvExportPath() string

CsvExportPath returns the URL path to the export service csv HTTP endpoint.

func DecodeCsvResponse

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

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

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeDownloadResponse

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

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

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeJSONLinesResponse

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

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

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeListMineResponse

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

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

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DecodeStatusResponse

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

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

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DownloadExportPath

func DownloadExportPath(id string) string

DownloadExportPath returns the URL path to the export service download HTTP endpoint.

func EncodeCsvRequest

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

EncodeCsvRequest returns an encoder for requests sent to the export csv server.

func EncodeDownloadRequest

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

EncodeDownloadRequest returns an encoder for requests sent to the export download server.

func EncodeJSONLinesRequest

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

EncodeJSONLinesRequest returns an encoder for requests sent to the export json lines server.

func EncodeListMineRequest

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

EncodeListMineRequest returns an encoder for requests sent to the export list mine server.

func EncodeStatusRequest

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

EncodeStatusRequest returns an encoder for requests sent to the export status server.

func JSONLinesExportPath

func JSONLinesExportPath() string

JSONLinesExportPath returns the URL path to the export service json lines HTTP endpoint.

func ListMineExportPath

func ListMineExportPath() string

ListMineExportPath returns the URL path to the export service list mine HTTP endpoint.

func NewCsvBadRequest

func NewCsvBadRequest(body *CsvBadRequestResponseBody) *goa.ServiceError

NewCsvBadRequest builds a export service csv endpoint bad-request error.

func NewCsvForbidden

func NewCsvForbidden(body *CsvForbiddenResponseBody) *goa.ServiceError

NewCsvForbidden builds a export service csv endpoint forbidden error.

func NewCsvNotFound

func NewCsvNotFound(body *CsvNotFoundResponseBody) *goa.ServiceError

NewCsvNotFound builds a export service csv endpoint not-found error.

func NewCsvResultFound

func NewCsvResultFound(location string) *export.CsvResult

NewCsvResultFound builds a "export" service "csv" endpoint result from a HTTP "Found" response.

func NewCsvUnauthorized

func NewCsvUnauthorized(body *CsvUnauthorizedResponseBody) *goa.ServiceError

NewCsvUnauthorized builds a export service csv endpoint unauthorized error.

func NewDownloadBadRequest

func NewDownloadBadRequest(body *DownloadBadRequestResponseBody) *goa.ServiceError

NewDownloadBadRequest builds a export service download endpoint bad-request error.

func NewDownloadForbidden

func NewDownloadForbidden(body *DownloadForbiddenResponseBody) *goa.ServiceError

NewDownloadForbidden builds a export service download endpoint forbidden error.

func NewDownloadNotFound

func NewDownloadNotFound(body *DownloadNotFoundResponseBody) *goa.ServiceError

NewDownloadNotFound builds a export service download endpoint not-found error.

func NewDownloadResultOK

func NewDownloadResultOK(length int64, contentType string, contentDisposition string) *export.DownloadResult

NewDownloadResultOK builds a "export" service "download" endpoint result from a HTTP "OK" response.

func NewDownloadUnauthorized

func NewDownloadUnauthorized(body *DownloadUnauthorizedResponseBody) *goa.ServiceError

NewDownloadUnauthorized builds a export service download endpoint unauthorized error.

func NewJSONLinesBadRequest

func NewJSONLinesBadRequest(body *JSONLinesBadRequestResponseBody) *goa.ServiceError

NewJSONLinesBadRequest builds a export service json lines endpoint bad-request error.

func NewJSONLinesForbidden

func NewJSONLinesForbidden(body *JSONLinesForbiddenResponseBody) *goa.ServiceError

NewJSONLinesForbidden builds a export service json lines endpoint forbidden error.

func NewJSONLinesNotFound

func NewJSONLinesNotFound(body *JSONLinesNotFoundResponseBody) *goa.ServiceError

NewJSONLinesNotFound builds a export service json lines endpoint not-found error.

func NewJSONLinesResultFound

func NewJSONLinesResultFound(location string) *export.JSONLinesResult

NewJSONLinesResultFound builds a "export" service "json lines" endpoint result from a HTTP "Found" response.

func NewJSONLinesUnauthorized

func NewJSONLinesUnauthorized(body *JSONLinesUnauthorizedResponseBody) *goa.ServiceError

NewJSONLinesUnauthorized builds a export service json lines endpoint unauthorized error.

func NewListMineBadRequest

func NewListMineBadRequest(body *ListMineBadRequestResponseBody) *goa.ServiceError

NewListMineBadRequest builds a export service list mine endpoint bad-request error.

func NewListMineForbidden

func NewListMineForbidden(body *ListMineForbiddenResponseBody) *goa.ServiceError

NewListMineForbidden builds a export service list mine endpoint forbidden error.

func NewListMineNotFound

func NewListMineNotFound(body *ListMineNotFoundResponseBody) *goa.ServiceError

NewListMineNotFound builds a export service list mine endpoint not-found error.

func NewListMineUnauthorized

func NewListMineUnauthorized(body *ListMineUnauthorizedResponseBody) *goa.ServiceError

NewListMineUnauthorized builds a export service list mine endpoint unauthorized error.

func NewListMineUserExportsOK

func NewListMineUserExportsOK(body *ListMineResponseBody) *exportviews.UserExportsView

NewListMineUserExportsOK builds a "export" service "list mine" endpoint result from a HTTP "OK" response.

func NewStatusBadRequest

func NewStatusBadRequest(body *StatusBadRequestResponseBody) *goa.ServiceError

NewStatusBadRequest builds a export service status endpoint bad-request error.

func NewStatusExportStatusOK

func NewStatusExportStatusOK(body *StatusResponseBody) *exportviews.ExportStatusView

NewStatusExportStatusOK builds a "export" service "status" endpoint result from a HTTP "OK" response.

func NewStatusForbidden

func NewStatusForbidden(body *StatusForbiddenResponseBody) *goa.ServiceError

NewStatusForbidden builds a export service status endpoint forbidden error.

func NewStatusNotFound

func NewStatusNotFound(body *StatusNotFoundResponseBody) *goa.ServiceError

NewStatusNotFound builds a export service status endpoint not-found error.

func NewStatusUnauthorized

func NewStatusUnauthorized(body *StatusUnauthorizedResponseBody) *goa.ServiceError

NewStatusUnauthorized builds a export service status endpoint unauthorized error.

func StatusExportPath

func StatusExportPath(id string) string

StatusExportPath returns the URL path to the export service status HTTP endpoint.

func ValidateCsvBadRequestResponseBody

func ValidateCsvBadRequestResponseBody(body *CsvBadRequestResponseBody) (err error)

ValidateCsvBadRequestResponseBody runs the validations defined on csv_bad-request_response_body

func ValidateCsvForbiddenResponseBody

func ValidateCsvForbiddenResponseBody(body *CsvForbiddenResponseBody) (err error)

ValidateCsvForbiddenResponseBody runs the validations defined on csv_forbidden_response_body

func ValidateCsvNotFoundResponseBody

func ValidateCsvNotFoundResponseBody(body *CsvNotFoundResponseBody) (err error)

ValidateCsvNotFoundResponseBody runs the validations defined on csv_not-found_response_body

func ValidateCsvUnauthorizedResponseBody

func ValidateCsvUnauthorizedResponseBody(body *CsvUnauthorizedResponseBody) (err error)

ValidateCsvUnauthorizedResponseBody runs the validations defined on csv_unauthorized_response_body

func ValidateDownloadBadRequestResponseBody

func ValidateDownloadBadRequestResponseBody(body *DownloadBadRequestResponseBody) (err error)

ValidateDownloadBadRequestResponseBody runs the validations defined on download_bad-request_response_body

func ValidateDownloadForbiddenResponseBody

func ValidateDownloadForbiddenResponseBody(body *DownloadForbiddenResponseBody) (err error)

ValidateDownloadForbiddenResponseBody runs the validations defined on download_forbidden_response_body

func ValidateDownloadNotFoundResponseBody

func ValidateDownloadNotFoundResponseBody(body *DownloadNotFoundResponseBody) (err error)

ValidateDownloadNotFoundResponseBody runs the validations defined on download_not-found_response_body

func ValidateDownloadUnauthorizedResponseBody

func ValidateDownloadUnauthorizedResponseBody(body *DownloadUnauthorizedResponseBody) (err error)

ValidateDownloadUnauthorizedResponseBody runs the validations defined on download_unauthorized_response_body

func ValidateExportStatusResponseBody

func ValidateExportStatusResponseBody(body *ExportStatusResponseBody) (err error)

ValidateExportStatusResponseBody runs the validations defined on ExportStatusResponseBody

func ValidateJSONLinesBadRequestResponseBody

func ValidateJSONLinesBadRequestResponseBody(body *JSONLinesBadRequestResponseBody) (err error)

ValidateJSONLinesBadRequestResponseBody runs the validations defined on json lines_bad-request_response_body

func ValidateJSONLinesForbiddenResponseBody

func ValidateJSONLinesForbiddenResponseBody(body *JSONLinesForbiddenResponseBody) (err error)

ValidateJSONLinesForbiddenResponseBody runs the validations defined on json lines_forbidden_response_body

func ValidateJSONLinesNotFoundResponseBody

func ValidateJSONLinesNotFoundResponseBody(body *JSONLinesNotFoundResponseBody) (err error)

ValidateJSONLinesNotFoundResponseBody runs the validations defined on json lines_not-found_response_body

func ValidateJSONLinesUnauthorizedResponseBody

func ValidateJSONLinesUnauthorizedResponseBody(body *JSONLinesUnauthorizedResponseBody) (err error)

ValidateJSONLinesUnauthorizedResponseBody runs the validations defined on json lines_unauthorized_response_body

func ValidateListMineBadRequestResponseBody

func ValidateListMineBadRequestResponseBody(body *ListMineBadRequestResponseBody) (err error)

ValidateListMineBadRequestResponseBody runs the validations defined on list mine_bad-request_response_body

func ValidateListMineForbiddenResponseBody

func ValidateListMineForbiddenResponseBody(body *ListMineForbiddenResponseBody) (err error)

ValidateListMineForbiddenResponseBody runs the validations defined on list mine_forbidden_response_body

func ValidateListMineNotFoundResponseBody

func ValidateListMineNotFoundResponseBody(body *ListMineNotFoundResponseBody) (err error)

ValidateListMineNotFoundResponseBody runs the validations defined on list mine_not-found_response_body

func ValidateListMineUnauthorizedResponseBody

func ValidateListMineUnauthorizedResponseBody(body *ListMineUnauthorizedResponseBody) (err error)

ValidateListMineUnauthorizedResponseBody runs the validations defined on list mine_unauthorized_response_body

func ValidateStatusBadRequestResponseBody

func ValidateStatusBadRequestResponseBody(body *StatusBadRequestResponseBody) (err error)

ValidateStatusBadRequestResponseBody runs the validations defined on status_bad-request_response_body

func ValidateStatusForbiddenResponseBody

func ValidateStatusForbiddenResponseBody(body *StatusForbiddenResponseBody) (err error)

ValidateStatusForbiddenResponseBody runs the validations defined on status_forbidden_response_body

func ValidateStatusNotFoundResponseBody

func ValidateStatusNotFoundResponseBody(body *StatusNotFoundResponseBody) (err error)

ValidateStatusNotFoundResponseBody runs the validations defined on status_not-found_response_body

func ValidateStatusUnauthorizedResponseBody

func ValidateStatusUnauthorizedResponseBody(body *StatusUnauthorizedResponseBody) (err error)

ValidateStatusUnauthorizedResponseBody runs the validations defined on status_unauthorized_response_body

Types

type Client

type Client struct {
	// ListMine Doer is the HTTP client used to make requests to the list mine
	// endpoint.
	ListMineDoer goahttp.Doer

	// Status Doer is the HTTP client used to make requests to the status endpoint.
	StatusDoer goahttp.Doer

	// Download Doer is the HTTP client used to make requests to the download
	// endpoint.
	DownloadDoer goahttp.Doer

	// Csv Doer is the HTTP client used to make requests to the csv endpoint.
	CsvDoer goahttp.Doer

	// JSONLines Doer is the HTTP client used to make requests to the json lines
	// endpoint.
	JSONLinesDoer 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 export 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 export service servers.

func (*Client) BuildCsvRequest

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

BuildCsvRequest instantiates a HTTP request object with method and path set to call the "export" service "csv" endpoint

func (*Client) BuildDownloadRequest

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

BuildDownloadRequest instantiates a HTTP request object with method and path set to call the "export" service "download" endpoint

func (*Client) BuildJSONLinesRequest

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

BuildJSONLinesRequest instantiates a HTTP request object with method and path set to call the "export" service "json lines" endpoint

func (*Client) BuildListMineRequest

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

BuildListMineRequest instantiates a HTTP request object with method and path set to call the "export" service "list mine" endpoint

func (*Client) BuildStatusRequest

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

BuildStatusRequest instantiates a HTTP request object with method and path set to call the "export" service "status" endpoint

func (*Client) Csv

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

Csv returns an endpoint that makes HTTP requests to the export service csv server.

func (*Client) Download

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

Download returns an endpoint that makes HTTP requests to the export service download server.

func (*Client) JSONLines

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

JSONLines returns an endpoint that makes HTTP requests to the export service json lines server.

func (*Client) ListMine

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

ListMine returns an endpoint that makes HTTP requests to the export service list mine server.

func (*Client) Status

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

Status returns an endpoint that makes HTTP requests to the export service status server.

type CsvBadRequestResponseBody

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

CsvBadRequestResponseBody is the type of the "export" service "csv" endpoint HTTP response body for the "bad-request" error.

type CsvForbiddenResponseBody

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

CsvForbiddenResponseBody is the type of the "export" service "csv" endpoint HTTP response body for the "forbidden" error.

type CsvNotFoundResponseBody

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

CsvNotFoundResponseBody is the type of the "export" service "csv" endpoint HTTP response body for the "not-found" error.

type CsvUnauthorizedResponseBody

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

CsvUnauthorizedResponseBody is the type of the "export" service "csv" endpoint HTTP response body for the "unauthorized" error.

type DownloadBadRequestResponseBody

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

DownloadBadRequestResponseBody is the type of the "export" service "download" endpoint HTTP response body for the "bad-request" error.

type DownloadForbiddenResponseBody

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

DownloadForbiddenResponseBody is the type of the "export" service "download" endpoint HTTP response body for the "forbidden" error.

type DownloadNotFoundResponseBody

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

DownloadNotFoundResponseBody is the type of the "export" service "download" endpoint HTTP response body for the "not-found" error.

type DownloadUnauthorizedResponseBody

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

DownloadUnauthorizedResponseBody is the type of the "export" service "download" endpoint HTTP response body for the "unauthorized" error.

type ExportStatusResponseBody

type ExportStatusResponseBody struct {
	ID          *int64      `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Token       *string     `form:"token,omitempty" json:"token,omitempty" xml:"token,omitempty"`
	CreatedAt   *int64      `form:"createdAt,omitempty" json:"createdAt,omitempty" xml:"createdAt,omitempty"`
	CompletedAt *int64      `form:"completedAt,omitempty" json:"completedAt,omitempty" xml:"completedAt,omitempty"`
	Format      *string     `form:"format,omitempty" json:"format,omitempty" xml:"format,omitempty"`
	Progress    *float32    `form:"progress,omitempty" json:"progress,omitempty" xml:"progress,omitempty"`
	Message     *string     `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	StatusURL   *string     `form:"statusUrl,omitempty" json:"statusUrl,omitempty" xml:"statusUrl,omitempty"`
	DownloadURL *string     `form:"downloadUrl,omitempty" json:"downloadUrl,omitempty" xml:"downloadUrl,omitempty"`
	Size        *int32      `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	Args        interface{} `form:"args,omitempty" json:"args,omitempty" xml:"args,omitempty"`
}

ExportStatusResponseBody is used to define fields on response body types.

type JSONLinesBadRequestResponseBody

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

JSONLinesBadRequestResponseBody is the type of the "export" service "json lines" endpoint HTTP response body for the "bad-request" error.

type JSONLinesForbiddenResponseBody

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

JSONLinesForbiddenResponseBody is the type of the "export" service "json lines" endpoint HTTP response body for the "forbidden" error.

type JSONLinesNotFoundResponseBody

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

JSONLinesNotFoundResponseBody is the type of the "export" service "json lines" endpoint HTTP response body for the "not-found" error.

type JSONLinesUnauthorizedResponseBody

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

JSONLinesUnauthorizedResponseBody is the type of the "export" service "json lines" endpoint HTTP response body for the "unauthorized" error.

type ListMineBadRequestResponseBody

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

ListMineBadRequestResponseBody is the type of the "export" service "list mine" endpoint HTTP response body for the "bad-request" error.

type ListMineForbiddenResponseBody

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

ListMineForbiddenResponseBody is the type of the "export" service "list mine" endpoint HTTP response body for the "forbidden" error.

type ListMineNotFoundResponseBody

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

ListMineNotFoundResponseBody is the type of the "export" service "list mine" endpoint HTTP response body for the "not-found" error.

type ListMineResponseBody

type ListMineResponseBody struct {
	Exports []*ExportStatusResponseBody `form:"exports,omitempty" json:"exports,omitempty" xml:"exports,omitempty"`
}

ListMineResponseBody is the type of the "export" service "list mine" endpoint HTTP response body.

type ListMineUnauthorizedResponseBody

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

ListMineUnauthorizedResponseBody is the type of the "export" service "list mine" endpoint HTTP response body for the "unauthorized" error.

type StatusBadRequestResponseBody

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

StatusBadRequestResponseBody is the type of the "export" service "status" endpoint HTTP response body for the "bad-request" error.

type StatusForbiddenResponseBody

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

StatusForbiddenResponseBody is the type of the "export" service "status" endpoint HTTP response body for the "forbidden" error.

type StatusNotFoundResponseBody

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

StatusNotFoundResponseBody is the type of the "export" service "status" endpoint HTTP response body for the "not-found" error.

type StatusResponseBody

type StatusResponseBody struct {
	ID          *int64      `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	Token       *string     `form:"token,omitempty" json:"token,omitempty" xml:"token,omitempty"`
	CreatedAt   *int64      `form:"createdAt,omitempty" json:"createdAt,omitempty" xml:"createdAt,omitempty"`
	CompletedAt *int64      `form:"completedAt,omitempty" json:"completedAt,omitempty" xml:"completedAt,omitempty"`
	Format      *string     `form:"format,omitempty" json:"format,omitempty" xml:"format,omitempty"`
	Progress    *float32    `form:"progress,omitempty" json:"progress,omitempty" xml:"progress,omitempty"`
	Message     *string     `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	StatusURL   *string     `form:"statusUrl,omitempty" json:"statusUrl,omitempty" xml:"statusUrl,omitempty"`
	DownloadURL *string     `form:"downloadUrl,omitempty" json:"downloadUrl,omitempty" xml:"downloadUrl,omitempty"`
	Size        *int32      `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	Args        interface{} `form:"args,omitempty" json:"args,omitempty" xml:"args,omitempty"`
}

StatusResponseBody is the type of the "export" service "status" endpoint HTTP response body.

type StatusUnauthorizedResponseBody

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

StatusUnauthorizedResponseBody is the type of the "export" service "status" endpoint HTTP response body for the "unauthorized" error.

Jump to

Keyboard shortcuts

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