v20241221

package
v1.12.0 Latest Latest
Warning

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

 Go to latest Published: Jan 23, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Overview

Package v20241221 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateTestRequestBody 

type CreateTestRequestBody struct {
	Data struct {
		Attributes struct {
			Configuration struct {
				Output *struct {
					// Label Arbitrary value up to the user
					Label       *string             `json:"label,omitempty"`
					ProjectId   *openapi_types.UUID `json:"project_id,omitempty"`
					ProjectName *string             `json:"project_name,omitempty"`

					// Report Determines if the test is stateless (false) or stateful (true)
					Report     *bool   `json:"report,omitempty"`
					TargetName *string `json:"target_name,omitempty"`

					// TargetReference A reference for the target's version - can be a git branch or a commit sha
					TargetReference *string `json:"target_reference,omitempty"`
				} `json:"output,omitempty"`
				Scan struct {
					ResultType *Scan `json:"result_type,omitempty"`
				} `json:"scan"`
			} `json:"configuration"`
			Input CreateTestRequestBody_Data_Attributes_Input `json:"input"`
		} `json:"attributes"`
		Type CreateTestRequestBodyDataType `json:"type"`
	} `json:"data"`
}

CreateTestRequestBody defines model for CreateTestRequestBody.

type CreateTestRequestBodyDataType 

type CreateTestRequestBodyDataType string

CreateTestRequestBodyDataType defines model for CreateTestRequestBody.Data.Type. 

const (
	CreateTestRequestBodyDataTypeTest CreateTestRequestBodyDataType = "test"
)

Defines values for CreateTestRequestBodyDataType.

type CreateTestRequestBody_Data_Attributes_Input 

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

CreateTestRequestBody_Data_Attributes_Input defines model for CreateTestRequestBody.Data.Attributes.Input.

func (CreateTestRequestBody_Data_Attributes_Input) AsTestInputBundle 

func (t CreateTestRequestBody_Data_Attributes_Input) AsTestInputBundle() (TestInputBundle, error)

AsTestInputBundle returns the union data inside the CreateTestRequestBody_Data_Attributes_Input as a TestInputBundle

func (CreateTestRequestBody_Data_Attributes_Input) AsTestInputLegacyScmProject 

func (t CreateTestRequestBody_Data_Attributes_Input) AsTestInputLegacyScmProject() (TestInputLegacyScmProject, error)

AsTestInputLegacyScmProject returns the union data inside the CreateTestRequestBody_Data_Attributes_Input as a TestInputLegacyScmProject

func (*CreateTestRequestBody_Data_Attributes_Input) FromTestInputBundle 

func (t *CreateTestRequestBody_Data_Attributes_Input) FromTestInputBundle(v TestInputBundle) error

FromTestInputBundle overwrites any union data inside the CreateTestRequestBody_Data_Attributes_Input as the provided TestInputBundle

func (*CreateTestRequestBody_Data_Attributes_Input) FromTestInputLegacyScmProject 

func (t *CreateTestRequestBody_Data_Attributes_Input) FromTestInputLegacyScmProject(v TestInputLegacyScmProject) error

FromTestInputLegacyScmProject overwrites any union data inside the CreateTestRequestBody_Data_Attributes_Input as the provided TestInputLegacyScmProject

func (CreateTestRequestBody_Data_Attributes_Input) MarshalJSON 

func (t CreateTestRequestBody_Data_Attributes_Input) MarshalJSON() ([]byte, error)

func (*CreateTestRequestBody_Data_Attributes_Input) MergeTestInputBundle 

func (t *CreateTestRequestBody_Data_Attributes_Input) MergeTestInputBundle(v TestInputBundle) error

MergeTestInputBundle performs a merge with any union data inside the CreateTestRequestBody_Data_Attributes_Input, using the provided TestInputBundle

func (*CreateTestRequestBody_Data_Attributes_Input) MergeTestInputLegacyScmProject 

func (t *CreateTestRequestBody_Data_Attributes_Input) MergeTestInputLegacyScmProject(v TestInputLegacyScmProject) error

MergeTestInputLegacyScmProject performs a merge with any union data inside the CreateTestRequestBody_Data_Attributes_Input, using the provided TestInputLegacyScmProject

func (*CreateTestRequestBody_Data_Attributes_Input) UnmarshalJSON 

