client

package
v1.1.17 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2024 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildGetFindingMTTRPayload 

func BuildGetFindingMTTRPayload(findingsGetFindingMTTRID string) (*findings.GetFindingMTTRPayload, error)

BuildGetFindingMTTRPayload builds the payload for the findings Get finding MTTR endpoint from CLI flags.

func BuildGetFindingPayload 

func BuildGetFindingPayload(findingsGetFindingID string) (*findings.GetFindingPayload, error)

BuildGetFindingPayload builds the payload for the findings Get finding endpoint from CLI flags.

func BuildListEventsByFindingPayload 

func BuildListEventsByFindingPayload(findingsListEventsByFindingID string, findingsListEventsByFindingPage string, findingsListEventsByFindingSize string) (*findings.ListEventsByFindingPayload, error)

BuildListEventsByFindingPayload builds the payload for the findings List events by finding endpoint from CLI flags.

func BuildListFindingsPayload 

func BuildListFindingsPayload(findingsListFindingsTeam string, findingsListFindingsTeams string, findingsListFindingsStatus string, findingsListFindingsMinScore string, findingsListFindingsMaxScore string, findingsListFindingsAtDate string, findingsListFindingsMinDate string, findingsListFindingsMaxDate string, findingsListFindingsSortBy string, findingsListFindingsPage string, findingsListFindingsSize string, findingsListFindingsIdentifier string, findingsListFindingsIdentifiermatch string, findingsListFindingsIdentifiers string, findingsListFindingsLabels string) (*findings.ListFindingsPayload, error)

BuildListFindingsPayload builds the payload for the findings List findings endpoint from CLI flags.

func BuildPatchFindingPayload 

func BuildPatchFindingPayload(findingsPatchFindingBody string, findingsPatchFindingID string, findingsPatchFindingAuthorization string) (*findings.PatchFindingPayload, error)

BuildPatchFindingPayload builds the payload for the findings Patch finding endpoint from CLI flags.

func DecodeGetFindingMTTRResponse 

func DecodeGetFindingMTTRResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetFindingMTTRResponse returns a decoder for responses returned by the findings Get finding MTTR endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeGetFindingResponse 

func DecodeGetFindingResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetFindingResponse returns a decoder for responses returned by the findings Get finding endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeListEventsByFindingResponse 

func DecodeListEventsByFindingResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListEventsByFindingResponse returns a decoder for responses returned by the findings List events by finding endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodeListFindingsResponse 

func DecodeListFindingsResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListFindingsResponse returns a decoder for responses returned by the findings List findings endpoint. restoreBody controls whether the response body should be restored after having been read.

func DecodePatchFindingResponse 

func DecodePatchFindingResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodePatchFindingResponse returns a decoder for responses returned by the findings Patch finding endpoint. restoreBody controls whether the response body should be restored after having been read.

func EncodeListEventsByFindingRequest 

func EncodeListEventsByFindingRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListEventsByFindingRequest returns an encoder for requests sent to the findings List events by finding server.

func EncodeListFindingsRequest 

func EncodeListFindingsRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListFindingsRequest returns an encoder for requests sent to the findings List findings server.

func EncodePatchFindingRequest 

func EncodePatchFindingRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodePatchFindingRequest returns an encoder for requests sent to the findings Patch finding server.

func GetFindingFindingsPath 

func GetFindingFindingsPath(id string) string

GetFindingFindingsPath returns the URL path to the findings service Get finding HTTP endpoint.

func GetFindingMTTRFindingsPath 

func GetFindingMTTRFindingsPath(id string) string

GetFindingMTTRFindingsPath returns the URL path to the findings service Get finding MTTR HTTP endpoint.

func ListEventsByFindingFindingsPath 

func ListEventsByFindingFindingsPath(id string) string

ListEventsByFindingFindingsPath returns the URL path to the findings service List events by finding HTTP endpoint.

func ListFindingsFindingsPath 

func ListFindingsFindingsPath() string

ListFindingsFindingsPath returns the URL path to the findings service List findings HTTP endpoint.

func NewGetFindingFindingOK 

func NewGetFindingFindingOK(body *GetFindingResponseBody) *findingsviews.FindingView

