Versions in this module Expand all Collapse all v1 v1.0.0 Aug 30, 2026 Changes in this version + var Environments = struct{ ... } + var ErrorCodes internal.ErrorCodes = internal.ErrorCodes + func Bool(b bool) *bool + func Byte(b byte) *byte + func Bytes(b []byte) *[]byte + func Complex128(c complex128) *complex128 + func Complex64(c complex64) *complex64 + func Float32(f float32) *float32 + func Float64(f float64) *float64 + func Int(i int) *int + func Int16(i int16) *int16 + func Int32(i int32) *int32 + func Int64(i int64) *int64 + func Int8(i int8) *int8 + func MustParseDate(date string) time.Time + func MustParseDateTime(datetime string) time.Time + func Rune(r rune) *rune + func String(s string) *string + func Time(t time.Time) *time.Time + func UUID(u uuid.UUID) *uuid.UUID + func Uint(u uint) *uint + func Uint16(u uint16) *uint16 + func Uint32(u uint32) *uint32 + func Uint64(u uint64) *uint64 + func Uint8(u uint8) *uint8 + func Uintptr(u uintptr) *uintptr + type APIError struct + Code string + Details map[string]string + Message string + func (a *APIError) GetCode() string + func (a *APIError) GetDetails() map[string]string + func (a *APIError) GetExtraProperties() map[string]interface{} + func (a *APIError) GetMessage() string + func (a *APIError) MarshalJSON() ([]byte, error) + func (a *APIError) SetCode(code string) + func (a *APIError) SetDetails(details map[string]string) + func (a *APIError) SetMessage(message string) + func (a *APIError) String() string + func (a *APIError) UnmarshalJSON(data []byte) error + type BadRequestError struct + Body *ErrorResponse + func (b *BadRequestError) MarshalJSON() ([]byte, error) + func (b *BadRequestError) UnmarshalJSON(data []byte) error + func (b *BadRequestError) Unwrap() error + type ContentTooLargeError struct + Body *ErrorResponse + func (c *ContentTooLargeError) MarshalJSON() ([]byte, error) + func (c *ContentTooLargeError) UnmarshalJSON(data []byte) error + func (c *ContentTooLargeError) Unwrap() error + type ErrorResponse struct + Error *APIError + func (e *ErrorResponse) GetError() *APIError + func (e *ErrorResponse) GetExtraProperties() map[string]interface{} + func (e *ErrorResponse) MarshalJSON() ([]byte, error) + func (e *ErrorResponse) SetError(error_ *APIError) + func (e *ErrorResponse) String() string + func (e *ErrorResponse) UnmarshalJSON(data []byte) error + type FileParam struct + func NewFileParam(reader io.Reader, filename string, contentType string, opts ...FileParamOption) *FileParam + func (f *FileParam) ContentType() string + func (f *FileParam) Name() string + type FileParamOption interface + type ForbiddenError struct + Body *ErrorResponse + func (f *ForbiddenError) MarshalJSON() ([]byte, error) + func (f *ForbiddenError) UnmarshalJSON(data []byte) error + func (f *ForbiddenError) Unwrap() error + type GetScanRequest struct + ScanID string + func (g *GetScanRequest) SetScanID(scanID string) + type HealthResponse struct + Status HealthResponseStatus + func (h *HealthResponse) GetExtraProperties() map[string]interface{} + func (h *HealthResponse) GetStatus() HealthResponseStatus + func (h *HealthResponse) MarshalJSON() ([]byte, error) + func (h *HealthResponse) SetStatus(status HealthResponseStatus) + func (h *HealthResponse) String() string + func (h *HealthResponse) UnmarshalJSON(data []byte) error + type HealthResponseStatus string + const HealthResponseStatusDegraded + const HealthResponseStatusOk + func NewHealthResponseStatusFromString(s string) (HealthResponseStatus, error) + func (h HealthResponseStatus) Ptr() *HealthResponseStatus + type InternalServerError struct + Body *ErrorResponse + func (i *InternalServerError) MarshalJSON() ([]byte, error) + func (i *InternalServerError) UnmarshalJSON(data []byte) error + func (i *InternalServerError) Unwrap() error + type ListScansRequest struct + Cursor *string + DetectionRule *string + EngineSignature *string + Failure *ListScansRequestFailure + Filename *string + Limit *int + ScanID *string + SourceType *ListScansRequestSourceType + StorageIntegrationID *string + Verdict *string + func (l *ListScansRequest) SetCursor(cursor *string) + func (l *ListScansRequest) SetDetectionRule(detectionRule *string) + func (l *ListScansRequest) SetEngineSignature(engineSignature *string) + func (l *ListScansRequest) SetFailure(failure *ListScansRequestFailure) + func (l *ListScansRequest) SetFilename(filename *string) + func (l *ListScansRequest) SetLimit(limit *int) + func (l *ListScansRequest) SetScanID(scanID *string) + func (l *ListScansRequest) SetSourceType(sourceType *ListScansRequestSourceType) + func (l *ListScansRequest) SetStorageIntegrationID(storageIntegrationID *string) + func (l *ListScansRequest) SetVerdict(verdict *string) + type ListScansRequestFailure string + const ListScansRequestFailureAny + const ListScansRequestFailureContentExpansionLimitExceeded + const ListScansRequestFailureNone + const ListScansRequestFailureScannerUnavailable + func NewListScansRequestFailureFromString(s string) (ListScansRequestFailure, error) + func (l ListScansRequestFailure) Ptr() *ListScansRequestFailure + type ListScansRequestSourceType string + const ListScansRequestSourceTypeAPI + const ListScansRequestSourceTypeS3 + func NewListScansRequestSourceTypeFromString(s string) (ListScansRequestSourceType, error) + func (l ListScansRequestSourceType) Ptr() *ListScansRequestSourceType + type NotFoundError struct + Body *ErrorResponse + func (n *NotFoundError) MarshalJSON() ([]byte, error) + func (n *NotFoundError) UnmarshalJSON(data []byte) error + func (n *NotFoundError) Unwrap() error + type Scan struct + CreatedAt time.Time + Detections []string + DurationMs float64 + Failure *ScanFailure + Filename string + ID string + Sha256 string + SizeBytes int64 + Source *ScanSource + Status ScanStatus + Timings *ScanTimings + TypeAnalysis *TypeAnalysis + Verdict ScanVerdict + func (s *Scan) GetCreatedAt() time.Time + func (s *Scan) GetDetections() []string + func (s *Scan) GetDurationMs() float64 + func (s *Scan) GetExtraProperties() map[string]interface{} + func (s *Scan) GetFailure() *ScanFailure + func (s *Scan) GetFilename() string + func (s *Scan) GetID() string + func (s *Scan) GetSha256() string + func (s *Scan) GetSizeBytes() int64 + func (s *Scan) GetSource() *ScanSource + func (s *Scan) GetStatus() ScanStatus + func (s *Scan) GetTimings() *ScanTimings + func (s *Scan) GetTypeAnalysis() *TypeAnalysis + func (s *Scan) GetVerdict() ScanVerdict + func (s *Scan) MarshalJSON() ([]byte, error) + func (s *Scan) SetCreatedAt(createdAt time.Time) + func (s *Scan) SetDetections(detections []string) + func (s *Scan) SetDurationMs(durationMs float64) + func (s *Scan) SetFailure(failure *ScanFailure) + func (s *Scan) SetFilename(filename string) + func (s *Scan) SetID(id string) + func (s *Scan) SetSha256(sha256 string) + func (s *Scan) SetSizeBytes(sizeBytes int64) + func (s *Scan) SetSource(source *ScanSource) + func (s *Scan) SetStatus(status ScanStatus) + func (s *Scan) SetTimings(timings *ScanTimings) + func (s *Scan) SetTypeAnalysis(typeAnalysis *TypeAnalysis) + func (s *Scan) SetVerdict(verdict ScanVerdict) + func (s *Scan) String() string + func (s *Scan) UnmarshalJSON(data []byte) error + type ScanBatchResponse struct + Results []*ScanBatchResult + func (s *ScanBatchResponse) GetExtraProperties() map[string]interface{} + func (s *ScanBatchResponse) GetResults() []*ScanBatchResult + func (s *ScanBatchResponse) MarshalJSON() ([]byte, error) + func (s *ScanBatchResponse) SetResults(results []*ScanBatchResult) + func (s *ScanBatchResponse) String() string + func (s *ScanBatchResponse) UnmarshalJSON(data []byte) error + type ScanBatchResult struct + Error *APIError + Filename string + HTTPStatus int + Index int + Scan *Scan + func (s *ScanBatchResult) GetError() *APIError + func (s *ScanBatchResult) GetExtraProperties() map[string]interface{} + func (s *ScanBatchResult) GetFilename() string + func (s *ScanBatchResult) GetHTTPStatus() int + func (s *ScanBatchResult) GetIndex() int + func (s *ScanBatchResult) GetScan() *Scan + func (s *ScanBatchResult) MarshalJSON() ([]byte, error) + func (s *ScanBatchResult) SetError(error_ *APIError) + func (s *ScanBatchResult) SetFilename(filename string) + func (s *ScanBatchResult) SetHTTPStatus(httpStatus int) + func (s *ScanBatchResult) SetIndex(index int) + func (s *ScanBatchResult) SetScan(scan *Scan) + func (s *ScanBatchResult) String() string + func (s *ScanBatchResult) UnmarshalJSON(data []byte) error + type ScanFailure struct + Code ScanFailureCode + Message string + func (s *ScanFailure) GetCode() ScanFailureCode + func (s *ScanFailure) GetExtraProperties() map[string]interface{} + func (s *ScanFailure) GetMessage() string + func (s *ScanFailure) MarshalJSON() ([]byte, error) + func (s *ScanFailure) SetCode(code ScanFailureCode) + func (s *ScanFailure) SetMessage(message string) + func (s *ScanFailure) String() string + func (s *ScanFailure) UnmarshalJSON(data []byte) error + type ScanFailureCode string + const ScanFailureCodeContentExpansionLimitExceeded + const ScanFailureCodeScannerUnavailable + func NewScanFailureCodeFromString(s string) (ScanFailureCode, error) + func (s ScanFailureCode) Ptr() *ScanFailureCode + type ScanList struct + Items []*Scan + NextCursor *string + func (s *ScanList) GetExtraProperties() map[string]interface{} + func (s *ScanList) GetItems() []*Scan + func (s *ScanList) GetNextCursor() *string + func (s *ScanList) MarshalJSON() ([]byte, error) + func (s *ScanList) SetItems(items []*Scan) + func (s *ScanList) SetNextCursor(nextCursor *string) + func (s *ScanList) String() string + func (s *ScanList) UnmarshalJSON(data []byte) error + type ScanSource struct + IntegrationID *string + IntegrationName *string + Type ScanSourceType + func (s *ScanSource) GetExtraProperties() map[string]interface{} + func (s *ScanSource) GetIntegrationID() *string + func (s *ScanSource) GetIntegrationName() *string + func (s *ScanSource) GetType() ScanSourceType + func (s *ScanSource) MarshalJSON() ([]byte, error) + func (s *ScanSource) SetIntegrationID(integrationID *string) + func (s *ScanSource) SetIntegrationName(integrationName *string) + func (s *ScanSource) SetType(type_ ScanSourceType) + func (s *ScanSource) String() string + func (s *ScanSource) UnmarshalJSON(data []byte) error + type ScanSourceType string + const ScanSourceTypeAPI + const ScanSourceTypeS3 + func NewScanSourceTypeFromString(s string) (ScanSourceType, error) + func (s ScanSourceType) Ptr() *ScanSourceType + type ScanStatus string + const ScanStatusCompleted + const ScanStatusFailed + func NewScanStatusFromString(s string) (ScanStatus, error) + func (s ScanStatus) Ptr() *ScanStatus + type ScanTimings struct + FileTypeMs float64 + MalwareScanMs float64 + func (s *ScanTimings) GetExtraProperties() map[string]interface{} + func (s *ScanTimings) GetFileTypeMs() float64 + func (s *ScanTimings) GetMalwareScanMs() float64 + func (s *ScanTimings) MarshalJSON() ([]byte, error) + func (s *ScanTimings) SetFileTypeMs(fileTypeMs float64) + func (s *ScanTimings) SetMalwareScanMs(malwareScanMs float64) + func (s *ScanTimings) String() string + func (s *ScanTimings) UnmarshalJSON(data []byte) error + type ScanVerdict string + const ScanVerdictClean + const ScanVerdictMalicious + const ScanVerdictSuspicious + const ScanVerdictUnknown + func NewScanVerdictFromString(s string) (ScanVerdict, error) + func (s ScanVerdict) Ptr() *ScanVerdict + type ServiceUnavailableError struct + Body any + func (s *ServiceUnavailableError) MarshalJSON() ([]byte, error) + func (s *ServiceUnavailableError) UnmarshalJSON(data []byte) error + func (s *ServiceUnavailableError) Unwrap() error + type TooManyRequestsError struct + Body *ErrorResponse + func (t *TooManyRequestsError) MarshalJSON() ([]byte, error) + func (t *TooManyRequestsError) UnmarshalJSON(data []byte) error + func (t *TooManyRequestsError) Unwrap() error + type TypeAnalysis struct + Confidence TypeAnalysisConfidence + Declared *TypeDeclaration + Identified *TypeIdentification + Reason *TypeAnalysisReason + Status TypeAnalysisStatus + StructurallyValid *bool + func (t *TypeAnalysis) GetConfidence() TypeAnalysisConfidence + func (t *TypeAnalysis) GetDeclared() *TypeDeclaration + func (t *TypeAnalysis) GetExtraProperties() map[string]interface{} + func (t *TypeAnalysis) GetIdentified() *TypeIdentification + func (t *TypeAnalysis) GetReason() *TypeAnalysisReason + func (t *TypeAnalysis) GetStatus() TypeAnalysisStatus + func (t *TypeAnalysis) GetStructurallyValid() *bool + func (t *TypeAnalysis) MarshalJSON() ([]byte, error) + func (t *TypeAnalysis) SetConfidence(confidence TypeAnalysisConfidence) + func (t *TypeAnalysis) SetDeclared(declared *TypeDeclaration) + func (t *TypeAnalysis) SetIdentified(identified *TypeIdentification) + func (t *TypeAnalysis) SetReason(reason *TypeAnalysisReason) + func (t *TypeAnalysis) SetStatus(status TypeAnalysisStatus) + func (t *TypeAnalysis) SetStructurallyValid(structurallyValid *bool) + func (t *TypeAnalysis) String() string + func (t *TypeAnalysis) UnmarshalJSON(data []byte) error + type TypeAnalysisConfidence string + const TypeAnalysisConfidenceHigh + const TypeAnalysisConfidenceLow + const TypeAnalysisConfidenceMedium + func NewTypeAnalysisConfidenceFromString(s string) (TypeAnalysisConfidence, error) + func (t TypeAnalysisConfidence) Ptr() *TypeAnalysisConfidence + type TypeAnalysisReason struct + Claimed *string + Code TypeAnalysisReasonCode + Detected *string + func (t *TypeAnalysisReason) GetClaimed() *string + func (t *TypeAnalysisReason) GetCode() TypeAnalysisReasonCode + func (t *TypeAnalysisReason) GetDetected() *string + func (t *TypeAnalysisReason) GetExtraProperties() map[string]interface{} + func (t *TypeAnalysisReason) MarshalJSON() ([]byte, error) + func (t *TypeAnalysisReason) SetClaimed(claimed *string) + func (t *TypeAnalysisReason) SetCode(code TypeAnalysisReasonCode) + func (t *TypeAnalysisReason) SetDetected(detected *string) + func (t *TypeAnalysisReason) String() string + func (t *TypeAnalysisReason) UnmarshalJSON(data []byte) error + type TypeAnalysisReasonCode string + const TypeAnalysisReasonCodeContentExpansionLimitExceeded + const TypeAnalysisReasonCodeEncryptedArchive + const TypeAnalysisReasonCodeFileTypeMismatch + const TypeAnalysisReasonCodeMalformedFile + const TypeAnalysisReasonCodeUnsupportedArchive + func NewTypeAnalysisReasonCodeFromString(s string) (TypeAnalysisReasonCode, error) + func (t TypeAnalysisReasonCode) Ptr() *TypeAnalysisReasonCode + type TypeAnalysisStatus string + const TypeAnalysisStatusCompatible + const TypeAnalysisStatusMalformed + const TypeAnalysisStatusMatch + const TypeAnalysisStatusMismatch + const TypeAnalysisStatusUnknown + const TypeAnalysisStatusUnscannable + func NewTypeAnalysisStatusFromString(s string) (TypeAnalysisStatus, error) + func (t TypeAnalysisStatus) Ptr() *TypeAnalysisStatus + type TypeDeclaration struct + Extension *string + Mime *string + func (t *TypeDeclaration) GetExtension() *string + func (t *TypeDeclaration) GetExtraProperties() map[string]interface{} + func (t *TypeDeclaration) GetMime() *string + func (t *TypeDeclaration) MarshalJSON() ([]byte, error) + func (t *TypeDeclaration) SetExtension(extension *string) + func (t *TypeDeclaration) SetMime(mime *string) + func (t *TypeDeclaration) String() string + func (t *TypeDeclaration) UnmarshalJSON(data []byte) error + type TypeIdentification struct + Format *string + Mime *string + func (t *TypeIdentification) GetExtraProperties() map[string]interface{} + func (t *TypeIdentification) GetFormat() *string + func (t *TypeIdentification) GetMime() *string + func (t *TypeIdentification) MarshalJSON() ([]byte, error) + func (t *TypeIdentification) SetFormat(format *string) + func (t *TypeIdentification) SetMime(mime *string) + func (t *TypeIdentification) String() string + func (t *TypeIdentification) UnmarshalJSON(data []byte) error + type UnauthorizedError struct + Body *ErrorResponse + func (u *UnauthorizedError) MarshalJSON() ([]byte, error) + func (u *UnauthorizedError) UnmarshalJSON(data []byte) error + func (u *UnauthorizedError) Unwrap() error