func (t *CreateTestRequestBody_Data_Attributes_Input) UnmarshalJSON(b []byte) error

type Flow 

type Flow string

Flow defines model for Flow. 

const (
	ApiMonitor    Flow = "api_monitor"
	ApiTest       Flow = "api_test"
	CliTest       Flow = "cli_test"
	IdeDiffTest   Flow = "ide_diff_test"
	IdeTest       Flow = "ide_test"
	ManualTest    Flow = "manual_test"
	Monitor       Flow = "monitor"
	PrCheck       Flow = "pr_check"
	RecurringTest Flow = "recurring_test"
	SbomMonitor   Flow = "sbom_monitor"
	SbomTest      Flow = "sbom_test"
)

Defines values for Flow.

type PostTestRequest 

type PostTestRequest struct {
	Data struct {
		Attributes struct {
			Context *PostTestRequest_Data_Attributes_Context `json:"context,omitempty"`
			Options PostTestRequest_Data_Attributes_Options  `json:"options"`
		} `json:"attributes"`
		Type PostTestRequestDataType `json:"type"`
	} `json:"data"`
}

PostTestRequest defines model for PostTestRequest.

type PostTestRequestDataType 

type PostTestRequestDataType string

PostTestRequestDataType defines model for PostTestRequest.Data.Type. 

const (
	PostTestRequestDataTypeTest PostTestRequestDataType = "test"
)

Defines values for PostTestRequestDataType.

type PostTestRequest_Data_Attributes_Context 