NewGetFindingFindingOK builds a "findings" service "Get finding" endpoint result from a HTTP "OK" response.

func NewGetFindingMTTRMttrOK 

func NewGetFindingMTTRMttrOK(body *GetFindingMTTRResponseBody) *findingsviews.MttrView

NewGetFindingMTTRMttrOK builds a "findings" service "Get finding MTTR" endpoint result from a HTTP "OK" response.

func NewListEventsByFindingEventCollectionOK 

func NewListEventsByFindingEventCollectionOK(body ListEventsByFindingResponseBody) findingsviews.EventCollectionView

NewListEventsByFindingEventCollectionOK builds a "findings" service "List events by finding" endpoint result from a HTTP "OK" response.

func NewListFindingsFindingCollectionOK 

func NewListFindingsFindingCollectionOK(body ListFindingsResponseBody) findingsviews.FindingCollectionView

NewListFindingsFindingCollectionOK builds a "findings" service "List findings" endpoint result from a HTTP "OK" response.

func NewPatchFindingFindingOK 

func NewPatchFindingFindingOK(body *PatchFindingResponseBody) *findingsviews.FindingView

NewPatchFindingFindingOK builds a "findings" service "Patch finding" endpoint result from a HTTP "OK" response.

func PatchFindingFindingsPath 

func PatchFindingFindingsPath(id string) string

PatchFindingFindingsPath returns the URL path to the findings service Patch finding HTTP endpoint.

Types

type Client 

