aggregate

package
v1.38.10 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2026 License: BSD-3-Clause Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AggregateBadRequest 

type AggregateBadRequest struct {
	Payload *models.ErrorResponse
}

AggregateBadRequest describes a response with status code 400, with default header values.

An invalid parameter value (e.g. an unknown groupBy property, a non-positive limit, limit without groupBy, an unknown filter property) or an unparseable request body.

func NewAggregateBadRequest 

func NewAggregateBadRequest() *AggregateBadRequest

NewAggregateBadRequest creates a AggregateBadRequest with default headers values

func (*AggregateBadRequest) Code 

func (o *AggregateBadRequest) Code() int

Code gets the status code for the aggregate bad request response

func (*AggregateBadRequest) Error 

func (o *AggregateBadRequest) Error() string

func (*AggregateBadRequest) GetPayload 

func (o *AggregateBadRequest) GetPayload() *models.ErrorResponse

func (*AggregateBadRequest) IsClientError 

func (o *AggregateBadRequest) IsClientError() bool

IsClientError returns true when this aggregate bad request response has a 4xx status code

func (*AggregateBadRequest) IsCode 

func (o *AggregateBadRequest) IsCode(code int) bool

IsCode returns true when this aggregate bad request response a status code equal to that given

func (*AggregateBadRequest) IsRedirect 

func (o *AggregateBadRequest) IsRedirect() bool

IsRedirect returns true when this aggregate bad request response has a 3xx status code

func (*AggregateBadRequest) IsServerError 

func (o *AggregateBadRequest) IsServerError() bool

IsServerError returns true when this aggregate bad request response has a 5xx status code

func (*AggregateBadRequest) IsSuccess 

func (o *AggregateBadRequest) IsSuccess() bool

IsSuccess returns true when this aggregate bad request response has a 2xx status code

func (*AggregateBadRequest) String 

func (o *AggregateBadRequest) String() string

type AggregateForbidden 

type AggregateForbidden struct {
	Payload *models.ErrorResponse
}

AggregateForbidden describes a response with status code 403, with default header values.

Forbidden

func NewAggregateForbidden 

func NewAggregateForbidden() *AggregateForbidden

NewAggregateForbidden creates a AggregateForbidden with default headers values

func (*AggregateForbidden) Code 

func (o *AggregateForbidden) Code() int

Code gets the status code for the aggregate forbidden response

func (*AggregateForbidden) Error 

func (o *AggregateForbidden) Error() string

func (*AggregateForbidden) GetPayload 

func (o *AggregateForbidden) GetPayload() *models.ErrorResponse

func (*AggregateForbidden) IsClientError 

func (o *AggregateForbidden) IsClientError() bool

IsClientError returns true when this aggregate forbidden response has a 4xx status code

func (*AggregateForbidden) IsCode 

func (o *AggregateForbidden) IsCode(code int) bool

IsCode returns true when this aggregate forbidden response a status code equal to that given

func (*AggregateForbidden) IsRedirect 

func (o *AggregateForbidden) IsRedirect() bool

IsRedirect returns true when this aggregate forbidden response has a 3xx status code

func (*AggregateForbidden) IsServerError 

func (o *AggregateForbidden) IsServerError() bool

IsServerError returns true when this aggregate forbidden response has a 5xx status code

func (*AggregateForbidden) IsSuccess 

func (o *AggregateForbidden) IsSuccess() bool

IsSuccess returns true when this aggregate forbidden response has a 2xx status code

func (*AggregateForbidden) String 

func (o *AggregateForbidden) String() string

type AggregateInternalServerError 

type AggregateInternalServerError struct {
	Payload *models.ErrorResponse
}

AggregateInternalServerError describes a response with status code 500, with default header values.

An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.

func NewAggregateInternalServerError 

func NewAggregateInternalServerError() *AggregateInternalServerError

NewAggregateInternalServerError creates a AggregateInternalServerError with default headers values

func (*AggregateInternalServerError) Code 

func (o *AggregateInternalServerError) Code() int

Code gets the status code for the aggregate internal server error response

func (*AggregateInternalServerError) Error 

func (o *AggregateInternalServerError) Error() string

func (*AggregateInternalServerError) GetPayload 

func (o *AggregateInternalServerError) GetPayload() *models.ErrorResponse

func (*AggregateInternalServerError) IsClientError 

func (o *AggregateInternalServerError) IsClientError() bool

IsClientError returns true when this aggregate internal server error response has a 4xx status code

func (*AggregateInternalServerError) IsCode 

func (o *AggregateInternalServerError) IsCode(code int) bool

IsCode returns true when this aggregate internal server error response a status code equal to that given