type PostTestRequest_Data_Attributes_Context struct {
	Flow                 *Flow                  `json:"flow,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

PostTestRequest_Data_Attributes_Context defines model for PostTestRequest.Data.Attributes.Context.

func (PostTestRequest_Data_Attributes_Context) Get 

func (a PostTestRequest_Data_Attributes_Context) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for PostTestRequest_Data_Attributes_Context. Returns the specified element and whether it was found

func (PostTestRequest_Data_Attributes_Context) MarshalJSON 

func (a PostTestRequest_Data_Attributes_Context) MarshalJSON() ([]byte, error)

Override default JSON handling for PostTestRequest_Data_Attributes_Context to handle AdditionalProperties

func (*PostTestRequest_Data_Attributes_Context) Set 

func (a *PostTestRequest_Data_Attributes_Context) Set(fieldName string, value interface{})

Setter for additional properties for PostTestRequest_Data_Attributes_Context

func (*PostTestRequest_Data_Attributes_Context) UnmarshalJSON 

func (a *PostTestRequest_Data_Attributes_Context) UnmarshalJSON(b []byte) error

Override default JSON handling for PostTestRequest_Data_Attributes_Context to handle AdditionalProperties

type PostTestRequest_Data_Attributes_Options 

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

PostTestRequest_Data_Attributes_Options defines model for PostTestRequest.Data.Attributes.Options.

func (PostTestRequest_Data_Attributes_Options) AsTestOptionsDiff 

func (t PostTestRequest_Data_Attributes_Options) AsTestOptionsDiff() (TestOptionsDiff, error)

AsTestOptionsDiff returns the union data inside the PostTestRequest_Data_Attributes_Options as a TestOptionsDiff

func (PostTestRequest_Data_Attributes_Options) AsTestOptionsGitUrl 

func (t PostTestRequest_Data_Attributes_Options) AsTestOptionsGitUrl() (TestOptionsGitUrl, error)

AsTestOptionsGitUrl returns the union data inside the PostTestRequest_Data_Attributes_Options as a TestOptionsGitUrl

func (PostTestRequest_Data_Attributes_Options) AsTestOptionsTarget 

func (t PostTestRequest_Data_Attributes_Options) AsTestOptionsTarget() (TestOptionsTarget, error)

AsTestOptionsTarget returns the union data inside the PostTestRequest_Data_Attributes_Options as a TestOptionsTarget

func (PostTestRequest_Data_Attributes_Options) AsTestOptionsWorkspace 

func (t PostTestRequest_Data_Attributes_Options) AsTestOptionsWorkspace() (TestOptionsWorkspace, error)

AsTestOptionsWorkspace returns the union data inside the PostTestRequest_Data_Attributes_Options as a TestOptionsWorkspace

func (*PostTestRequest_Data_Attributes_Options) FromTestOptionsDiff 

func (t *PostTestRequest_Data_Attributes_Options) FromTestOptionsDiff(v TestOptionsDiff) error

FromTestOptionsDiff overwrites any union data inside the PostTestRequest_Data_Attributes_Options as the provided TestOptionsDiff

func (*PostTestRequest_Data_Attributes_Options) FromTestOptionsGitUrl 

func (t *PostTestRequest_Data_Attributes_Options) FromTestOptionsGitUrl(v TestOptionsGitUrl) error

FromTestOptionsGitUrl overwrites any union data inside the PostTestRequest_Data_Attributes_Options as the provided TestOptionsGitUrl

func (*PostTestRequest_Data_Attributes_Options) FromTestOptionsTarget 

func (t *PostTestRequest_Data_Attributes_Options) FromTestOptionsTarget(v TestOptionsTarget) error

FromTestOptionsTarget overwrites any union data inside the PostTestRequest_Data_Attributes_Options as the provided TestOptionsTarget

func (*PostTestRequest_Data_Attributes_Options) FromTestOptionsWorkspace 

func (t *PostTestRequest_Data_Attributes_Options) FromTestOptionsWorkspace(v TestOptionsWorkspace) error

FromTestOptionsWorkspace overwrites any union data inside the PostTestRequest_Data_Attributes_Options as the provided TestOptionsWorkspace

func (PostTestRequest_Data_Attributes_Options) MarshalJSON 

func (t PostTestRequest_Data_Attributes_Options) MarshalJSON() ([]byte, error)

func (*PostTestRequest_Data_Attributes_Options) MergeTestOptionsDiff 

func (t *PostTestRequest_Data_Attributes_Options) MergeTestOptionsDiff(v TestOptionsDiff) error

MergeTestOptionsDiff performs a merge with any union data inside the PostTestRequest_Data_Attributes_Options, using the provided TestOptionsDiff

func (*PostTestRequest_Data_Attributes_Options) MergeTestOptionsGitUrl 

func (t *PostTestRequest_Data_Attributes_Options) MergeTestOptionsGitUrl(v TestOptionsGitUrl) error

MergeTestOptionsGitUrl performs a merge with any union data inside the PostTestRequest_Data_Attributes_Options, using the provided TestOptionsGitUrl

func (*PostTestRequest_Data_Attributes_Options) MergeTestOptionsTarget 

func (t *PostTestRequest_Data_Attributes_Options) MergeTestOptionsTarget(v TestOptionsTarget) error

MergeTestOptionsTarget performs a merge with any union data inside the PostTestRequest_Data_Attributes_Options, using the provided TestOptionsTarget

func (*PostTestRequest_Data_Attributes_Options) MergeTestOptionsWorkspace 

func (t *PostTestRequest_Data_Attributes_Options) MergeTestOptionsWorkspace(v TestOptionsWorkspace) error

MergeTestOptionsWorkspace performs a merge with any union data inside the PostTestRequest_Data_Attributes_Options, using the provided TestOptionsWorkspace

func (*PostTestRequest_Data_Attributes_Options) UnmarshalJSON 

func (t *PostTestRequest_Data_Attributes_Options) UnmarshalJSON(b []byte) error

type Scan 

type Scan string

Scan defines model for Scan. 

const (
	CodeSecurity            Scan = "code_security"
	CodeSecurityCodeQuality Scan = "code_security, code_quality"
)

Defines values for Scan.

type TestAcceptedState 

type TestAcceptedState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time               `json:"created_at"`
	Status    TestAcceptedStateStatus `json:"status"`
}

TestAcceptedState defines model for TestAcceptedState.

type TestAcceptedStateStatus 

type TestAcceptedStateStatus string

TestAcceptedStateStatus defines model for TestAcceptedState.Status. 

const (
	TestAcceptedStateStatusAccepted TestAcceptedStateStatus = "accepted"
)

Defines values for TestAcceptedStateStatus.

type TestCompletedState 

type TestCompletedState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`
	Documents struct {
		// EnrichedSarif The location to use for fetching the enriched sarif results
		EnrichedSarif string `json:"enriched_sarif"`
	} `json:"documents"`
	Results struct {
		Outcome struct {
			// Result The outcome of the test. passed - the test completed and passed policy gate, failed - the test completed and failed policy gate
			Result TestCompletedStateResultsOutcomeResult `json:"result"`
		} `json:"outcome"`
		Webui *struct {
			// Link Link to the asset created in the Snyk web UI
			Link *string `json:"link,omitempty"`

			// ProjectId The ID of the created project in the Snyk web UI
			ProjectId *openapi_types.UUID `json:"project_id,omitempty"`

			// SnapshotId The ID of the created snapshot in the Snyk web UI
			SnapshotId *openapi_types.UUID `json:"snapshot_id,omitempty"`
		} `json:"webui,omitempty"`
	} `json:"results"`
	Status TestCompletedStateStatus `json:"status"`
}

