index

package
v1.3.7 Latest Latest
Warning

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

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 11 Imported by: 23

Documentation

Index

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 index API

func (*Client) SearchIndex 

func (a *Client) SearchIndex(params *SearchIndexParams, opts ...ClientOption) (*SearchIndexOK, error)
SearchIndex searches index by entry metadata

EXPERIMENTAL - this endpoint is offered as best effort only and may be changed or removed in future releases.

The results returned from this endpoint may be incomplete.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientOption added in v0.2.0 

type ClientOption func(*runtime.ClientOperation)

ClientOption may be used to customize the behavior of Client methods.

type ClientService 

type ClientService interface {
	SearchIndex(params *SearchIndexParams, opts ...ClientOption) (*SearchIndexOK, 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 index API client.

func NewClientWithBasicAuth added in v1.3.7 

func NewClientWithBasicAuth(host, basePath, scheme, user, password string) ClientService

New creates a new index API client with basic auth credentials. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - user: user for basic authentication header. - password: password for basic authentication header.

func NewClientWithBearerToken added in v1.3.7 

func NewClientWithBearerToken(host, basePath, scheme, bearerToken string) ClientService

New creates a new index API client with a bearer token for authentication. It takes the following parameters: - host: http host (github.com). - basePath: any base path for the API client ("/v1", "/v3"). - scheme: http scheme ("http", "https"). - bearerToken: bearer token for Bearer authentication header.

type SearchIndexBadRequest 

type SearchIndexBadRequest struct {
	Payload *models.Error
}

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

The content supplied to the server was invalid

func NewSearchIndexBadRequest 

func NewSearchIndexBadRequest() *SearchIndexBadRequest

NewSearchIndexBadRequest creates a SearchIndexBadRequest with default headers values

func (*SearchIndexBadRequest) Code added in v1.1.0 

func (o *SearchIndexBadRequest) Code() int

Code gets the status code for the search index bad request response

func (*SearchIndexBadRequest) Error 

func (o *SearchIndexBadRequest) Error() string

func (*SearchIndexBadRequest) GetPayload 

func (o *SearchIndexBadRequest) GetPayload() *models.Error

func (*SearchIndexBadRequest) IsClientError added in v0.12.1 

func (o *SearchIndexBadRequest) IsClientError() bool

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

func (*SearchIndexBadRequest) IsCode added in v0.12.1 

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

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

func (*SearchIndexBadRequest) IsRedirect added in v0.12.1 

func (o *SearchIndexBadRequest) IsRedirect() bool

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

func (*SearchIndexBadRequest) IsServerError added in v0.12.1 

func (o *SearchIndexBadRequest) IsServerError() bool

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

func (*SearchIndexBadRequest) IsSuccess added in v0.12.1 

func (o *SearchIndexBadRequest) IsSuccess() bool

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

func (*SearchIndexBadRequest) String added in v0.12.1 

func (o *SearchIndexBadRequest) String() string

type SearchIndexDefault 

type SearchIndexDefault struct {
	Payload *models.Error
	// contains filtered or unexported fields
}

SearchIndexDefault describes a response with status code -1, with default header values.

There was an internal error in the server while processing the request

func NewSearchIndexDefault 

func NewSearchIndexDefault(code int) *SearchIndexDefault

NewSearchIndexDefault creates a SearchIndexDefault with default headers values

func (*SearchIndexDefault) Code 

func (o *SearchIndexDefault) Code() int

Code gets the status code for the search index default response

func (*SearchIndexDefault) Error 

func (o *SearchIndexDefault) Error() string

func (*SearchIndexDefault) GetPayload 

func (o *SearchIndexDefault) GetPayload() *models.Error

func (*SearchIndexDefault) IsClientError added in v0.12.1 

func (o *SearchIndexDefault) IsClientError() bool

IsClientError returns true when this search index default response has a 4xx status code

func (*SearchIndexDefault) IsCode added in v0.12.1 

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

IsCode returns true when this search index default response a status code equal to that given

func (*SearchIndexDefault) IsRedirect added in v0.12.1 

func (o *SearchIndexDefault) IsRedirect() bool

IsRedirect returns true when this search index default response has a 3xx status code

func (*SearchIndexDefault) IsServerError added in v0.12.1 

func (o *SearchIndexDefault) IsServerError() bool

IsServerError returns true when this search index default response has a 5xx status code

func (*SearchIndexDefault) IsSuccess added in v0.12.1 

func (o *SearchIndexDefault) IsSuccess() bool

IsSuccess returns true when this search index default response has a 2xx status code

func (*SearchIndexDefault) String added in v0.12.1 

func (o *SearchIndexDefault) String() string

type SearchIndexOK 

type SearchIndexOK struct {
	Payload []string
}

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

Returns zero or more entry UUIDs from the transparency log based on search query

func NewSearchIndexOK 

func NewSearchIndexOK() *SearchIndexOK

NewSearchIndexOK creates a SearchIndexOK with default headers values

func (*SearchIndexOK) Code added in v1.1.0 

func (o *SearchIndexOK) Code() int

Code gets the status code for the search index o k response

func (*SearchIndexOK) Error 

func (o *SearchIndexOK) Error() string

func (*SearchIndexOK) GetPayload 

func (o *SearchIndexOK) GetPayload() []string

func (*SearchIndexOK) IsClientError added in v0.12.1 

func (o *SearchIndexOK) IsClientError() bool

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

func (*SearchIndexOK) IsCode added in v0.12.1 

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

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

func (*SearchIndexOK) IsRedirect added in v0.12.1 

func (o *SearchIndexOK) IsRedirect() bool

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

func (*SearchIndexOK) IsServerError added in v0.12.1 

func (o *SearchIndexOK) IsServerError() bool

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

func (*SearchIndexOK) IsSuccess added in v0.12.1 

func (o *SearchIndexOK) IsSuccess() bool

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

func (*SearchIndexOK) String added in v0.12.1 

func (o *SearchIndexOK) String() string

type SearchIndexParams 

type SearchIndexParams struct {

	// Query.
	Query *models.SearchIndex

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

SearchIndexParams contains all the parameters to send to the API endpoint 

for the search index operation.

Typically these are written to a http.Request.

func NewSearchIndexParams 

func NewSearchIndexParams() *SearchIndexParams

NewSearchIndexParams creates a new SearchIndexParams 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 NewSearchIndexParamsWithContext 

func NewSearchIndexParamsWithContext(ctx context.Context) *SearchIndexParams

NewSearchIndexParamsWithContext creates a new SearchIndexParams object with the ability to set a context for a request.

func NewSearchIndexParamsWithHTTPClient 

func NewSearchIndexParamsWithHTTPClient(client *http.Client) *SearchIndexParams

NewSearchIndexParamsWithHTTPClient creates a new SearchIndexParams object with the ability to set a custom HTTPClient for a request.

func NewSearchIndexParamsWithTimeout 

func NewSearchIndexParamsWithTimeout(timeout time.Duration) *SearchIndexParams

NewSearchIndexParamsWithTimeout creates a new SearchIndexParams object with the ability to set a timeout on a request.

func (*SearchIndexParams) SetContext 

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

SetContext adds the context to the search index params

func (*SearchIndexParams) SetDefaults added in v0.2.0 

func (o *SearchIndexParams) SetDefaults()

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

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

func (*SearchIndexParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the search index params

func (*SearchIndexParams) SetQuery 

func (o *SearchIndexParams) SetQuery(query *models.SearchIndex)

SetQuery adds the query to the search index params

func (*SearchIndexParams) SetTimeout 

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

SetTimeout adds the timeout to the search index params

func (*SearchIndexParams) WithContext 

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

WithContext adds the context to the search index params

func (*SearchIndexParams) WithDefaults added in v0.2.0 

func (o *SearchIndexParams) WithDefaults() *SearchIndexParams

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

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

func (*SearchIndexParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the search index params

func (*SearchIndexParams) WithQuery 

func (o *SearchIndexParams) WithQuery(query *models.SearchIndex) *SearchIndexParams

WithQuery adds the query to the search index params

func (*SearchIndexParams) WithTimeout 

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

WithTimeout adds the timeout to the search index params

func (*SearchIndexParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type SearchIndexReader 

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

SearchIndexReader is a Reader for the SearchIndex structure.

func (*SearchIndexReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

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.