operations

package
v0.8.5 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2024 License: MPL-2.0 Imports: 9 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	SupportedOptionServerURL            = "serverURL"
	SupportedOptionRetries              = "retries"
	SupportedOptionTimeout              = "timeout"
	SupportedOptionAcceptHeaderOverride = "acceptHeaderOverride"
	SupportedOptionURLOverride          = "urlOverride"
)

Variables

View Source 
var ErrUnsupportedOption = errors.New("unsupported option")

Functions

This section is empty.

Types

type AcceptHeaderEnum 

type AcceptHeaderEnum string
const (
	AcceptHeaderEnumApplicationJson AcceptHeaderEnum = "application/json"
	AcceptHeaderEnumTextPlain       AcceptHeaderEnum = "text/plain"
)

func (AcceptHeaderEnum) ToPointer 

func (e AcceptHeaderEnum) ToPointer() *AcceptHeaderEnum

type AuthenticateResponse 

type AuthenticateResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Object *AuthenticateResponseBody
}

func (*AuthenticateResponse) GetContentType 

func (o *AuthenticateResponse) GetContentType() string

func (*AuthenticateResponse) GetObject added in v0.7.2 

func (o *AuthenticateResponse) GetObject() *AuthenticateResponseBody

func (*AuthenticateResponse) GetRawResponse 

func (o *AuthenticateResponse) GetRawResponse() *http.Response

func (*AuthenticateResponse) GetStatusCode 

func (o *AuthenticateResponse) GetStatusCode() int

type AuthenticateResponseBody added in v0.7.2 

type AuthenticateResponseBody struct {
	Authenticated bool  `json:"authenticated"`
	AgentID       int64 `json:"agent_id"`
}

AuthenticateResponseBody - successful

func (*AuthenticateResponseBody) GetAgentID added in v0.7.2 

func (o *AuthenticateResponseBody) GetAgentID() int64

func (*AuthenticateResponseBody) GetAuthenticated added in v0.7.2 

func (o *AuthenticateResponseBody) GetAuthenticated() bool

type CheckForCrackerUpdateRequest 

type CheckForCrackerUpdateRequest struct {
	// operating_system
	OperatingSystem *string `queryParam:"style=form,explode=true,name=operating_system"`
	// version
	Version *string `queryParam:"style=form,explode=true,name=version"`
}

func (*CheckForCrackerUpdateRequest) GetOperatingSystem 

func (o *CheckForCrackerUpdateRequest) GetOperatingSystem() *string

func (*CheckForCrackerUpdateRequest) GetVersion 

func (o *CheckForCrackerUpdateRequest) GetVersion() *string

type CheckForCrackerUpdateResponse 

type CheckForCrackerUpdateResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// operating system not found
	CrackerUpdate *components.CrackerUpdate
}

func (*CheckForCrackerUpdateResponse) GetContentType 

func (o *CheckForCrackerUpdateResponse) GetContentType() string

func (*CheckForCrackerUpdateResponse) GetCrackerUpdate 

func (o *CheckForCrackerUpdateResponse) GetCrackerUpdate() *components.CrackerUpdate

func (*CheckForCrackerUpdateResponse) GetRawResponse 

func (o *CheckForCrackerUpdateResponse) GetRawResponse() *http.Response

func (*CheckForCrackerUpdateResponse) GetStatusCode 

func (o *CheckForCrackerUpdateResponse) GetStatusCode() int

type GetAgentRequest added in v0.2.0 

type GetAgentRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*GetAgentRequest) GetID added in v0.2.0 

func (o *GetAgentRequest) GetID() int64

type GetAgentResponse added in v0.2.0 

type GetAgentResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Agent *components.Agent
}

func (*GetAgentResponse) GetAgent added in v0.2.0 

func (o *GetAgentResponse) GetAgent() *components.Agent

func (*GetAgentResponse) GetContentType added in v0.2.0 

func (o *GetAgentResponse) GetContentType() string

func (*GetAgentResponse) GetRawResponse added in v0.2.0 

func (o *GetAgentResponse) GetRawResponse() *http.Response

func (*GetAgentResponse) GetStatusCode added in v0.2.0 

func (o *GetAgentResponse) GetStatusCode() int

type GetAttackRequest added in v0.2.0 

type GetAttackRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*GetAttackRequest) GetID added in v0.2.0 

func (o *GetAttackRequest) GetID() int64

type GetAttackResponse added in v0.2.0 

type GetAttackResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Attack *components.Attack
}