TestCompletedState defines model for TestCompletedState.

type TestCompletedStateResultsOutcomeResult 

type TestCompletedStateResultsOutcomeResult string

TestCompletedStateResultsOutcomeResult The outcome of the test. passed - the test completed and passed policy gate, failed - the test completed and failed policy gate 

const (
	TestCompletedStateResultsOutcomeResultFailed TestCompletedStateResultsOutcomeResult = "failed"
	TestCompletedStateResultsOutcomeResultPassed TestCompletedStateResultsOutcomeResult = "passed"
)

Defines values for TestCompletedStateResultsOutcomeResult.

type TestCompletedStateStatus 

type TestCompletedStateStatus string

TestCompletedStateStatus defines model for TestCompletedState.Status. 

const (
	TestCompletedStateStatusCompleted TestCompletedStateStatus = "completed"
)

Defines values for TestCompletedStateStatus.

type TestCoordinates 

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

TestCoordinates defines model for TestCoordinates.

func (TestCoordinates) AsTestOptionsGitUrl 

func (t TestCoordinates) AsTestOptionsGitUrl() (TestOptionsGitUrl, error)

AsTestOptionsGitUrl returns the union data inside the TestCoordinates as a TestOptionsGitUrl

func (TestCoordinates) AsTestOptionsTarget 

func (t TestCoordinates) AsTestOptionsTarget() (TestOptionsTarget, error)

AsTestOptionsTarget returns the union data inside the TestCoordinates as a TestOptionsTarget

func (TestCoordinates) AsTestOptionsWorkspace 

func (t TestCoordinates) AsTestOptionsWorkspace() (TestOptionsWorkspace, error)

AsTestOptionsWorkspace returns the union data inside the TestCoordinates as a TestOptionsWorkspace

func (*TestCoordinates) FromTestOptionsGitUrl 

func (t *TestCoordinates) FromTestOptionsGitUrl(v TestOptionsGitUrl) error

FromTestOptionsGitUrl overwrites any union data inside the TestCoordinates as the provided TestOptionsGitUrl

func (*TestCoordinates) FromTestOptionsTarget 

func (t *TestCoordinates) FromTestOptionsTarget(v TestOptionsTarget) error

FromTestOptionsTarget overwrites any union data inside the TestCoordinates as the provided TestOptionsTarget

func (*TestCoordinates) FromTestOptionsWorkspace 

func (t *TestCoordinates) FromTestOptionsWorkspace(v TestOptionsWorkspace) error

FromTestOptionsWorkspace overwrites any union data inside the TestCoordinates as the provided TestOptionsWorkspace

func (TestCoordinates) MarshalJSON 

func (t TestCoordinates) MarshalJSON() ([]byte, error)

func (*TestCoordinates) MergeTestOptionsGitUrl 

func (t *TestCoordinates) MergeTestOptionsGitUrl(v TestOptionsGitUrl) error

MergeTestOptionsGitUrl performs a merge with any union data inside the TestCoordinates, using the provided TestOptionsGitUrl

func (*TestCoordinates) MergeTestOptionsTarget 

func (t *TestCoordinates) MergeTestOptionsTarget(v TestOptionsTarget) error

MergeTestOptionsTarget performs a merge with any union data inside the TestCoordinates, using the provided TestOptionsTarget

func (*TestCoordinates) MergeTestOptionsWorkspace 

func (t *TestCoordinates) MergeTestOptionsWorkspace(v TestOptionsWorkspace) error

MergeTestOptionsWorkspace performs a merge with any union data inside the TestCoordinates, using the provided TestOptionsWorkspace

func (*TestCoordinates) UnmarshalJSON 