func (*AggregateInternalServerError) IsRedirect 

func (o *AggregateInternalServerError) IsRedirect() bool

IsRedirect returns true when this aggregate internal server error response has a 3xx status code

func (*AggregateInternalServerError) IsServerError 

func (o *AggregateInternalServerError) IsServerError() bool

IsServerError returns true when this aggregate internal server error response has a 5xx status code

func (*AggregateInternalServerError) IsSuccess 

func (o *AggregateInternalServerError) IsSuccess() bool

IsSuccess returns true when this aggregate internal server error response has a 2xx status code

func (*AggregateInternalServerError) String 

func (o *AggregateInternalServerError) String() string

type AggregateNotFound 

type AggregateNotFound struct {
	Payload *models.ErrorResponse
}

AggregateNotFound describes a response with status code 404, with default header values.

Unknown collection or tenant.

func NewAggregateNotFound 

func NewAggregateNotFound() *AggregateNotFound

NewAggregateNotFound creates a AggregateNotFound with default headers values

func (*AggregateNotFound) Code 

func (o *AggregateNotFound) Code() int

Code gets the status code for the aggregate not found response

func (*AggregateNotFound) Error 

func (o *AggregateNotFound) Error() string

func (*AggregateNotFound) GetPayload 

func (o *AggregateNotFound) GetPayload() *models.ErrorResponse

func (*AggregateNotFound) IsClientError 

func (o *AggregateNotFound) IsClientError() bool

IsClientError returns true when this aggregate not found response has a 4xx status code

func (*AggregateNotFound) IsCode 

func (o *AggregateNotFound) IsCode(code int) bool

IsCode returns true when this aggregate not found response a status code equal to that given

func (*AggregateNotFound) IsRedirect 

func (o *AggregateNotFound) IsRedirect() bool

IsRedirect returns true when this aggregate not found response has a 3xx status code

func (*AggregateNotFound) IsServerError 

func (o *AggregateNotFound) IsServerError() bool

IsServerError returns true when this aggregate not found response has a 5xx status code

func (*AggregateNotFound) IsSuccess 

func (o *AggregateNotFound) IsSuccess() bool

IsSuccess returns true when this aggregate not found response has a 2xx status code

func (*AggregateNotFound) String 

func (o *AggregateNotFound) String() string

type AggregateOK 

type AggregateOK struct {
	Payload *models.AggregateResponse
}

AggregateOK describes a response with status code 200, with default header values.

Aggregation performed successfully.

func NewAggregateOK 

func NewAggregateOK() *AggregateOK

NewAggregateOK creates a AggregateOK with default headers values

func (*AggregateOK) Code 

func (o *AggregateOK) Code() int

Code gets the status code for the aggregate o k response

func (*AggregateOK) Error 

func (o *AggregateOK) Error() string

func (*AggregateOK) GetPayload 

func (o *AggregateOK) GetPayload() *models.AggregateResponse

func (*AggregateOK) IsClientError 

func (o *AggregateOK) IsClientError() bool

IsClientError returns true when this aggregate o k response has a 4xx status code

func (*AggregateOK) IsCode 

func (o *AggregateOK) IsCode(code int) bool

IsCode returns true when this aggregate o k response a status code equal to that given

func (*AggregateOK) IsRedirect 

func (o *AggregateOK) IsRedirect() bool

IsRedirect returns true when this aggregate o k response has a 3xx status code

func (*AggregateOK) IsServerError 

func (o *AggregateOK) IsServerError() bool

IsServerError returns true when this aggregate o k response has a 5xx status code

func (*AggregateOK) IsSuccess 

func (o *AggregateOK) IsSuccess() bool

IsSuccess returns true when this aggregate o k response has a 2xx status code

func (*AggregateOK) String 

func (o *AggregateOK) String() string

type AggregateParams 