func (*GetAttackResponse) GetAttack added in v0.2.0 

func (o *GetAttackResponse) GetAttack() *components.Attack

func (*GetAttackResponse) GetContentType added in v0.2.0 

func (o *GetAttackResponse) GetContentType() string

func (*GetAttackResponse) GetRawResponse added in v0.2.0 

func (o *GetAttackResponse) GetRawResponse() *http.Response

func (*GetAttackResponse) GetStatusCode added in v0.2.0 

func (o *GetAttackResponse) GetStatusCode() int

type GetConfigurationResponse added in v0.2.0 

type GetConfigurationResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Object *GetConfigurationResponseBody
}

func (*GetConfigurationResponse) GetContentType added in v0.2.0 

func (o *GetConfigurationResponse) GetContentType() string

func (*GetConfigurationResponse) GetObject added in v0.7.2 

func (o *GetConfigurationResponse) GetObject() *GetConfigurationResponseBody

func (*GetConfigurationResponse) GetRawResponse added in v0.2.0 

func (o *GetConfigurationResponse) GetRawResponse() *http.Response

func (*GetConfigurationResponse) GetStatusCode added in v0.2.0 

func (o *GetConfigurationResponse) GetStatusCode() int

type GetConfigurationResponseBody added in v0.7.2 

type GetConfigurationResponseBody struct {
	Config components.AdvancedAgentConfiguration `json:"config"`
	// The minimum accepted version of the API
	APIVersion int64 `json:"api_version"`
}

GetConfigurationResponseBody - successful

func (*GetConfigurationResponseBody) GetAPIVersion added in v0.7.2 

func (o *GetConfigurationResponseBody) GetAPIVersion() int64

func (*GetConfigurationResponseBody) GetConfig added in v0.7.2 

func (o *GetConfigurationResponseBody) GetConfig() components.AdvancedAgentConfiguration

type GetHashListRequest added in v0.2.0 

type GetHashListRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*GetHashListRequest) GetID added in v0.2.0 

func (o *GetHashListRequest) GetID() int64

type GetHashListResponse added in v0.2.0 

type GetHashListResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	// The Close method must be called on this field, even if it is not used, to prevent resource leaks.
	ResponseStream io.ReadCloser
}

func (*GetHashListResponse) GetContentType added in v0.2.0 

func (o *GetHashListResponse) GetContentType() string

func (*GetHashListResponse) GetRawResponse added in v0.2.0 

func (o *GetHashListResponse) GetRawResponse() *http.Response

func (*GetHashListResponse) GetResponseStream added in v0.4.4 

func (o *GetHashListResponse) GetResponseStream() io.ReadCloser

func (*GetHashListResponse) GetStatusCode added in v0.2.0 

func (o *GetHashListResponse) GetStatusCode() int

type GetNewTaskResponse added in v0.2.0 

type GetNewTaskResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// new task available
	Task *components.Task
}

func (*GetNewTaskResponse) GetContentType added in v0.2.0 

func (o *GetNewTaskResponse) GetContentType() string

func (*GetNewTaskResponse) GetRawResponse added in v0.2.0 

func (o *GetNewTaskResponse) GetRawResponse() *http.Response

func (*GetNewTaskResponse) GetStatusCode added in v0.2.0 

func (o *GetNewTaskResponse) GetStatusCode() int

func (*GetNewTaskResponse) GetTask added in v0.2.0 

func (o *GetNewTaskResponse) GetTask() *components.Task

type GetTaskRequest added in v0.2.0 

type GetTaskRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*GetTaskRequest) GetID added in v0.2.0 

func (o *GetTaskRequest) GetID() int64

type GetTaskResponse added in v0.2.0 

type GetTaskResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Task *components.Task
}

func (*GetTaskResponse) GetContentType added in v0.2.0 

func (o *GetTaskResponse) GetContentType() string

func (*GetTaskResponse) GetRawResponse added in v0.2.0 

func (o *GetTaskResponse) GetRawResponse() *http.Response

func (*GetTaskResponse) GetStatusCode added in v0.2.0 

func (o *GetTaskResponse) GetStatusCode() int

func (*GetTaskResponse) GetTask added in v0.2.0 

func (o *GetTaskResponse) GetTask() *components.Task

type GetTaskZapsRequest added in v0.7.0 

type GetTaskZapsRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*GetTaskZapsRequest) GetID added in v0.7.0 

func (o *GetTaskZapsRequest) GetID() int64

type GetTaskZapsResponse added in v0.7.0 

type GetTaskZapsResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	// The Close method must be called on this field, even if it is not used, to prevent resource leaks.
	ResponseStream io.ReadCloser
}

func (*GetTaskZapsResponse) GetContentType added in v0.7.0 

func (o *GetTaskZapsResponse) GetContentType() string

func (*GetTaskZapsResponse) GetRawResponse added in v0.7.0 

func (o *GetTaskZapsResponse) GetRawResponse() *http.Response

func (*GetTaskZapsResponse) GetResponseStream added in v0.7.0 

func (o *GetTaskZapsResponse) GetResponseStream() io.ReadCloser

func (*GetTaskZapsResponse) GetStatusCode added in v0.7.0 

func (o *GetTaskZapsResponse) GetStatusCode() int

type Metadata added in v0.7.2 

type Metadata struct {
	// The date of the error
	ErrorDate time.Time `json:"error_date"`
	// Other metadata
	Other map[string]any `json:"other,omitempty"`
}

Metadata - Additional metadata about the error

func (*Metadata) GetErrorDate added in v0.7.2 

func (o *Metadata) GetErrorDate() time.Time

func (*Metadata) GetOther added in v0.7.2 

func (o *Metadata) GetOther() map[string]any

func (Metadata) MarshalJSON added in v0.7.2 

func (m Metadata) MarshalJSON() ([]byte, error)

func (*Metadata) UnmarshalJSON added in v0.7.2 

func (m *Metadata) UnmarshalJSON(data []byte) error

type Option 

type Option func(*Options, ...string) error

func WithAcceptHeaderOverride 

func WithAcceptHeaderOverride(acceptHeaderOverride AcceptHeaderEnum) Option

func WithOperationTimeout added in v0.6.0 

func WithOperationTimeout(timeout time.Duration) Option

WithOperationTimeout allows setting the request timeout applied for an operation.

func WithRetries 

func WithRetries(config retry.Config) Option

WithRetries allows customizing the default retry configuration.

func WithServerURL 

func WithServerURL(serverURL string) Option

WithServerURL allows providing an alternative server URL.

func WithTemplatedServerURL 

func WithTemplatedServerURL(serverURL string, params map[string]string) Option

WithTemplatedServerURL allows providing an alternative server URL with templated parameters.

func WithURLOverride added in v0.7.0 

func WithURLOverride(urlOverride string) Option

WithURLOverride allows overriding the URL.

type Options 

type Options struct {
	ServerURL            *string
	Retries              *retry.Config
	Timeout              *time.Duration
	AcceptHeaderOverride *AcceptHeaderEnum
	URLOverride          *string
}

type SendCrackRequest added in v0.2.0 

type SendCrackRequest struct {
	// id
	ID            int64                     `pathParam:"style=simple,explode=false,name=id"`
	HashcatResult *components.HashcatResult `request:"mediaType=application/json"`
}

func (*SendCrackRequest) GetHashcatResult added in v0.2.0 

func (o *SendCrackRequest) GetHashcatResult() *components.HashcatResult

func (*SendCrackRequest) GetID added in v0.2.0 

func (o *SendCrackRequest) GetID() int64

type SendCrackResponse added in v0.2.0 

type SendCrackResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SendCrackResponse) GetContentType added in v0.2.0 

func (o *SendCrackResponse) GetContentType() string

func (*SendCrackResponse) GetRawResponse added in v0.2.0 

func (o *SendCrackResponse) GetRawResponse() *http.Response

func (*SendCrackResponse) GetStatusCode added in v0.2.0 

func (o *SendCrackResponse) GetStatusCode() int

type SendHeartbeatRequest added in v0.2.0 

type SendHeartbeatRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*SendHeartbeatRequest) GetID added in v0.2.0 

func (o *SendHeartbeatRequest) GetID() int64

type SendHeartbeatResponse added in v0.2.0 

type SendHeartbeatResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful, but with server feedback
	Object *SendHeartbeatResponseBody
}

func (*SendHeartbeatResponse) GetContentType added in v0.2.0 

func (o *SendHeartbeatResponse) GetContentType() string

func (*SendHeartbeatResponse) GetObject added in v0.7.2 

func (o *SendHeartbeatResponse) GetObject() *SendHeartbeatResponseBody

func (*SendHeartbeatResponse) GetRawResponse added in v0.2.0 

func (o *SendHeartbeatResponse) GetRawResponse() *http.Response

func (*SendHeartbeatResponse) GetStatusCode added in v0.2.0 