func (t *TestCoordinates) UnmarshalJSON(b []byte) error

type TestErrorState 

type TestErrorState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`
	Errors    *[]struct {
		// Classification A type of error
		Classification string `json:"classification"`

		// ErrorCode The Snyk error code
		ErrorCode string `json:"error_code"`

		// InfoUrl The URL to link to more information about the error
		InfoUrl *string `json:"info_url,omitempty"`

		// Message A custom description of an error.
		Message string `json:"message"`

		// Title The high-level description of an error catalog error
		Title string `json:"title"`
	} `json:"errors,omitempty"`
	Status TestErrorStateStatus `json:"status"`
}

TestErrorState defines model for TestErrorState.

type TestErrorStateStatus 

type TestErrorStateStatus string

TestErrorStateStatus defines model for TestErrorState.Status. 

const (
	TestErrorStateStatusError TestErrorStateStatus = "error"
)

Defines values for TestErrorStateStatus.

type TestInProgressState 

type TestInProgressState struct {
	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time                 `json:"created_at"`
	Status    TestInProgressStateStatus `json:"status"`
}

TestInProgressState defines model for TestInProgressState.

type TestInProgressStateStatus 

type TestInProgressStateStatus string

TestInProgressStateStatus defines model for TestInProgressState.Status. 

const (
	TestInProgressStateStatusInProgress TestInProgressStateStatus = "in_progress"
)

Defines values for TestInProgressStateStatus.

type TestInputBundle 

type TestInputBundle struct {
	// BundleId A Snyk bundle id
	BundleId string `json:"bundle_id"`

	// Metadata Metadata of the input to be tested
	Metadata struct {
		// LimitTestToFiles The findings will be limited to a subset of files only.
		LimitTestToFiles *[]string `json:"limit_test_to_files,omitempty"`

		// LocalFilePath This can be a file path or a folder id for IDE
		LocalFilePath string  `json:"local_file_path"`
		RepoUrl       *string `json:"repo_url,omitempty"`
	} `json:"metadata"`
	Type TestInputBundleType `json:"type"`
}

TestInputBundle defines model for TestInputBundle.

type TestInputBundleType 

type TestInputBundleType string

TestInputBundleType defines model for TestInputBundle.Type. 

const (
	Bundle TestInputBundleType = "bundle"
)

Defines values for TestInputBundleType.

type TestInputLegacyScmProject 

type TestInputLegacyScmProject struct {
	// CommitId SHA of the commit to be tested
	CommitId string `json:"commit_id"`

	// ProjectId Id of the project to be tested
	ProjectId openapi_types.UUID            `json:"project_id"`
	Type      TestInputLegacyScmProjectType `json:"type"`
}

TestInputLegacyScmProject defines model for TestInputLegacyScmProject.

type TestInputLegacyScmProjectType 

type TestInputLegacyScmProjectType string

TestInputLegacyScmProjectType defines model for TestInputLegacyScmProject.Type. 

const (
	LegacyScmProject TestInputLegacyScmProjectType = "legacy_scm_project"
)

Defines values for TestInputLegacyScmProjectType.

type TestOptionsDiff 

type TestOptionsDiff struct {
	Base TestCoordinates `json:"base"`
	Head TestCoordinates `json:"head"`
}

TestOptionsDiff defines model for TestOptionsDiff.

type TestOptionsGitUrl 

type TestOptionsGitUrl struct {
	// IntegrationId A Snyk integration_id
	IntegrationId openapi_types.UUID `json:"integration_id"`

	// RepoUrl A repository url for which a test will run
	RepoUrl string `json:"repo_url"`

	// Revision A git commit revision
	Revision string `json:"revision"`
}

TestOptionsGitUrl defines model for TestOptionsGitUrl.

type TestOptionsTarget 

type TestOptionsTarget struct {
	// TargetId Id of the target to be tested
	TargetId openapi_types.UUID `json:"target_id"`

	// Version This target's version, like a git branch, a commit sha, or a Docker image tag
	Version string `json:"version"`
}

TestOptionsTarget defines model for TestOptionsTarget.

type TestOptionsWorkspace 

type TestOptionsWorkspace struct {
	// WorkspaceId Id of the workspace to be tested
	WorkspaceId openapi_types.UUID `json:"workspace_id"`
}

TestOptionsWorkspace defines model for TestOptionsWorkspace.

type TestResponse 

type TestResponse struct {
	Data struct {
		// Id The id of the Snyk test
		Id   openapi_types.UUID   `json:"id"`
		Type TestResponseDataType `json:"type"`
	} `json:"data"`
	Jsonapi *externalRef0.JsonApi `json:"jsonapi,omitempty"`
	Links   externalRef0.SelfLink `json:"links"`
}

TestResponse defines model for TestResponse.

type TestResponseDataType 

type TestResponseDataType string

TestResponseDataType defines model for TestResponse.Data.Type. 

const (
	TestResponseDataTypeTest TestResponseDataType = "test"
)

Defines values for TestResponseDataType.

type TestResult 

type TestResult struct {
	Data struct {
		Attributes TestState `json:"attributes"`

		// Id The id of the test
		Id   openapi_types.UUID `json:"id"`
		Type TestResultDataType `json:"type"`
	} `json:"data"`
	Jsonapi externalRef0.JsonApi  `json:"jsonapi"`
	Links   externalRef0.SelfLink `json:"links"`
}

TestResult defines model for TestResult.

type TestResultAcceptedState 

type TestResultAcceptedState struct {
	Context *map[string]interface{} `json:"context,omitempty"`

	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time                    `json:"created_at"`
	State     TestResultAcceptedStateState `json:"state"`
}

TestResultAcceptedState defines model for TestResultAcceptedState.

type TestResultAcceptedStateState 

type TestResultAcceptedStateState string

TestResultAcceptedStateState defines model for TestResultAcceptedState.State. 

const (
	TestResultAcceptedStateStateAccepted TestResultAcceptedStateState = "accepted"
)

Defines values for TestResultAcceptedStateState.

type TestResultCompletedState 

type TestResultCompletedState struct {
	Context *map[string]interface{} `json:"context,omitempty"`

	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`
	Findings  []struct {
		// FindingsUrl URL where findings can be downloaded
		FindingsUrl string `json:"findings_url"`

		// Format The format of the findings document
		Format TestResultCompletedStateFindingsFormat `json:"format"`
	} `json:"findings"`
	Result *struct {
		// Status The outcome of the test. passed - the test completed and passed policy gate, failed - the test completed and failed policy gate
		Status TestResultCompletedStateResultStatus `json:"status"`
	} `json:"result,omitempty"`

	// SeverityCounts Severity counts for the findings
	SeverityCounts struct {
		Critical *int `json:"critical,omitempty"`
		High     *int `json:"high,omitempty"`
		Low      *int `json:"low,omitempty"`
		Medium   *int `json:"medium,omitempty"`
	} `json:"severity_counts"`
	State TestResultCompletedStateState `json:"state"`
}