type AggregateParams struct {

	/* Body.

	   The aggregate request.
	*/
	Body *models.AggregateRequest

	/* Collection.

	   The name (or alias) of the collection to aggregate over. A lowercase first letter is normalized to the canonical uppercase form.
	*/
	Collection string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

AggregateParams contains all the parameters to send to the API endpoint 

for the aggregate operation.

Typically these are written to a http.Request.

func NewAggregateParams 

func NewAggregateParams() *AggregateParams

NewAggregateParams creates a new AggregateParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewAggregateParamsWithContext 

func NewAggregateParamsWithContext(ctx context.Context) *AggregateParams

NewAggregateParamsWithContext creates a new AggregateParams object with the ability to set a context for a request.

func NewAggregateParamsWithHTTPClient 

func NewAggregateParamsWithHTTPClient(client *http.Client) *AggregateParams

NewAggregateParamsWithHTTPClient creates a new AggregateParams object with the ability to set a custom HTTPClient for a request.

func NewAggregateParamsWithTimeout 

func NewAggregateParamsWithTimeout(timeout time.Duration) *AggregateParams

NewAggregateParamsWithTimeout creates a new AggregateParams object with the ability to set a timeout on a request.

func (*AggregateParams) SetBody 

func (o *AggregateParams) SetBody(body *models.AggregateRequest)

SetBody adds the body to the aggregate params

func (*AggregateParams) SetCollection 

func (o *AggregateParams) SetCollection(collection string)

SetCollection adds the collection to the aggregate params

func (*AggregateParams) SetContext 

func (o *AggregateParams) SetContext(ctx context.Context)

SetContext adds the context to the aggregate params

func (*AggregateParams) SetDefaults 

func (o *AggregateParams) SetDefaults()

SetDefaults hydrates default values in the aggregate params (not the query body).

All values with no default are reset to their zero value.

func (*AggregateParams) SetHTTPClient 

func (o *AggregateParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the aggregate params

func (*AggregateParams) SetTimeout 

func (o *AggregateParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the aggregate params

func (*AggregateParams) WithBody 

func (o *AggregateParams) WithBody(body *models.AggregateRequest) *AggregateParams

WithBody adds the body to the aggregate params

func (*AggregateParams) WithCollection 

func (o *AggregateParams) WithCollection(collection string) *AggregateParams

WithCollection adds the collection to the aggregate params

func (*AggregateParams) WithContext 

func (o *AggregateParams) WithContext(ctx context.Context) *AggregateParams

WithContext adds the context to the aggregate params

func (*AggregateParams) WithDefaults 

func (o *AggregateParams) WithDefaults() *AggregateParams

WithDefaults hydrates default values in the aggregate params (not the query body).

All values with no default are reset to their zero value.

func (*AggregateParams) WithHTTPClient 

func (o *AggregateParams) WithHTTPClient(client *http.Client) *AggregateParams

WithHTTPClient adds the HTTPClient to the aggregate params

func (*AggregateParams) WithTimeout 

func (o *AggregateParams) WithTimeout(timeout time.Duration) *AggregateParams

WithTimeout adds the timeout to the aggregate params

func (*AggregateParams) WriteToRequest 

func (o *AggregateParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type AggregateReader 

type AggregateReader struct {
	// contains filtered or unexported fields
}

AggregateReader is a Reader for the Aggregate structure.

func (*AggregateReader) ReadResponse 

func (o *AggregateReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type AggregateServiceUnavailable 

type AggregateServiceUnavailable struct {
	Payload *models.ErrorResponse
}

AggregateServiceUnavailable describes a response with status code 503, with default header values.

The server is in an operational mode that blocks aggregations (e.g. WRITE_ONLY); retry once the server returns to normal operation.

func NewAggregateServiceUnavailable 

func NewAggregateServiceUnavailable() *AggregateServiceUnavailable

NewAggregateServiceUnavailable creates a AggregateServiceUnavailable with default headers values

func (*AggregateServiceUnavailable) Code 

func (o *AggregateServiceUnavailable) Code() int

Code gets the status code for the aggregate service unavailable response

func (*AggregateServiceUnavailable) Error 

func (o *AggregateServiceUnavailable) Error() string

func (*AggregateServiceUnavailable) GetPayload 

func (o *AggregateServiceUnavailable) GetPayload() *models.ErrorResponse

func (*AggregateServiceUnavailable) IsClientError 

func (o *AggregateServiceUnavailable) IsClientError() bool

IsClientError returns true when this aggregate service unavailable response has a 4xx status code

func (*AggregateServiceUnavailable) IsCode 

func (o *AggregateServiceUnavailable) IsCode(code int) bool

IsCode returns true when this aggregate service unavailable response a status code equal to that given

func (*AggregateServiceUnavailable) IsRedirect 

func (o *AggregateServiceUnavailable) IsRedirect() bool

IsRedirect returns true when this aggregate service unavailable response has a 3xx status code

func (*AggregateServiceUnavailable) IsServerError 

func (o *AggregateServiceUnavailable) IsServerError() bool

IsServerError returns true when this aggregate service unavailable response has a 5xx status code

func (*AggregateServiceUnavailable) IsSuccess 

func (o *AggregateServiceUnavailable) IsSuccess() bool

IsSuccess returns true when this aggregate service unavailable response has a 2xx status code

func (*AggregateServiceUnavailable) String 

func (o *AggregateServiceUnavailable) String() string

type AggregateUnauthorized 

type AggregateUnauthorized struct {
	Payload *models.ErrorResponse
}

AggregateUnauthorized describes a response with status code 401, with default header values.

Unauthorized or invalid credentials.

func NewAggregateUnauthorized 

func NewAggregateUnauthorized() *AggregateUnauthorized

NewAggregateUnauthorized creates a AggregateUnauthorized with default headers values

func (*AggregateUnauthorized) Code 

func (o *AggregateUnauthorized) Code() int

Code gets the status code for the aggregate unauthorized response

func (*AggregateUnauthorized) Error 

func (o *AggregateUnauthorized) Error() string

func (*AggregateUnauthorized) GetPayload 

func (o *AggregateUnauthorized) GetPayload() *models.ErrorResponse

func (*AggregateUnauthorized) IsClientError 

func (o *AggregateUnauthorized) IsClientError() bool

IsClientError returns true when this aggregate unauthorized response has a 4xx status code

func (*AggregateUnauthorized) IsCode 

func (o *AggregateUnauthorized) IsCode(code int) bool

IsCode returns true when this aggregate unauthorized response a status code equal to that given

func (*AggregateUnauthorized) IsRedirect 

func (o *AggregateUnauthorized) IsRedirect() bool

IsRedirect returns true when this aggregate unauthorized response has a 3xx status code

func (*AggregateUnauthorized) IsServerError 

func (o *AggregateUnauthorized) IsServerError() bool

IsServerError returns true when this aggregate unauthorized response has a 5xx status code

func (*AggregateUnauthorized) IsSuccess 

func (o *AggregateUnauthorized) IsSuccess() bool

IsSuccess returns true when this aggregate unauthorized response has a 2xx status code

func (*AggregateUnauthorized) String 

func (o *AggregateUnauthorized) String() string

type AggregateUnprocessableEntity 

type AggregateUnprocessableEntity struct {
	Payload *models.ErrorResponse
}

AggregateUnprocessableEntity describes a response with status code 422, with default header values.

Either a request-schema violation (an invalid enum or field type in the where filter), or a well-formed request that cannot run: a reserved (not yet supported) parameter or returnMetrics entry is present, the tenant usage does not match the collection's multi-tenancy configuration, a where filter targets a property whose inverted index is disabled, or the experimental REST Search API is not enabled (set EXPERIMENTAL_REST_SEARCH_ENABLED=true).

func NewAggregateUnprocessableEntity 

func NewAggregateUnprocessableEntity() *AggregateUnprocessableEntity

NewAggregateUnprocessableEntity creates a AggregateUnprocessableEntity with default headers values

func (*AggregateUnprocessableEntity) Code 

func (o *AggregateUnprocessableEntity) Code() int

Code gets the status code for the aggregate unprocessable entity response

func (*AggregateUnprocessableEntity) Error 

func (o *AggregateUnprocessableEntity) Error() string

func (*AggregateUnprocessableEntity) GetPayload 

func (o *AggregateUnprocessableEntity) GetPayload() *models.ErrorResponse

func (*AggregateUnprocessableEntity) IsClientError 

func (o *AggregateUnprocessableEntity) IsClientError() bool

IsClientError returns true when this aggregate unprocessable entity response has a 4xx status code

func (*AggregateUnprocessableEntity) IsCode 

func (o *AggregateUnprocessableEntity) IsCode(code int) bool

IsCode returns true when this aggregate unprocessable entity response a status code equal to that given

func (*AggregateUnprocessableEntity) IsRedirect 

func (o *AggregateUnprocessableEntity) IsRedirect() bool

IsRedirect returns true when this aggregate unprocessable entity response has a 3xx status code

func (*AggregateUnprocessableEntity) IsServerError 

func (o *AggregateUnprocessableEntity) IsServerError() bool

IsServerError returns true when this aggregate unprocessable entity response has a 5xx status code

func (*AggregateUnprocessableEntity) IsSuccess 

func (o *AggregateUnprocessableEntity) IsSuccess() bool

IsSuccess returns true when this aggregate unprocessable entity response has a 2xx status code

func (*AggregateUnprocessableEntity) String 

func (o *AggregateUnprocessableEntity) String() string

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client for aggregate API

func (*Client) Aggregate 

func (a *Client) Aggregate(params *AggregateParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AggregateOK, error)

Aggregate aggregates over a collection

Aggregates over the objects of a collection. Phase 1 supports counts: the number of matching objects, either in total (flat `count` response) or per group of a `groupBy` property (`groups` response). A `where` filter limits the objects that are aggregated; an empty body returns the collection's total object count.

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption 

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService 

type ClientService interface {
	Aggregate(params *AggregateParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*AggregateOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new aggregate API client.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.