func (o *SendHeartbeatResponse) GetStatusCode() int

type SendHeartbeatResponseBody added in v0.7.2 

type SendHeartbeatResponseBody struct {
	// The state of the agent:
	//                        * `pending` - The agent needs to perform the setup process again.
	//                        * `active` - The agent is ready to accept tasks, all is good.
	//                        * `error` - The agent has encountered an error and needs to be checked.
	//                        * `stopped` - The agent has been stopped by the user.
	State State `json:"state"`
}

SendHeartbeatResponseBody - The response to an agent heartbeat

func (*SendHeartbeatResponseBody) GetState added in v0.7.2 

func (o *SendHeartbeatResponseBody) GetState() State

type SendStatusRequest added in v0.2.0 

type SendStatusRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
	// status
	TaskStatus components.TaskStatus `request:"mediaType=application/json"`
}

func (*SendStatusRequest) GetID added in v0.2.0 

func (o *SendStatusRequest) GetID() int64

func (*SendStatusRequest) GetTaskStatus added in v0.2.0 

func (o *SendStatusRequest) GetTaskStatus() components.TaskStatus

type SendStatusResponse added in v0.2.0 

type SendStatusResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SendStatusResponse) GetContentType added in v0.2.0 

func (o *SendStatusResponse) GetContentType() string

func (*SendStatusResponse) GetRawResponse added in v0.2.0 

func (o *SendStatusResponse) GetRawResponse() *http.Response

func (*SendStatusResponse) GetStatusCode added in v0.2.0 

func (o *SendStatusResponse) GetStatusCode() int

type SetAgentShutdownRequest added in v0.4.0 

type SetAgentShutdownRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*SetAgentShutdownRequest) GetID added in v0.4.0 

func (o *SetAgentShutdownRequest) GetID() int64

type SetAgentShutdownResponse added in v0.4.0 

type SetAgentShutdownResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SetAgentShutdownResponse) GetContentType added in v0.4.0 

func (o *SetAgentShutdownResponse) GetContentType() string

func (*SetAgentShutdownResponse) GetRawResponse added in v0.4.0 

func (o *SetAgentShutdownResponse) GetRawResponse() *http.Response

func (*SetAgentShutdownResponse) GetStatusCode added in v0.4.0 

func (o *SetAgentShutdownResponse) GetStatusCode() int

type SetTaskAbandonedRequest added in v0.2.0 

type SetTaskAbandonedRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*SetTaskAbandonedRequest) GetID added in v0.2.0 

func (o *SetTaskAbandonedRequest) GetID() int64

type SetTaskAbandonedResponse added in v0.2.0 

type SetTaskAbandonedResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SetTaskAbandonedResponse) GetContentType added in v0.2.0 

func (o *SetTaskAbandonedResponse) GetContentType() string

func (*SetTaskAbandonedResponse) GetRawResponse added in v0.2.0 

func (o *SetTaskAbandonedResponse) GetRawResponse() *http.Response

func (*SetTaskAbandonedResponse) GetStatusCode added in v0.2.0 

func (o *SetTaskAbandonedResponse) GetStatusCode() int

type SetTaskAcceptedRequest added in v0.2.0 

type SetTaskAcceptedRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*SetTaskAcceptedRequest) GetID added in v0.2.0 

func (o *SetTaskAcceptedRequest) GetID() int64

type SetTaskAcceptedResponse added in v0.2.0 

type SetTaskAcceptedResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SetTaskAcceptedResponse) GetContentType added in v0.2.0 

func (o *SetTaskAcceptedResponse) GetContentType() string

func (*SetTaskAcceptedResponse) GetRawResponse added in v0.2.0 

func (o *SetTaskAcceptedResponse) GetRawResponse() *http.Response

func (*SetTaskAcceptedResponse) GetStatusCode added in v0.2.0 

func (o *SetTaskAcceptedResponse) GetStatusCode() int

type SetTaskExhaustedRequest added in v0.2.0 

type SetTaskExhaustedRequest struct {
	// id
	ID int64 `pathParam:"style=simple,explode=false,name=id"`
}

func (*SetTaskExhaustedRequest) GetID added in v0.2.0 

func (o *SetTaskExhaustedRequest) GetID() int64

type SetTaskExhaustedResponse added in v0.2.0 

type SetTaskExhaustedResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SetTaskExhaustedResponse) GetContentType added in v0.2.0 

func (o *SetTaskExhaustedResponse) GetContentType() string

func (*SetTaskExhaustedResponse) GetRawResponse added in v0.2.0 