TestResultCompletedState defines model for TestResultCompletedState.

type TestResultCompletedStateFindingsFormat 

type TestResultCompletedStateFindingsFormat string

TestResultCompletedStateFindingsFormat The format of the findings document 

const (
	CYCLONEDX TestResultCompletedStateFindingsFormat = "CYCLONE_DX"
	SARIF     TestResultCompletedStateFindingsFormat = "SARIF"
)

Defines values for TestResultCompletedStateFindingsFormat.

type TestResultCompletedStateResultStatus 

type TestResultCompletedStateResultStatus string

TestResultCompletedStateResultStatus The outcome of the test. passed - the test completed and passed policy gate, failed - the test completed and failed policy gate 

const (
	TestResultCompletedStateResultStatusFailed TestResultCompletedStateResultStatus = "failed"
	TestResultCompletedStateResultStatusPassed TestResultCompletedStateResultStatus = "passed"
)

Defines values for TestResultCompletedStateResultStatus.

type TestResultCompletedStateState 

type TestResultCompletedStateState string

TestResultCompletedStateState defines model for TestResultCompletedState.State. 

const (
	TestResultCompletedStateStateCompleted TestResultCompletedStateState = "completed"
)

Defines values for TestResultCompletedStateState.

type TestResultDataType 

type TestResultDataType string

TestResultDataType defines model for TestResult.Data.Type. 

const (
	TestResultDataTypeTest TestResultDataType = "test"
)

Defines values for TestResultDataType.

type TestResultErrorState 

