Documentation
¶
Index ¶
- type Client
- type ClientOption
- type ClientService
- type SearchResultBadRequest
- type SearchResultForbidden
- type SearchResultInternalServerError
- type SearchResultOK
- type SearchResultParams
- func (o *SearchResultParams) SetContext(ctx context.Context)
- func (o *SearchResultParams) SetDefaults()
- func (o *SearchResultParams) SetHTTPClient(client *http.Client)
- func (o *SearchResultParams) SetTimeout(timeout time.Duration)
- func (o *SearchResultParams) WithContext(ctx context.Context) *SearchResultParams
- func (o *SearchResultParams) WithDefaults() *SearchResultParams
- func (o *SearchResultParams) WithHTTPClient(client *http.Client) *SearchResultParams
- func (o *SearchResultParams) WithTimeout(timeout time.Duration) *SearchResultParams
- func (o *SearchResultParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SearchResultReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for enterprise API
func (*Client) SearchResult ¶
func (a *Client) SearchResult(params *SearchResultParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchResultOK, error)
SearchResult debugs permissions Returns the result of the search through access-control role assignments.
You need to have a permission with action `teams.roles:read` on scope `teams:*` and a permission with action `users.roles:read` on scope `users:*`.
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 {
SearchResult(params *SearchResultParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*SearchResultOK, 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 enterprise API client.
type SearchResultBadRequest ¶
type SearchResultBadRequest struct {
Payload *models.ErrorResponseBody
}
SearchResultBadRequest describes a response with status code 400, with default header values.
BadRequestError is returned when the request is invalid and it cannot be processed.
func NewSearchResultBadRequest ¶
func NewSearchResultBadRequest() *SearchResultBadRequest
NewSearchResultBadRequest creates a SearchResultBadRequest with default headers values
func (*SearchResultBadRequest) Error ¶
func (o *SearchResultBadRequest) Error() string
func (*SearchResultBadRequest) GetPayload ¶
func (o *SearchResultBadRequest) GetPayload() *models.ErrorResponseBody
type SearchResultForbidden ¶
type SearchResultForbidden struct {
Payload *models.ErrorResponseBody
}
SearchResultForbidden describes a response with status code 403, with default header values.
ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
func NewSearchResultForbidden ¶
func NewSearchResultForbidden() *SearchResultForbidden
NewSearchResultForbidden creates a SearchResultForbidden with default headers values
func (*SearchResultForbidden) Error ¶
func (o *SearchResultForbidden) Error() string
func (*SearchResultForbidden) GetPayload ¶
func (o *SearchResultForbidden) GetPayload() *models.ErrorResponseBody
type SearchResultInternalServerError ¶
type SearchResultInternalServerError struct {
Payload *models.ErrorResponseBody
}
SearchResultInternalServerError describes a response with status code 500, with default header values.
InternalServerError is a general error indicating something went wrong internally.
func NewSearchResultInternalServerError ¶
func NewSearchResultInternalServerError() *SearchResultInternalServerError
NewSearchResultInternalServerError creates a SearchResultInternalServerError with default headers values
func (*SearchResultInternalServerError) Error ¶
func (o *SearchResultInternalServerError) Error() string
func (*SearchResultInternalServerError) GetPayload ¶
func (o *SearchResultInternalServerError) GetPayload() *models.ErrorResponseBody
type SearchResultOK ¶
type SearchResultOK struct {
Payload *models.SearchResult
}
SearchResultOK describes a response with status code 200, with default header values.
(empty)
func NewSearchResultOK ¶
func NewSearchResultOK() *SearchResultOK
NewSearchResultOK creates a SearchResultOK with default headers values
func (*SearchResultOK) Error ¶
func (o *SearchResultOK) Error() string
func (*SearchResultOK) GetPayload ¶
func (o *SearchResultOK) GetPayload() *models.SearchResult
type SearchResultParams ¶
type SearchResultParams struct {
Context context.Context
HTTPClient *http.Client
// contains filtered or unexported fields
}
SearchResultParams contains all the parameters to send to the API endpoint
for the search result operation. Typically these are written to a http.Request.
func NewSearchResultParams ¶
func NewSearchResultParams() *SearchResultParams
NewSearchResultParams creates a new SearchResultParams 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 NewSearchResultParamsWithContext ¶
func NewSearchResultParamsWithContext(ctx context.Context) *SearchResultParams
NewSearchResultParamsWithContext creates a new SearchResultParams object with the ability to set a context for a request.
func NewSearchResultParamsWithHTTPClient ¶
func NewSearchResultParamsWithHTTPClient(client *http.Client) *SearchResultParams
NewSearchResultParamsWithHTTPClient creates a new SearchResultParams object with the ability to set a custom HTTPClient for a request.
func NewSearchResultParamsWithTimeout ¶
func NewSearchResultParamsWithTimeout(timeout time.Duration) *SearchResultParams
NewSearchResultParamsWithTimeout creates a new SearchResultParams object with the ability to set a timeout on a request.
func (*SearchResultParams) SetContext ¶
func (o *SearchResultParams) SetContext(ctx context.Context)
SetContext adds the context to the search result params
func (*SearchResultParams) SetDefaults ¶
func (o *SearchResultParams) SetDefaults()
SetDefaults hydrates default values in the search result params (not the query body).
All values with no default are reset to their zero value.
func (*SearchResultParams) SetHTTPClient ¶
func (o *SearchResultParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the search result params
func (*SearchResultParams) SetTimeout ¶
func (o *SearchResultParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the search result params
func (*SearchResultParams) WithContext ¶
func (o *SearchResultParams) WithContext(ctx context.Context) *SearchResultParams
WithContext adds the context to the search result params
func (*SearchResultParams) WithDefaults ¶
func (o *SearchResultParams) WithDefaults() *SearchResultParams
WithDefaults hydrates default values in the search result params (not the query body).
All values with no default are reset to their zero value.
func (*SearchResultParams) WithHTTPClient ¶
func (o *SearchResultParams) WithHTTPClient(client *http.Client) *SearchResultParams
WithHTTPClient adds the HTTPClient to the search result params
func (*SearchResultParams) WithTimeout ¶
func (o *SearchResultParams) WithTimeout(timeout time.Duration) *SearchResultParams
WithTimeout adds the timeout to the search result params
func (*SearchResultParams) WriteToRequest ¶
func (o *SearchResultParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SearchResultReader ¶
type SearchResultReader struct {
// contains filtered or unexported fields
}
SearchResultReader is a Reader for the SearchResult structure.
func (*SearchResultReader) ReadResponse ¶
func (o *SearchResultReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
Source Files