func (o *SetTaskExhaustedResponse) GetRawResponse() *http.Response

func (*SetTaskExhaustedResponse) GetStatusCode added in v0.2.0 

func (o *SetTaskExhaustedResponse) GetStatusCode() int

type Severity added in v0.7.2 

type Severity string

Severity - The severity of the error:

  • `info` - Informational message, no action required.
  • `warning` - Non-critical error, no action required. Anticipated, but not necessarily problematic.
  • `minor` - Minor error, no action required. Should be investigated, but the task can continue.
  • `major` - Major error, action required. The task should be investigated and possibly restarted.
  • `critical` - Critical error, action required. The task should be stopped and investigated.
  • `fatal` - Fatal error, action required. The agent cannot continue with the task and should not be reattempted.
const (
	SeverityInfo     Severity = "info"
	SeverityWarning  Severity = "warning"
	SeverityMinor    Severity = "minor"
	SeverityMajor    Severity = "major"
	SeverityCritical Severity = "critical"
	SeverityFatal    Severity = "fatal"
)

func (Severity) ToPointer added in v0.7.2 

func (e Severity) ToPointer() *Severity

func (*Severity) UnmarshalJSON added in v0.7.2 

func (e *Severity) UnmarshalJSON(data []byte) error

type State added in v0.7.2 

type State string

State - The state of the agent:

  • `pending` - The agent needs to perform the setup process again.
  • `active` - The agent is ready to accept tasks, all is good.
  • `error` - The agent has encountered an error and needs to be checked.
  • `stopped` - The agent has been stopped by the user.
const (
	StatePending State = "pending"
	StateStopped State = "stopped"
	StateError   State = "error"
)

func (State) ToPointer added in v0.7.2 

func (e State) ToPointer() *State

func (*State) UnmarshalJSON added in v0.7.2 

func (e *State) UnmarshalJSON(data []byte) error

type SubmitBenchmarkRequest added in v0.2.0 

type SubmitBenchmarkRequest struct {
	// id
	ID          int64                      `pathParam:"style=simple,explode=false,name=id"`
	RequestBody SubmitBenchmarkRequestBody `request:"mediaType=application/json"`
}

func (*SubmitBenchmarkRequest) GetID added in v0.2.0 

func (o *SubmitBenchmarkRequest) GetID() int64

func (*SubmitBenchmarkRequest) GetRequestBody added in v0.2.0 

func (o *SubmitBenchmarkRequest) GetRequestBody() SubmitBenchmarkRequestBody

type SubmitBenchmarkRequestBody added in v0.7.2 

type SubmitBenchmarkRequestBody struct {
	HashcatBenchmarks []components.HashcatBenchmark `json:"hashcat_benchmarks"`
}

func (*SubmitBenchmarkRequestBody) GetHashcatBenchmarks added in v0.7.2 

func (o *SubmitBenchmarkRequestBody) GetHashcatBenchmarks() []components.HashcatBenchmark

type SubmitBenchmarkResponse added in v0.2.0 

type SubmitBenchmarkResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SubmitBenchmarkResponse) GetContentType added in v0.2.0 

func (o *SubmitBenchmarkResponse) GetContentType() string

func (*SubmitBenchmarkResponse) GetRawResponse added in v0.2.0 

func (o *SubmitBenchmarkResponse) GetRawResponse() *http.Response

func (*SubmitBenchmarkResponse) GetStatusCode added in v0.2.0 

func (o *SubmitBenchmarkResponse) GetStatusCode() int

type SubmitErrorAgentRequest added in v0.2.2 

type SubmitErrorAgentRequest struct {
	// id
	ID          int64                        `pathParam:"style=simple,explode=false,name=id"`
	RequestBody *SubmitErrorAgentRequestBody `request:"mediaType=application/json"`
}

func (*SubmitErrorAgentRequest) GetID added in v0.2.2 

func (o *SubmitErrorAgentRequest) GetID() int64

func (*SubmitErrorAgentRequest) GetRequestBody added in v0.7.2 

func (o *SubmitErrorAgentRequest) GetRequestBody() *SubmitErrorAgentRequestBody

type SubmitErrorAgentRequestBody added in v0.7.2 