type TestResultErrorState struct {
	Context *map[string]interface{} `json:"context,omitempty"`

	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time `json:"created_at"`
	Errors    *[]struct {
		// Classification A type of error
		Classification string `json:"classification"`

		// ErrorCode The Snyk error code
		ErrorCode string `json:"error_code"`

		// InfoUrl The URL to link to more information about the error
		InfoUrl *string `json:"info_url,omitempty"`

		// Message A custom description of an error.
		Message string `json:"message"`

		// Title The high-level description of an error catalog error
		Title string `json:"title"`
	} `json:"errors,omitempty"`
	State TestResultErrorStateState `json:"state"`
}

TestResultErrorState defines model for TestResultErrorState.

type TestResultErrorStateState 

type TestResultErrorStateState string

TestResultErrorStateState defines model for TestResultErrorState.State. 

const (
	TestResultErrorStateStateError TestResultErrorStateState = "error"
)

Defines values for TestResultErrorStateState.

type TestResultInProgressState 

type TestResultInProgressState struct {
	Context *map[string]interface{} `json:"context,omitempty"`

	// CreatedAt Timestamp when the test was created
	CreatedAt time.Time                      `json:"created_at"`
	State     TestResultInProgressStateState `json:"state"`
}

TestResultInProgressState defines model for TestResultInProgressState.

type TestResultInProgressStateState 

type TestResultInProgressStateState string

TestResultInProgressStateState defines model for TestResultInProgressState.State. 

const (
	TestResultInProgressStateStateInProgress TestResultInProgressStateState = "in_progress"
)

Defines values for TestResultInProgressStateState.

type TestResultResponse 

type TestResultResponse struct {
	Data struct {
		Attributes TestResultState `json:"attributes"`

		// Id The id of the test
		Id   openapi_types.UUID         `json:"id"`
		Type TestResultResponseDataType `json:"type"`
	} `json:"data"`
	Jsonapi externalRef0.JsonApi  `json:"jsonapi"`
	Links   externalRef0.SelfLink `json:"links"`
}

TestResultResponse defines model for TestResultResponse.

type TestResultResponseDataType 

type TestResultResponseDataType string

TestResultResponseDataType defines model for TestResultResponse.Data.Type. 

const (
	Test TestResultResponseDataType = "test"
)

Defines values for TestResultResponseDataType.

type TestResultState 

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

TestResultState defines model for TestResultState.

func (TestResultState) AsTestResultAcceptedState 

func (t TestResultState) AsTestResultAcceptedState() (TestResultAcceptedState, error)

AsTestResultAcceptedState returns the union data inside the TestResultState as a TestResultAcceptedState

func (TestResultState) AsTestResultCompletedState 

func (t TestResultState) AsTestResultCompletedState() (TestResultCompletedState, error)

AsTestResultCompletedState returns the union data inside the TestResultState as a TestResultCompletedState

func (TestResultState) AsTestResultErrorState 

func (t TestResultState) AsTestResultErrorState() (TestResultErrorState, error)

AsTestResultErrorState returns the union data inside the TestResultState as a TestResultErrorState

func (TestResultState) AsTestResultInProgressState 

func (t TestResultState) AsTestResultInProgressState() (TestResultInProgressState, error)

AsTestResultInProgressState returns the union data inside the TestResultState as a TestResultInProgressState

func (TestResultState) Discriminator 

func (t TestResultState) Discriminator() (string, error)

func (*TestResultState) FromTestResultAcceptedState 

func (t *TestResultState) FromTestResultAcceptedState(v TestResultAcceptedState) error

FromTestResultAcceptedState overwrites any union data inside the TestResultState as the provided TestResultAcceptedState

func (*TestResultState) FromTestResultCompletedState 

func (t *TestResultState) FromTestResultCompletedState(v TestResultCompletedState) error

FromTestResultCompletedState overwrites any union data inside the TestResultState as the provided TestResultCompletedState

func (*TestResultState) FromTestResultErrorState 

func (t *TestResultState) FromTestResultErrorState(v TestResultErrorState) error

FromTestResultErrorState overwrites any union data inside the TestResultState as the provided TestResultErrorState

func (*TestResultState) FromTestResultInProgressState 

func (t *TestResultState) FromTestResultInProgressState(v TestResultInProgressState) error

FromTestResultInProgressState overwrites any union data inside the TestResultState as the provided TestResultInProgressState

