misc

package
v0.0.39 Latest Latest
Warning

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

Go to latest
Published: Aug 19, 2022 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 Client

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

Client for misc API

func (*Client) GetMyUser

func (a *Client) GetMyUser(params *GetMyUserParams, opts ...ClientOption) (*GetMyUserOK, error)

GetMyUser gets information about the calling user

Get Sherlock's understanding of the calling user based on IAP and the Firecloud.org Google Workspace organization.

func (*Client) GetStatus

func (a *Client) GetStatus(params *GetStatusParams, opts ...ClientOption) (*GetStatusOK, error)
GetStatus gets sherlock s current status

Get Sherlock's current status. Right now, this endpoint always returned OK (if the server is online).

This endpoint is acceptable to use for a readiness check.

func (*Client) GetVersion

func (a *Client) GetVersion(params *GetVersionParams, opts ...ClientOption) (*GetVersionOK, error)

GetVersion gets sherlock s own current version

Get the build version of this Sherlock instance.

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 {
	GetMyUser(params *GetMyUserParams, opts ...ClientOption) (*GetMyUserOK, error)

	GetStatus(params *GetStatusParams, opts ...ClientOption) (*GetStatusOK, error)

	GetVersion(params *GetVersionParams, opts ...ClientOption) (*GetVersionOK, 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 misc API client.

type GetMyUserInternalServerError

type GetMyUserInternalServerError struct {
	Payload *models.ErrorsErrorResponse
}
GetMyUserInternalServerError describes a response with status code 500, with default header values.

Internal Server Error

func NewGetMyUserInternalServerError

func NewGetMyUserInternalServerError() *GetMyUserInternalServerError

NewGetMyUserInternalServerError creates a GetMyUserInternalServerError with default headers values

func (*GetMyUserInternalServerError) Error

func (*GetMyUserInternalServerError) GetPayload

type GetMyUserOK

type GetMyUserOK struct {
	Payload *models.MiscMyUserResponse
}
GetMyUserOK describes a response with status code 200, with default header values.

OK

func NewGetMyUserOK

func NewGetMyUserOK() *GetMyUserOK

NewGetMyUserOK creates a GetMyUserOK with default headers values

func (*GetMyUserOK) Error

func (o *GetMyUserOK) Error() string

func (*GetMyUserOK) GetPayload

func (o *GetMyUserOK) GetPayload() *models.MiscMyUserResponse

type GetMyUserParams

type GetMyUserParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetMyUserParams contains all the parameters to send to the API endpoint

for the get my user operation.

Typically these are written to a http.Request.

func NewGetMyUserParams

func NewGetMyUserParams() *GetMyUserParams

NewGetMyUserParams creates a new GetMyUserParams 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 NewGetMyUserParamsWithContext

func NewGetMyUserParamsWithContext(ctx context.Context) *GetMyUserParams

NewGetMyUserParamsWithContext creates a new GetMyUserParams object with the ability to set a context for a request.

func NewGetMyUserParamsWithHTTPClient

func NewGetMyUserParamsWithHTTPClient(client *http.Client) *GetMyUserParams

NewGetMyUserParamsWithHTTPClient creates a new GetMyUserParams object with the ability to set a custom HTTPClient for a request.

func NewGetMyUserParamsWithTimeout

func NewGetMyUserParamsWithTimeout(timeout time.Duration) *GetMyUserParams

NewGetMyUserParamsWithTimeout creates a new GetMyUserParams object with the ability to set a timeout on a request.

func (*GetMyUserParams) SetContext

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

SetContext adds the context to the get my user params

func (*GetMyUserParams) SetDefaults

func (o *GetMyUserParams) SetDefaults()

SetDefaults hydrates default values in the get my user params (not the query body).

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

func (*GetMyUserParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get my user params

func (*GetMyUserParams) SetTimeout

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

SetTimeout adds the timeout to the get my user params

func (*GetMyUserParams) WithContext

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

WithContext adds the context to the get my user params

func (*GetMyUserParams) WithDefaults

func (o *GetMyUserParams) WithDefaults() *GetMyUserParams

WithDefaults hydrates default values in the get my user params (not the query body).

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

func (*GetMyUserParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get my user params

func (*GetMyUserParams) WithTimeout

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

WithTimeout adds the timeout to the get my user params

func (*GetMyUserParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetMyUserProxyAuthenticationRequired

type GetMyUserProxyAuthenticationRequired struct {
	Payload *models.ErrorsErrorResponse
}
GetMyUserProxyAuthenticationRequired describes a response with status code 407, with default header values.

Proxy Authentication Required

func NewGetMyUserProxyAuthenticationRequired

func NewGetMyUserProxyAuthenticationRequired() *GetMyUserProxyAuthenticationRequired

NewGetMyUserProxyAuthenticationRequired creates a GetMyUserProxyAuthenticationRequired with default headers values

func (*GetMyUserProxyAuthenticationRequired) Error

func (*GetMyUserProxyAuthenticationRequired) GetPayload

type GetMyUserReader

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

GetMyUserReader is a Reader for the GetMyUser structure.

func (*GetMyUserReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetStatusOK

type GetStatusOK struct {
	Payload *models.MiscStatusResponse
}
GetStatusOK describes a response with status code 200, with default header values.

OK

func NewGetStatusOK

func NewGetStatusOK() *GetStatusOK

NewGetStatusOK creates a GetStatusOK with default headers values

func (*GetStatusOK) Error

func (o *GetStatusOK) Error() string

func (*GetStatusOK) GetPayload

func (o *GetStatusOK) GetPayload() *models.MiscStatusResponse

type GetStatusParams

type GetStatusParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetStatusParams contains all the parameters to send to the API endpoint

for the get status operation.

Typically these are written to a http.Request.

func NewGetStatusParams

func NewGetStatusParams() *GetStatusParams

NewGetStatusParams creates a new GetStatusParams 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 NewGetStatusParamsWithContext

func NewGetStatusParamsWithContext(ctx context.Context) *GetStatusParams

NewGetStatusParamsWithContext creates a new GetStatusParams object with the ability to set a context for a request.

func NewGetStatusParamsWithHTTPClient

func NewGetStatusParamsWithHTTPClient(client *http.Client) *GetStatusParams

NewGetStatusParamsWithHTTPClient creates a new GetStatusParams object with the ability to set a custom HTTPClient for a request.

func NewGetStatusParamsWithTimeout

func NewGetStatusParamsWithTimeout(timeout time.Duration) *GetStatusParams

NewGetStatusParamsWithTimeout creates a new GetStatusParams object with the ability to set a timeout on a request.

func (*GetStatusParams) SetContext

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

SetContext adds the context to the get status params

func (*GetStatusParams) SetDefaults

func (o *GetStatusParams) SetDefaults()

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

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

func (*GetStatusParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get status params

func (*GetStatusParams) SetTimeout

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

SetTimeout adds the timeout to the get status params

func (*GetStatusParams) WithContext

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

WithContext adds the context to the get status params

func (*GetStatusParams) WithDefaults

func (o *GetStatusParams) WithDefaults() *GetStatusParams

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

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

func (*GetStatusParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get status params

func (*GetStatusParams) WithTimeout

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

WithTimeout adds the timeout to the get status params

func (*GetStatusParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetStatusReader

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

GetStatusReader is a Reader for the GetStatus structure.

func (*GetStatusReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetVersionOK

type GetVersionOK struct {
	Payload *models.MiscVersionResponse
}
GetVersionOK describes a response with status code 200, with default header values.

OK

func NewGetVersionOK

func NewGetVersionOK() *GetVersionOK

NewGetVersionOK creates a GetVersionOK with default headers values

func (*GetVersionOK) Error

func (o *GetVersionOK) Error() string

func (*GetVersionOK) GetPayload

func (o *GetVersionOK) GetPayload() *models.MiscVersionResponse

type GetVersionParams

type GetVersionParams struct {
	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

GetVersionParams contains all the parameters to send to the API endpoint

for the get version operation.

Typically these are written to a http.Request.

func NewGetVersionParams

func NewGetVersionParams() *GetVersionParams

NewGetVersionParams creates a new GetVersionParams 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 NewGetVersionParamsWithContext

func NewGetVersionParamsWithContext(ctx context.Context) *GetVersionParams

NewGetVersionParamsWithContext creates a new GetVersionParams object with the ability to set a context for a request.

func NewGetVersionParamsWithHTTPClient

func NewGetVersionParamsWithHTTPClient(client *http.Client) *GetVersionParams

NewGetVersionParamsWithHTTPClient creates a new GetVersionParams object with the ability to set a custom HTTPClient for a request.

func NewGetVersionParamsWithTimeout

func NewGetVersionParamsWithTimeout(timeout time.Duration) *GetVersionParams

NewGetVersionParamsWithTimeout creates a new GetVersionParams object with the ability to set a timeout on a request.

func (*GetVersionParams) SetContext

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

SetContext adds the context to the get version params

func (*GetVersionParams) SetDefaults

func (o *GetVersionParams) SetDefaults()

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

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

func (*GetVersionParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) SetTimeout

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

SetTimeout adds the timeout to the get version params

func (*GetVersionParams) WithContext

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

WithContext adds the context to the get version params

func (*GetVersionParams) WithDefaults

func (o *GetVersionParams) WithDefaults() *GetVersionParams

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

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

func (*GetVersionParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get version params

func (*GetVersionParams) WithTimeout

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

WithTimeout adds the timeout to the get version params

func (*GetVersionParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetVersionReader

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

GetVersionReader is a Reader for the GetVersion structure.

func (*GetVersionReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

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