type SubmitErrorAgentRequestBody struct {
	// The error message
	Message string `json:"message"`
	// Additional metadata about the error
	Metadata *Metadata `json:"metadata,omitempty"`
	// The severity of the error:
	//                        * `info` - Informational message, no action required.
	//                        * `warning` - Non-critical error, no action required. Anticipated, but not necessarily problematic.
	//                        * `minor` - Minor error, no action required. Should be investigated, but the task can continue.
	//                        * `major` - Major error, action required. The task should be investigated and possibly restarted.
	//                        * `critical` - Critical error, action required. The task should be stopped and investigated.
	//                         * `fatal` - Fatal error, action required. The agent cannot continue with the task and should not be reattempted.
	Severity Severity `json:"severity"`
	// The agent that caused the error
	AgentID int64 `json:"agent_id"`
	// The task that caused the error, if any
	TaskID *int64 `json:"task_id,omitempty"`
}

func (*SubmitErrorAgentRequestBody) GetAgentID added in v0.7.2 

func (o *SubmitErrorAgentRequestBody) GetAgentID() int64

func (*SubmitErrorAgentRequestBody) GetMessage added in v0.7.2 

func (o *SubmitErrorAgentRequestBody) GetMessage() string

func (*SubmitErrorAgentRequestBody) GetMetadata added in v0.7.2 

func (o *SubmitErrorAgentRequestBody) GetMetadata() *Metadata

func (*SubmitErrorAgentRequestBody) GetSeverity added in v0.7.2 

func (o *SubmitErrorAgentRequestBody) GetSeverity() Severity

func (*SubmitErrorAgentRequestBody) GetTaskID added in v0.7.2 

func (o *SubmitErrorAgentRequestBody) GetTaskID() *int64

type SubmitErrorAgentResponse added in v0.2.2 

type SubmitErrorAgentResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
}

func (*SubmitErrorAgentResponse) GetContentType added in v0.2.2 

func (o *SubmitErrorAgentResponse) GetContentType() string

func (*SubmitErrorAgentResponse) GetRawResponse added in v0.2.2 

func (o *SubmitErrorAgentResponse) GetRawResponse() *http.Response

func (*SubmitErrorAgentResponse) GetStatusCode added in v0.2.2 

func (o *SubmitErrorAgentResponse) GetStatusCode() int

type UpdateAgentRequest 

type UpdateAgentRequest struct {
	// id
	ID          int64                   `pathParam:"style=simple,explode=false,name=id"`
	RequestBody *UpdateAgentRequestBody `request:"mediaType=application/json"`
}

func (*UpdateAgentRequest) GetID 

func (o *UpdateAgentRequest) GetID() int64

func (*UpdateAgentRequest) GetRequestBody added in v0.7.2 

func (o *UpdateAgentRequest) GetRequestBody() *UpdateAgentRequestBody

type UpdateAgentRequestBody added in v0.7.2 

type UpdateAgentRequestBody struct {
	// The id of the agent
	ID int64 `json:"id"`
	// The hostname of the agent
	HostName string `json:"host_name"`
	// The signature of the client
	ClientSignature string `json:"client_signature"`
	// The operating system of the agent
	OperatingSystem string   `json:"operating_system"`
	Devices         []string `json:"devices"`
}

func (*UpdateAgentRequestBody) GetClientSignature added in v0.7.2 

func (o *UpdateAgentRequestBody) GetClientSignature() string

func (*UpdateAgentRequestBody) GetDevices added in v0.7.2 

func (o *UpdateAgentRequestBody) GetDevices() []string

func (*UpdateAgentRequestBody) GetHostName added in v0.8.5 

func (o *UpdateAgentRequestBody) GetHostName() string

func (*UpdateAgentRequestBody) GetID added in v0.7.2 

func (o *UpdateAgentRequestBody) GetID() int64

func (*UpdateAgentRequestBody) GetOperatingSystem added in v0.7.2 

func (o *UpdateAgentRequestBody) GetOperatingSystem() string

type UpdateAgentResponse 

type UpdateAgentResponse struct {
	// HTTP response content type for this operation
	ContentType string
	// HTTP response status code for this operation
	StatusCode int
	// Raw HTTP response; suitable for custom response parsing
	RawResponse *http.Response
	// successful
	Agent *components.Agent
}

func (*UpdateAgentResponse) GetAgent 

func (o *UpdateAgentResponse) GetAgent() *components.Agent

func (*UpdateAgentResponse) GetContentType 

func (o *UpdateAgentResponse) GetContentType() string

func (*UpdateAgentResponse) GetRawResponse 

func (o *UpdateAgentResponse) GetRawResponse() *http.Response

func (*UpdateAgentResponse) GetStatusCode 

func (o *UpdateAgentResponse) GetStatusCode() int

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.