type Client struct {
	// ListFindings Doer is the HTTP client used to make requests to the List
	// findings endpoint.
	ListFindingsDoer goahttp.Doer

	// GetFinding Doer is the HTTP client used to make requests to the Get finding
	// endpoint.
	GetFindingDoer goahttp.Doer

	// ListEventsByFinding Doer is the HTTP client used to make requests to the
	// List events by finding endpoint.
	ListEventsByFindingDoer goahttp.Doer

	// GetFindingMTTR Doer is the HTTP client used to make requests to the Get
	// finding MTTR endpoint.
	GetFindingMTTRDoer goahttp.Doer

	// PatchFinding Doer is the HTTP client used to make requests to the Patch
	// finding endpoint.
	PatchFindingDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the findings service endpoint HTTP clients.

func NewClient 

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the findings service servers.

func (*Client) BuildGetFindingMTTRRequest 

func (c *Client) BuildGetFindingMTTRRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetFindingMTTRRequest instantiates a HTTP request object with method and path set to call the "findings" service "Get finding MTTR" endpoint

func (*Client) BuildGetFindingRequest 

func (c *Client) BuildGetFindingRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetFindingRequest instantiates a HTTP request object with method and path set to call the "findings" service "Get finding" endpoint

func (*Client) BuildListEventsByFindingRequest 

func (c *Client) BuildListEventsByFindingRequest(ctx context.Context, v any) (*http.Request, error)

BuildListEventsByFindingRequest instantiates a HTTP request object with method and path set to call the "findings" service "List events by finding" endpoint

func (*Client) BuildListFindingsRequest 

func (c *Client) BuildListFindingsRequest(ctx context.Context, v any) (*http.Request, error)

BuildListFindingsRequest instantiates a HTTP request object with method and path set to call the "findings" service "List findings" endpoint

func (*Client) BuildPatchFindingRequest 

func (c *Client) BuildPatchFindingRequest(ctx context.Context, v any) (*http.Request, error)

BuildPatchFindingRequest instantiates a HTTP request object with method and path set to call the "findings" service "Patch finding" endpoint

func (*Client) GetFinding 

func (c *Client) GetFinding() goa.Endpoint

GetFinding returns an endpoint that makes HTTP requests to the findings service Get finding server.

func (*Client) GetFindingMTTR 

func (c *Client) GetFindingMTTR() goa.Endpoint

GetFindingMTTR returns an endpoint that makes HTTP requests to the findings service Get finding MTTR server.

func (*Client) ListEventsByFinding 

func (c *Client) ListEventsByFinding() goa.Endpoint

ListEventsByFinding returns an endpoint that makes HTTP requests to the findings service List events by finding server.

func (*Client) ListFindings 

func (c *Client) ListFindings() goa.Endpoint

ListFindings returns an endpoint that makes HTTP requests to the findings service List findings server.

func (*Client) PatchFinding 

func (c *Client) PatchFinding() goa.Endpoint

PatchFinding returns an endpoint that makes HTTP requests to the findings service Patch finding server.

type EventResponse 

type EventResponse struct {
	// Finding event ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Finding ID
	FindingID *string `form:"finding_id,omitempty" json:"finding_id,omitempty" xml:"finding_id,omitempty"`
	// Source ID
	SourceID *string `form:"source_id,omitempty" json:"source_id,omitempty" xml:"source_id,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Event time
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

EventResponse is used to define fields on response body types.

type FindingResponse 

type FindingResponse struct {
	// Finding ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue
	Issue *IssueResponse `form:"issue,omitempty" json:"issue,omitempty" xml:"issue,omitempty"`
	// Target
	Target *TargetResponse `form:"target,omitempty" json:"target,omitempty" xml:"target,omitempty"`
	// Source
	Source *SourcewithnotargetResponse `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"`
	// Finding details
	Details *string `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
	// Finding impact details
	ImpactDetails *string `form:"impact_details,omitempty" json:"impact_details,omitempty" xml:"impact_details,omitempty"`
	// Finding status. Can be 'OPEN' or 'FIXED'.
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Other resources associated with the finding
	Resources []*ResourceGroupResponse `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

FindingResponse is used to define fields on response body types.

type GetFindingMTTRResponseBody 

type GetFindingMTTRResponseBody struct {
	Mttr *int `form:"mttr,omitempty" json:"mttr,omitempty" xml:"mttr,omitempty"`
}

GetFindingMTTRResponseBody is the type of the "findings" service "Get finding MTTR" endpoint HTTP response body.

type GetFindingResponseBody 

type GetFindingResponseBody struct {
	// Finding ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue
	Issue *IssueResponseBody `form:"issue,omitempty" json:"issue,omitempty" xml:"issue,omitempty"`
	// Target
	Target *TargetResponseBody `form:"target,omitempty" json:"target,omitempty" xml:"target,omitempty"`
	// Source
	Source *SourcewithnotargetResponseBody `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"`
	// Finding details
	Details *string `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
	// Finding impact details
	ImpactDetails *string `form:"impact_details,omitempty" json:"impact_details,omitempty" xml:"impact_details,omitempty"`
	// Finding status. Can be 'OPEN' or 'FIXED'.
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Other resources associated with the finding
	Resources []*ResourceGroupResponseBody `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

GetFindingResponseBody is the type of the "findings" service "Get finding" endpoint HTTP response body.

type IssueResponse 

type IssueResponse struct {
	// Issue ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue summary
	Summary *string `form:"summary,omitempty" json:"summary,omitempty" xml:"summary,omitempty"`
	// Common Weakness Enumeration ID
	CweID *int `form:"cwe_id,omitempty" json:"cwe_id,omitempty" xml:"cwe_id,omitempty"`
	// Issue description
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Recommendations to fix the issue
	Recommendations []string `form:"recommendations,omitempty" json:"recommendations,omitempty" xml:"recommendations,omitempty"`
	// Documentation reference for the issue
	ReferenceLinks []string `form:"reference_links,omitempty" json:"reference_links,omitempty" xml:"reference_links,omitempty"`
	// Labels associated with the issue
	Labels []string `form:"labels,omitempty" json:"labels,omitempty" xml:"labels,omitempty"`
}

IssueResponse is used to define fields on response body types.

type IssueResponseBody 

type IssueResponseBody struct {
	// Issue ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue summary
	Summary *string `form:"summary,omitempty" json:"summary,omitempty" xml:"summary,omitempty"`
	// Common Weakness Enumeration ID
	CweID *int `form:"cwe_id,omitempty" json:"cwe_id,omitempty" xml:"cwe_id,omitempty"`
	// Issue description
	Description *string `form:"description,omitempty" json:"description,omitempty" xml:"description,omitempty"`
	// Recommendations to fix the issue
	Recommendations []string `form:"recommendations,omitempty" json:"recommendations,omitempty" xml:"recommendations,omitempty"`
	// Documentation reference for the issue
	ReferenceLinks []string `form:"reference_links,omitempty" json:"reference_links,omitempty" xml:"reference_links,omitempty"`
	// Labels associated with the issue
	Labels []string `form:"labels,omitempty" json:"labels,omitempty" xml:"labels,omitempty"`
}

IssueResponseBody is used to define fields on response body types.

type ListEventsByFindingResponseBody 

type ListEventsByFindingResponseBody []*EventResponse

ListEventsByFindingResponseBody is the type of the "findings" service "List events by finding" endpoint HTTP response body.

type ListFindingsResponseBody 

type ListFindingsResponseBody []*FindingResponse

ListFindingsResponseBody is the type of the "findings" service "List findings" endpoint HTTP response body.

type PatchFindingRequestBody 

type PatchFindingRequestBody struct {
	// Status
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
}

PatchFindingRequestBody is the type of the "findings" service "Patch finding" endpoint HTTP request body.

func NewPatchFindingRequestBody 

func NewPatchFindingRequestBody(p *findings.PatchFindingPayload) *PatchFindingRequestBody

NewPatchFindingRequestBody builds the HTTP request body from the payload of the "Patch finding" endpoint of the "findings" service.

type PatchFindingResponseBody 

type PatchFindingResponseBody struct {
	// Finding ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Issue
	Issue *IssueResponseBody `form:"issue,omitempty" json:"issue,omitempty" xml:"issue,omitempty"`
	// Target
	Target *TargetResponseBody `form:"target,omitempty" json:"target,omitempty" xml:"target,omitempty"`
	// Source
	Source *SourcewithnotargetResponseBody `form:"source,omitempty" json:"source,omitempty" xml:"source,omitempty"`
	// Finding details
	Details *string `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
	// Finding impact details
	ImpactDetails *string `form:"impact_details,omitempty" json:"impact_details,omitempty" xml:"impact_details,omitempty"`
	// Finding status. Can be 'OPEN' or 'FIXED'.
	Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Other resources associated with the finding
	Resources []*ResourceGroupResponseBody `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

PatchFindingResponseBody is the type of the "findings" service "Patch finding" endpoint HTTP response body.

type ResourceGroupResponse 

type ResourceGroupResponse struct {
	// Name of the resource group
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Column names of the resource group in the order that should be rendered
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// List containing the resource rows as hashmap
	Resources []map[string]string `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

ResourceGroupResponse is used to define fields on response body types.

type ResourceGroupResponseBody 

type ResourceGroupResponseBody struct {
	// Name of the resource group
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Column names of the resource group in the order that should be rendered
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// List containing the resource rows as hashmap
	Resources []map[string]string `form:"resources,omitempty" json:"resources,omitempty" xml:"resources,omitempty"`
}

ResourceGroupResponseBody is used to define fields on response body types.

type SourcewithnotargetResponse 

type SourcewithnotargetResponse struct {
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" xml:"component,omitempty"`
	// Source instance
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" xml:"instance,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	// Time on which the source scanned the target
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

SourcewithnotargetResponse is used to define fields on response body types.

type SourcewithnotargetResponseBody 

type SourcewithnotargetResponseBody struct {
	// Source ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Source name
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// Source component
	Component *string `form:"component,omitempty" json:"component,omitempty" xml:"component,omitempty"`
	// Source instance
	Instance *string `form:"instance,omitempty" json:"instance,omitempty" xml:"instance,omitempty"`
	// Source options
	Options *string `form:"options,omitempty" json:"options,omitempty" xml:"options,omitempty"`
	// Time on which the source scanned the target
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

SourcewithnotargetResponseBody is used to define fields on response body types.

type TargetResponse 

type TargetResponse struct {
	// Target ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Target identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" xml:"identifier,omitempty"`
	// List of teams associated with target
	Teams []string `form:"teams,omitempty" json:"teams,omitempty" xml:"teams,omitempty"`
}

TargetResponse is used to define fields on response body types.

type TargetResponseBody 

type TargetResponseBody struct {
	// Target ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Target identifier
	Identifier *string `form:"identifier,omitempty" json:"identifier,omitempty" xml:"identifier,omitempty"`
	// List of teams associated with target
	Teams []string `form:"teams,omitempty" json:"teams,omitempty" xml:"teams,omitempty"`
}

TargetResponseBody is used to define fields on response body types.

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.