func (TestResultState) MarshalJSON 

func (t TestResultState) MarshalJSON() ([]byte, error)

func (*TestResultState) MergeTestResultAcceptedState 

func (t *TestResultState) MergeTestResultAcceptedState(v TestResultAcceptedState) error

MergeTestResultAcceptedState performs a merge with any union data inside the TestResultState, using the provided TestResultAcceptedState

func (*TestResultState) MergeTestResultCompletedState 

func (t *TestResultState) MergeTestResultCompletedState(v TestResultCompletedState) error

MergeTestResultCompletedState performs a merge with any union data inside the TestResultState, using the provided TestResultCompletedState

func (*TestResultState) MergeTestResultErrorState 

func (t *TestResultState) MergeTestResultErrorState(v TestResultErrorState) error

MergeTestResultErrorState performs a merge with any union data inside the TestResultState, using the provided TestResultErrorState

func (*TestResultState) MergeTestResultInProgressState 

func (t *TestResultState) MergeTestResultInProgressState(v TestResultInProgressState) error

MergeTestResultInProgressState performs a merge with any union data inside the TestResultState, using the provided TestResultInProgressState

func (*TestResultState) UnmarshalJSON 

func (t *TestResultState) UnmarshalJSON(b []byte) error

func (TestResultState) ValueByDiscriminator 

func (t TestResultState) ValueByDiscriminator() (interface{}, error)

type TestState 

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

TestState defines model for TestState.

func (TestState) AsTestAcceptedState 

func (t TestState) AsTestAcceptedState() (TestAcceptedState, error)

AsTestAcceptedState returns the union data inside the TestState as a TestAcceptedState

func (TestState) AsTestCompletedState 

func (t TestState) AsTestCompletedState() (TestCompletedState, error)

AsTestCompletedState returns the union data inside the TestState as a TestCompletedState

func (TestState) AsTestErrorState 

func (t TestState) AsTestErrorState() (TestErrorState, error)

AsTestErrorState returns the union data inside the TestState as a TestErrorState

func (TestState) AsTestInProgressState 

func (t TestState) AsTestInProgressState() (TestInProgressState, error)

AsTestInProgressState returns the union data inside the TestState as a TestInProgressState

func (TestState) Discriminator 

func (t TestState) Discriminator() (string, error)

func (*TestState) FromTestAcceptedState 

func (t *TestState) FromTestAcceptedState(v TestAcceptedState) error

FromTestAcceptedState overwrites any union data inside the TestState as the provided TestAcceptedState

func (*TestState) FromTestCompletedState 

func (t *TestState) FromTestCompletedState(v TestCompletedState) error

FromTestCompletedState overwrites any union data inside the TestState as the provided TestCompletedState

func (*TestState) FromTestErrorState 

func (t *TestState) FromTestErrorState(v TestErrorState) error

FromTestErrorState overwrites any union data inside the TestState as the provided TestErrorState

func (*TestState) FromTestInProgressState 

func (t *TestState) FromTestInProgressState(v TestInProgressState) error

FromTestInProgressState overwrites any union data inside the TestState as the provided TestInProgressState

func (TestState) MarshalJSON 

func (t TestState) MarshalJSON() ([]byte, error)

func (*TestState) MergeTestAcceptedState 

func (t *TestState) MergeTestAcceptedState(v TestAcceptedState) error

MergeTestAcceptedState performs a merge with any union data inside the TestState, using the provided TestAcceptedState

func (*TestState) MergeTestCompletedState 

func (t *TestState) MergeTestCompletedState(v TestCompletedState) error

MergeTestCompletedState performs a merge with any union data inside the TestState, using the provided TestCompletedState

func (*TestState) MergeTestErrorState 

func (t *TestState) MergeTestErrorState(v TestErrorState) error

MergeTestErrorState performs a merge with any union data inside the TestState, using the provided TestErrorState

func (*TestState) MergeTestInProgressState 

func (t *TestState) MergeTestInProgressState(v TestInProgressState) error

MergeTestInProgressState performs a merge with any union data inside the TestState, using the provided TestInProgressState

func (*TestState) UnmarshalJSON 

func (t *TestState) UnmarshalJSON(b []byte) error

func (TestState) ValueByDiscriminator 

func (t TestState) ValueByDiscriminator() (interface{}, error)

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.