findingsv1

package
v1.3.4 Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2021 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package findingsv1 : Operations and models for the FindingsV1 service

Index

Constants

View Source 
const (
	CardElementKindBreakdownConst  = "BREAKDOWN"
	CardElementKindNumericConst    = "NUMERIC"
	CardElementKindTimeSeriesConst = "TIME_SERIES"
)

Constants associated with the CardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.

View Source 
const (
	CreateNoteOptionsKindCardConst           = "CARD"
	CreateNoteOptionsKindCardConfiguredConst = "CARD_CONFIGURED"
	CreateNoteOptionsKindFindingConst        = "FINDING"
	CreateNoteOptionsKindKpiConst            = "KPI"
	CreateNoteOptionsKindSectionConst        = "SECTION"
)

Constants associated with the CreateNoteOptions.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	CreateOccurrenceOptionsKindCardConst           = "CARD"
	CreateOccurrenceOptionsKindCardConfiguredConst = "CARD_CONFIGURED"
	CreateOccurrenceOptionsKindFindingConst        = "FINDING"
	CreateOccurrenceOptionsKindKpiConst            = "KPI"
	CreateOccurrenceOptionsKindSectionConst        = "SECTION"
)

Constants associated with the CreateOccurrenceOptions.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	FindingSeverityCriticalConst = "CRITICAL"
	FindingSeverityHighConst     = "HIGH"
	FindingSeverityLowConst      = "LOW"
	FindingSeverityMediumConst   = "MEDIUM"
)

Constants associated with the Finding.Severity property. Note provider-assigned severity/impact ranking - LOW: Low Impact - MEDIUM: Medium Impact - HIGH: High Impact - CRITICAL: Critical Impact.

View Source 
const (
	FindingCertaintyHighConst   = "HIGH"
	FindingCertaintyLowConst    = "LOW"
	FindingCertaintyMediumConst = "MEDIUM"
)

Constants associated with the Finding.Certainty property. Note provider-assigned confidence on the validity of an occurrence - LOW: Low Certainty - MEDIUM: Medium Certainty - HIGH: High Certainty.

View Source 
const (
	FindingTypeSeverityCriticalConst = "CRITICAL"
	FindingTypeSeverityHighConst     = "HIGH"
	FindingTypeSeverityLowConst      = "LOW"
	FindingTypeSeverityMediumConst   = "MEDIUM"
)

Constants associated with the FindingType.Severity property. Note provider-assigned severity/impact ranking - LOW: Low Impact - MEDIUM: Medium Impact - HIGH: High Impact - CRITICAL: Critical Impact.

View Source 
const (
	KpiTypeSeverityCriticalConst = "CRITICAL"
	KpiTypeSeverityHighConst     = "HIGH"
	KpiTypeSeverityLowConst      = "LOW"
	KpiTypeSeverityMediumConst   = "MEDIUM"
)

Constants associated with the KpiType.Severity property.

View Source 
const (
	UpdateNoteOptionsKindCardConst           = "CARD"
	UpdateNoteOptionsKindCardConfiguredConst = "CARD_CONFIGURED"
	UpdateNoteOptionsKindFindingConst        = "FINDING"
	UpdateNoteOptionsKindKpiConst            = "KPI"
	UpdateNoteOptionsKindSectionConst        = "SECTION"
)

Constants associated with the UpdateNoteOptions.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	UpdateOccurrenceOptionsKindCardConst           = "CARD"
	UpdateOccurrenceOptionsKindCardConfiguredConst = "CARD_CONFIGURED"
	UpdateOccurrenceOptionsKindFindingConst        = "FINDING"
	UpdateOccurrenceOptionsKindKpiConst            = "KPI"
	UpdateOccurrenceOptionsKindSectionConst        = "SECTION"
)

Constants associated with the UpdateOccurrenceOptions.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	APINoteKindCardConst           = "CARD"
	APINoteKindCardConfiguredConst = "CARD_CONFIGURED"
	APINoteKindFindingConst        = "FINDING"
	APINoteKindKpiConst            = "KPI"
	APINoteKindSectionConst        = "SECTION"
)

Constants associated with the APINote.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	APIOccurrenceKindCardConst           = "CARD"
	APIOccurrenceKindCardConfiguredConst = "CARD_CONFIGURED"
	APIOccurrenceKindFindingConst        = "FINDING"
	APIOccurrenceKindKpiConst            = "KPI"
	APIOccurrenceKindSectionConst        = "SECTION"
)

Constants associated with the APIOccurrence.Kind property. The type of note. Use this field to filter notes and occurences by kind.

  • FINDING: The note and occurrence represent a finding.
  • KPI: The note and occurrence represent a KPI value.
  • CARD: The note represents a card showing findings and related metric values.
  • CARD_CONFIGURED: The note represents a card configured for a user account.
  • SECTION: The note represents a section in a dashboard.
View Source 
const (
	CardElementBreakdownCardElementKindBreakdownConst  = "BREAKDOWN"
	CardElementBreakdownCardElementKindNumericConst    = "NUMERIC"
	CardElementBreakdownCardElementKindTimeSeriesConst = "TIME_SERIES"
)

Constants associated with the CardElementBreakdownCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.

View Source 
const (
	CardElementNumericCardElementKindBreakdownConst  = "BREAKDOWN"
	CardElementNumericCardElementKindNumericConst    = "NUMERIC"
	CardElementNumericCardElementKindTimeSeriesConst = "TIME_SERIES"
)

Constants associated with the CardElementNumericCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.

View Source 
const (
	CardElementTimeSeriesCardElementKindBreakdownConst  = "BREAKDOWN"
	CardElementTimeSeriesCardElementKindNumericConst    = "NUMERIC"
	CardElementTimeSeriesCardElementKindTimeSeriesConst = "TIME_SERIES"
)

Constants associated with the CardElementTimeSeriesCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.

View Source 
const DefaultServiceName = "findings"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://us-south.secadvisor.cloud.ibm.com/findings"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	KpiTypeAggregationTypeSumConst = "SUM"
)

Constants associated with the KpiType.AggregationType property. The aggregation type of the KPI values. - SUM: A single-value metrics aggregation type that sums up numeric values 

that are extracted from KPI occurrences.
View Source 
const (
	NumericCardElementValueTypeKindKpiConst = "KPI"
)

Constants associated with the NumericCardElementValueType.Kind property. Kind of element - KPI: Kind of value derived from a KPI occurrence.

View Source 
const (
	ValueTypeFindingCountValueTypeKindFindingCountConst = "FINDING_COUNT"
)

Constants associated with the ValueTypeFindingCountValueType.Kind property. Kind of element - FINDING_COUNT: Kind of value derived from a count of finding occurrences.

View Source 
const (
	ValueTypeKindKpiConst = "KPI"
)

Constants associated with the ValueType.Kind property. Kind of element - KPI: Kind of value derived from a KPI occurrence.

View Source 
const (
	ValueTypeKpiValueTypeKindKpiConst = "KPI"
)

Constants associated with the ValueTypeKpiValueType.Kind property. Kind of element - KPI: Kind of value derived from a KPI occurrence.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalAPIListNoteOccurrencesResponse 

func UnmarshalAPIListNoteOccurrencesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIListNoteOccurrencesResponse unmarshals an instance of APIListNoteOccurrencesResponse from the specified map of raw messages.

func UnmarshalAPIListNotesResponse 

func UnmarshalAPIListNotesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIListNotesResponse unmarshals an instance of APIListNotesResponse from the specified map of raw messages.

func UnmarshalAPIListOccurrencesResponse 

func UnmarshalAPIListOccurrencesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIListOccurrencesResponse unmarshals an instance of APIListOccurrencesResponse from the specified map of raw messages.

func UnmarshalAPIListProvidersResponse 

func UnmarshalAPIListProvidersResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIListProvidersResponse unmarshals an instance of APIListProvidersResponse from the specified map of raw messages.

func UnmarshalAPINote 

func UnmarshalAPINote(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPINote unmarshals an instance of APINote from the specified map of raw messages.

func UnmarshalAPINoteRelatedURL 

func UnmarshalAPINoteRelatedURL(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPINoteRelatedURL unmarshals an instance of APINoteRelatedURL from the specified map of raw messages.

func UnmarshalAPIOccurrence 

func UnmarshalAPIOccurrence(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIOccurrence unmarshals an instance of APIOccurrence from the specified map of raw messages.

func UnmarshalAPIProvider 

func UnmarshalAPIProvider(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAPIProvider unmarshals an instance of APIProvider from the specified map of raw messages.

func UnmarshalCard 

func UnmarshalCard(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCard unmarshals an instance of Card from the specified map of raw messages.

func UnmarshalCardElement 

func UnmarshalCardElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCardElement unmarshals an instance of CardElement from the specified map of raw messages.

func UnmarshalCardElementBreakdownCardElement 

func UnmarshalCardElementBreakdownCardElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCardElementBreakdownCardElement unmarshals an instance of CardElementBreakdownCardElement from the specified map of raw messages.

func UnmarshalCardElementNumericCardElement 

func UnmarshalCardElementNumericCardElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCardElementNumericCardElement unmarshals an instance of CardElementNumericCardElement from the specified map of raw messages.

func UnmarshalCardElementTimeSeriesCardElement 

func UnmarshalCardElementTimeSeriesCardElement(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCardElementTimeSeriesCardElement unmarshals an instance of CardElementTimeSeriesCardElement from the specified map of raw messages.

func UnmarshalContext 

func UnmarshalContext(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalContext unmarshals an instance of Context from the specified map of raw messages.

func UnmarshalDataTransferred 

func UnmarshalDataTransferred(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDataTransferred unmarshals an instance of DataTransferred from the specified map of raw messages.

func UnmarshalFinding 

func UnmarshalFinding(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFinding unmarshals an instance of Finding from the specified map of raw messages.

func UnmarshalFindingType 

func UnmarshalFindingType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalFindingType unmarshals an instance of FindingType from the specified map of raw messages.

func UnmarshalKpi 

func UnmarshalKpi(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalKpi unmarshals an instance of Kpi from the specified map of raw messages.

func UnmarshalKpiType 

func UnmarshalKpiType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalKpiType unmarshals an instance of KpiType from the specified map of raw messages.

func UnmarshalNetworkConnection 

func UnmarshalNetworkConnection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNetworkConnection unmarshals an instance of NetworkConnection from the specified map of raw messages.

func UnmarshalNumericCardElementValueType 

func UnmarshalNumericCardElementValueType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalNumericCardElementValueType unmarshals an instance of NumericCardElementValueType from the specified map of raw messages.

func UnmarshalRemediationStep 

func UnmarshalRemediationStep(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRemediationStep unmarshals an instance of RemediationStep from the specified map of raw messages.

func UnmarshalReporter 

func UnmarshalReporter(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalReporter unmarshals an instance of Reporter from the specified map of raw messages.

func UnmarshalSection 

func UnmarshalSection(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSection unmarshals an instance of Section from the specified map of raw messages.

func UnmarshalSocketAddress 

func UnmarshalSocketAddress(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSocketAddress unmarshals an instance of SocketAddress from the specified map of raw messages.

func UnmarshalValueType 

func UnmarshalValueType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalValueType unmarshals an instance of ValueType from the specified map of raw messages.

func UnmarshalValueTypeFindingCountValueType 

func UnmarshalValueTypeFindingCountValueType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalValueTypeFindingCountValueType unmarshals an instance of ValueTypeFindingCountValueType from the specified map of raw messages.

func UnmarshalValueTypeKpiValueType 

func UnmarshalValueTypeKpiValueType(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalValueTypeKpiValueType unmarshals an instance of ValueTypeKpiValueType from the specified map of raw messages.

Types

type APIListNoteOccurrencesResponse 

type APIListNoteOccurrencesResponse struct {
	// The occurrences attached to the specified note.
	Occurrences []APIOccurrence `json:"occurrences,omitempty"`

	// Token to receive the next page of notes.
	NextPageToken *string `json:"next_page_token,omitempty"`
}

APIListNoteOccurrencesResponse : Response including listed occurrences for a note.

type APIListNotesResponse 

type APIListNotesResponse struct {
	// The occurrences requested.
	Notes []APINote `json:"notes,omitempty"`

	// The next pagination token in the list response. It should be used as page_token for the following request. An empty
	// value means no more result.
	NextPageToken *string `json:"next_page_token,omitempty"`
}

APIListNotesResponse : Response including listed notes.

type APIListOccurrencesResponse 

type APIListOccurrencesResponse struct {
	// The occurrences requested.
	Occurrences []APIOccurrence `json:"occurrences,omitempty"`

	// The next pagination token in the list response. It should be used as
	// `page_token` for the following request. An empty value means no more results.
	NextPageToken *string `json:"next_page_token,omitempty"`
}

APIListOccurrencesResponse : Response including listed active occurrences.

type APIListProvidersResponse 

type APIListProvidersResponse struct {
	// The providers requested.
	Providers []APIProvider `json:"providers,omitempty"`

	// The number of elements returned in the current instance. The default is 200.
	Limit *int64 `json:"limit,omitempty"`

	// The offset is the index of the item from which you want to start returning data from. The default is 0.
	Skip *int64 `json:"skip,omitempty"`

	// The total number of providers available.
	TotalCount *int64 `json:"total_count,omitempty"`
}

APIListProvidersResponse : A list of providers is returned.

type APINote 

type APINote struct {
	// A one sentence description of your note.
	ShortDescription *string `json:"short_description" validate:"required"`

	// A more detailed description of your note.
	LongDescription *string `json:"long_description" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	RelatedURL []APINoteRelatedURL `json:"related_url,omitempty"`

	// Output only. The time this note was created. This field can be used as a filter in list requests.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this note was last updated. This field can be used as a filter in list requests.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	// The ID of the note.
	ID *string `json:"id" validate:"required"`

	// True if this note can be shared by multiple accounts.
	Shared *bool `json:"shared,omitempty"`

	// The entity reporting a note.
	ReportedBy *Reporter `json:"reported_by" validate:"required"`

	// FindingType provides details about a finding note.
	Finding *FindingType `json:"finding,omitempty"`

	// KpiType provides details about a KPI note.
	Kpi *KpiType `json:"kpi,omitempty"`

	// Card provides details about a card kind of note.
	Card *Card `json:"card,omitempty"`

	// Card provides details about a card kind of note.
	Section *Section `json:"section,omitempty"`
}

APINote : Provides a detailed description of a note.

type APINoteRelatedURL 

type APINoteRelatedURL struct {
	// Label to describe usage of the URL.
	Label *string `json:"label" validate:"required"`

	// The URL that you want to associate with the note.
	URL *string `json:"url" validate:"required"`
}

APINoteRelatedURL : Metadata for any related URL information.

type APIOccurrence 

type APIOccurrence struct {
	// The unique URL of the resource, image or the container, for which the `Occurrence` applies. For example,
	// https://gcr.io/provider/image@sha256:foo. This field can be used as a filter in list requests.
	ResourceURL *string `json:"resource_url,omitempty"`

	// An analysis note associated with this image, in the form "{account_id}/providers/{provider_id}/notes/{note_id}" This
	// field can be used as a filter in list requests.
	NoteName *string `json:"note_name" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	// A description of actions that can be taken to remedy the `Note`.
	Remediation *string `json:"remediation,omitempty"`

	// Output only. The time this `Occurrence` was created.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this `Occurrence` was last updated.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	// The id of the occurrence.
	ID *string `json:"id" validate:"required"`

	Context *Context `json:"context,omitempty"`

	// Finding provides details about a finding occurrence.
	Finding *Finding `json:"finding,omitempty"`

	// Kpi provides details about a KPI occurrence.
	Kpi *Kpi `json:"kpi,omitempty"`

	// Additional data for the finding, like AT event etc.
	ReferenceData interface{} `json:"reference_data,omitempty"`
}

APIOccurrence : `Occurrence` includes information about analysis occurrences for an image.

type APIProvider 

type APIProvider struct {
	// The name of the provider in the form '{account_id}/providers/{provider_id}'.
	Name *string `json:"name" validate:"required"`

	// The ID of the provider.
	ID *string `json:"id" validate:"required"`
}

APIProvider : Provides a detailed description of a provider.

type Card 

type Card struct {
	// The section this card belongs to.
	Section *string `json:"section" validate:"required"`

	// The title of this card.
	Title *string `json:"title" validate:"required"`

	// The subtitle of this card.
	Subtitle *string `json:"subtitle" validate:"required"`

	// The order of the card in which it will appear on SA dashboard in the mentioned section.
	Order *int64 `json:"order,omitempty"`

	// The finding note names associated to this card.
	FindingNoteNames []string `json:"finding_note_names" validate:"required"`

	RequiresConfiguration *bool `json:"requires_configuration,omitempty"`

	// The text associated to the card's badge.
	BadgeText *string `json:"badge_text,omitempty"`

	// The base64 content of the image associated to the card's badge.
	BadgeImage *string `json:"badge_image,omitempty"`

	// The elements of this card.
	Elements []CardElementIntf `json:"elements" validate:"required"`
}

Card : Card provides details about a card kind of note.

type CardElement 

type CardElement struct {
	// The text of this card element.
	Text *string `json:"text,omitempty"`

	// Kind of element
	// - NUMERIC: Single numeric value
	// - BREAKDOWN: Breakdown of numeric values
	// - TIME_SERIES: Time-series of numeric values.
	Kind *string `json:"kind,omitempty"`

	// The default time range of this card element.
	DefaultTimeRange *string `json:"default_time_range,omitempty"`

	ValueType *NumericCardElementValueType `json:"value_type,omitempty"`

	// the value types associated to this card element.
	ValueTypes []ValueTypeIntf `json:"value_types,omitempty"`

	// The default interval of the time series.
	DefaultInterval *string `json:"default_interval,omitempty"`
}

CardElement : CardElement provides details about the elements of a Card. Models which "extend" this model: - CardElementNumericCardElement - CardElementBreakdownCardElement - CardElementTimeSeriesCardElement

type CardElementBreakdownCardElement 

type CardElementBreakdownCardElement struct {
	// The text of this card element.
	Text *string `json:"text" validate:"required"`

	// Kind of element
	// - NUMERIC: Single numeric value
	// - BREAKDOWN: Breakdown of numeric values
	// - TIME_SERIES: Time-series of numeric values.
	Kind *string `json:"kind" validate:"required"`

	// The default time range of this card element.
	DefaultTimeRange *string `json:"default_time_range,omitempty"`

	// the value types associated to this card element.
	ValueTypes []ValueTypeIntf `json:"value_types" validate:"required"`
}

CardElementBreakdownCardElement : A card element with a breakdown of values. This model "extends" CardElement

type CardElementIntf 

type CardElementIntf interface {
	// contains filtered or unexported methods
}

type CardElementNumericCardElement 

type CardElementNumericCardElement struct {
	// The text of this card element.
	Text *string `json:"text" validate:"required"`

	// Kind of element
	// - NUMERIC: Single numeric value
	// - BREAKDOWN: Breakdown of numeric values
	// - TIME_SERIES: Time-series of numeric values.
	Kind *string `json:"kind" validate:"required"`

	// The default time range of this card element.
	DefaultTimeRange *string `json:"default_time_range,omitempty"`

	ValueType *NumericCardElementValueType `json:"value_type" validate:"required"`
}

CardElementNumericCardElement : A card element with a single numeric value". This model "extends" CardElement

type CardElementTimeSeriesCardElement 

type CardElementTimeSeriesCardElement struct {
	// The text of this card element.
	Text *string `json:"text" validate:"required"`

	// The default interval of the time series.
	DefaultInterval *string `json:"default_interval,omitempty"`

	// Kind of element
	// - NUMERIC: Single numeric value
	// - BREAKDOWN: Breakdown of numeric values
	// - TIME_SERIES: Time-series of numeric values.
	Kind *string `json:"kind" validate:"required"`

	// The default time range of this card element.
	DefaultTimeRange *string `json:"default_time_range,omitempty"`

	// the value types associated to this card element.
	ValueTypes []ValueTypeIntf `json:"value_types" validate:"required"`
}

CardElementTimeSeriesCardElement : A card element with a time series chart. This model "extends" CardElement

type Context 

type Context struct {
	// The IBM Cloud region.
	Region *string `json:"region,omitempty"`

	// The resource CRN (e.g. certificate CRN, image CRN).
	ResourceCRN *string `json:"resource_crn,omitempty"`

	// The resource ID, in case the CRN is not available.
	ResourceID *string `json:"resource_id,omitempty"`

	// The user-friendly resource name.
	ResourceName *string `json:"resource_name,omitempty"`

	// The resource type name (e.g. Pod, Cluster, Certificate, Image).
	ResourceType *string `json:"resource_type,omitempty"`

	// The service CRN (e.g. CertMgr Instance CRN).
	ServiceCRN *string `json:"service_crn,omitempty"`

	// The service name (e.g. CertMgr).
	ServiceName *string `json:"service_name,omitempty"`

	// The name of the environment the occurrence applies to.
	EnvironmentName *string `json:"environment_name,omitempty"`

	// The name of the component the occurrence applies to.
	ComponentName *string `json:"component_name,omitempty"`

	// The id of the toolchain the occurrence applies to.
	ToolchainID *string `json:"toolchain_id,omitempty"`
}

Context : Context struct

type CreateNoteOptions 

type CreateNoteOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// A one sentence description of your note.
	ShortDescription *string `json:"short_description" validate:"required"`

	// A more detailed description of your note.
	LongDescription *string `json:"long_description" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	// The ID of the note.
	ID *string `json:"id" validate:"required"`

	// The entity reporting a note.
	ReportedBy *Reporter `json:"reported_by" validate:"required"`

	RelatedURL []APINoteRelatedURL `json:"related_url,omitempty"`

	// Output only. The time this note was created. This field can be used as a filter in list requests.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this note was last updated. This field can be used as a filter in list requests.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	// True if this note can be shared by multiple accounts.
	Shared *bool `json:"shared,omitempty"`

	// FindingType provides details about a finding note.
	Finding *FindingType `json:"finding,omitempty"`

	// KpiType provides details about a KPI note.
	Kpi *KpiType `json:"kpi,omitempty"`

	// Card provides details about a card kind of note.
	Card *Card `json:"card,omitempty"`

	// Card provides details about a card kind of note.
	Section *Section `json:"section,omitempty"`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateNoteOptions : The CreateNote options.

func (*CreateNoteOptions) SetCard 

func (_options *CreateNoteOptions) SetCard(card *Card) *CreateNoteOptions

SetCard : Allow user to set Card

func (*CreateNoteOptions) SetCreateTime added in v1.2.1 

func (_options *CreateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *CreateNoteOptions

SetCreateTime : Allow user to set CreateTime

func (*CreateNoteOptions) SetFinding 

func (_options *CreateNoteOptions) SetFinding(finding *FindingType) *CreateNoteOptions

SetFinding : Allow user to set Finding

func (*CreateNoteOptions) SetHeaders 

func (options *CreateNoteOptions) SetHeaders(param map[string]string) *CreateNoteOptions

SetHeaders : Allow user to set Headers

func (*CreateNoteOptions) SetID 

func (_options *CreateNoteOptions) SetID(id string) *CreateNoteOptions

SetID : Allow user to set ID

func (*CreateNoteOptions) SetKind 

func (_options *CreateNoteOptions) SetKind(kind string) *CreateNoteOptions

SetKind : Allow user to set Kind

func (*CreateNoteOptions) SetKpi 

func (_options *CreateNoteOptions) SetKpi(kpi *KpiType) *CreateNoteOptions

SetKpi : Allow user to set Kpi

func (*CreateNoteOptions) SetLongDescription 

func (_options *CreateNoteOptions) SetLongDescription(longDescription string) *CreateNoteOptions

SetLongDescription : Allow user to set LongDescription

func (*CreateNoteOptions) SetProviderID 

func (_options *CreateNoteOptions) SetProviderID(providerID string) *CreateNoteOptions

SetProviderID : Allow user to set ProviderID

func (*CreateNoteOptions) SetRelatedURL 

func (_options *CreateNoteOptions) SetRelatedURL(relatedURL []APINoteRelatedURL) *CreateNoteOptions

SetRelatedURL : Allow user to set RelatedURL

func (*CreateNoteOptions) SetReportedBy 

func (_options *CreateNoteOptions) SetReportedBy(reportedBy *Reporter) *CreateNoteOptions

SetReportedBy : Allow user to set ReportedBy

func (*CreateNoteOptions) SetSection 

func (_options *CreateNoteOptions) SetSection(section *Section) *CreateNoteOptions

SetSection : Allow user to set Section

func (*CreateNoteOptions) SetShared 

func (_options *CreateNoteOptions) SetShared(shared bool) *CreateNoteOptions

SetShared : Allow user to set Shared

func (*CreateNoteOptions) SetShortDescription 

func (_options *CreateNoteOptions) SetShortDescription(shortDescription string) *CreateNoteOptions

SetShortDescription : Allow user to set ShortDescription

func (*CreateNoteOptions) SetTransactionID 

func (_options *CreateNoteOptions) SetTransactionID(transactionID string) *CreateNoteOptions

SetTransactionID : Allow user to set TransactionID

func (*CreateNoteOptions) SetUpdateTime added in v1.2.1 

func (_options *CreateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *CreateNoteOptions

SetUpdateTime : Allow user to set UpdateTime

type CreateOccurrenceOptions 

type CreateOccurrenceOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// An analysis note associated with this image, in the form "{account_id}/providers/{provider_id}/notes/{note_id}" This
	// field can be used as a filter in list requests.
	NoteName *string `json:"note_name" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	// The id of the occurrence.
	ID *string `json:"id" validate:"required"`

	// The unique URL of the resource, image or the container, for which the `Occurrence` applies. For example,
	// https://gcr.io/provider/image@sha256:foo. This field can be used as a filter in list requests.
	ResourceURL *string `json:"resource_url,omitempty"`

	// A description of actions that can be taken to remedy the `Note`.
	Remediation *string `json:"remediation,omitempty"`

	// Output only. The time this `Occurrence` was created.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this `Occurrence` was last updated.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	Context *Context `json:"context,omitempty"`

	// Finding provides details about a finding occurrence.
	Finding *Finding `json:"finding,omitempty"`

	// Kpi provides details about a KPI occurrence.
	Kpi *Kpi `json:"kpi,omitempty"`

	// Additional data for the finding, like AT event etc.
	ReferenceData interface{} `json:"reference_data,omitempty"`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// When set to true, an existing occurrence is replaced rather than duplicated.
	ReplaceIfExists *bool `json:"Replace-If-Exists,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateOccurrenceOptions : The CreateOccurrence options.

func (*CreateOccurrenceOptions) SetContext 

func (_options *CreateOccurrenceOptions) SetContext(context *Context) *CreateOccurrenceOptions

SetContext : Allow user to set Context

func (*CreateOccurrenceOptions) SetCreateTime added in v1.3.3 

func (_options *CreateOccurrenceOptions) SetCreateTime(createTime *strfmt.DateTime) *CreateOccurrenceOptions

SetCreateTime : Allow user to set CreateTime

func (*CreateOccurrenceOptions) SetFinding 

func (_options *CreateOccurrenceOptions) SetFinding(finding *Finding) *CreateOccurrenceOptions

SetFinding : Allow user to set Finding

func (*CreateOccurrenceOptions) SetHeaders 

func (options *CreateOccurrenceOptions) SetHeaders(param map[string]string) *CreateOccurrenceOptions

SetHeaders : Allow user to set Headers

func (*CreateOccurrenceOptions) SetID 

func (_options *CreateOccurrenceOptions) SetID(id string) *CreateOccurrenceOptions

SetID : Allow user to set ID

func (*CreateOccurrenceOptions) SetKind 

func (_options *CreateOccurrenceOptions) SetKind(kind string) *CreateOccurrenceOptions

SetKind : Allow user to set Kind

func (*CreateOccurrenceOptions) SetKpi 

func (_options *CreateOccurrenceOptions) SetKpi(kpi *Kpi) *CreateOccurrenceOptions

SetKpi : Allow user to set Kpi

func (*CreateOccurrenceOptions) SetNoteName 

func (_options *CreateOccurrenceOptions) SetNoteName(noteName string) *CreateOccurrenceOptions

SetNoteName : Allow user to set NoteName

func (*CreateOccurrenceOptions) SetProviderID 

func (_options *CreateOccurrenceOptions) SetProviderID(providerID string) *CreateOccurrenceOptions

SetProviderID : Allow user to set ProviderID

func (*CreateOccurrenceOptions) SetReferenceData 

func (_options *CreateOccurrenceOptions) SetReferenceData(referenceData interface{}) *CreateOccurrenceOptions

SetReferenceData : Allow user to set ReferenceData

func (*CreateOccurrenceOptions) SetRemediation 

func (_options *CreateOccurrenceOptions) SetRemediation(remediation string) *CreateOccurrenceOptions

SetRemediation : Allow user to set Remediation

func (*CreateOccurrenceOptions) SetReplaceIfExists 

func (_options *CreateOccurrenceOptions) SetReplaceIfExists(replaceIfExists bool) *CreateOccurrenceOptions

SetReplaceIfExists : Allow user to set ReplaceIfExists

func (*CreateOccurrenceOptions) SetResourceURL 

func (_options *CreateOccurrenceOptions) SetResourceURL(resourceURL string) *CreateOccurrenceOptions

SetResourceURL : Allow user to set ResourceURL

func (*CreateOccurrenceOptions) SetTransactionID 

func (_options *CreateOccurrenceOptions) SetTransactionID(transactionID string) *CreateOccurrenceOptions

SetTransactionID : Allow user to set TransactionID

func (*CreateOccurrenceOptions) SetUpdateTime added in v1.3.3 

func (_options *CreateOccurrenceOptions) SetUpdateTime(updateTime *strfmt.DateTime) *CreateOccurrenceOptions

SetUpdateTime : Allow user to set UpdateTime

type DataTransferred 

type DataTransferred struct {
	// The number of client bytes transferred.
	ClientBytes *int64 `json:"client_bytes,omitempty"`

	// The number of server bytes transferred.
	ServerBytes *int64 `json:"server_bytes,omitempty"`

	// The number of client packets transferred.
	ClientPackets *int64 `json:"client_packets,omitempty"`

	// The number of server packets transferred.
	ServerPackets *int64 `json:"server_packets,omitempty"`
}

DataTransferred : It provides details about data transferred between clients and servers.

type DeleteNoteOptions 

type DeleteNoteOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of note `name`: providers/{provider_id}/notes/{note_id}.
	NoteID *string `json:"note_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteNoteOptions : The DeleteNote options.

func (*DeleteNoteOptions) SetHeaders 

func (options *DeleteNoteOptions) SetHeaders(param map[string]string) *DeleteNoteOptions

SetHeaders : Allow user to set Headers

func (*DeleteNoteOptions) SetNoteID 

func (_options *DeleteNoteOptions) SetNoteID(noteID string) *DeleteNoteOptions

SetNoteID : Allow user to set NoteID

func (*DeleteNoteOptions) SetProviderID 

func (_options *DeleteNoteOptions) SetProviderID(providerID string) *DeleteNoteOptions

SetProviderID : Allow user to set ProviderID

func (*DeleteNoteOptions) SetTransactionID 

func (_options *DeleteNoteOptions) SetTransactionID(transactionID string) *DeleteNoteOptions

SetTransactionID : Allow user to set TransactionID

type DeleteOccurrenceOptions 

type DeleteOccurrenceOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}.
	OccurrenceID *string `json:"occurrence_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteOccurrenceOptions : The DeleteOccurrence options.

func (*DeleteOccurrenceOptions) SetHeaders 

func (options *DeleteOccurrenceOptions) SetHeaders(param map[string]string) *DeleteOccurrenceOptions

SetHeaders : Allow user to set Headers

func (*DeleteOccurrenceOptions) SetOccurrenceID 

func (_options *DeleteOccurrenceOptions) SetOccurrenceID(occurrenceID string) *DeleteOccurrenceOptions

SetOccurrenceID : Allow user to set OccurrenceID

func (*DeleteOccurrenceOptions) SetProviderID 

func (_options *DeleteOccurrenceOptions) SetProviderID(providerID string) *DeleteOccurrenceOptions

SetProviderID : Allow user to set ProviderID

func (*DeleteOccurrenceOptions) SetTransactionID 

func (_options *DeleteOccurrenceOptions) SetTransactionID(transactionID string) *DeleteOccurrenceOptions

SetTransactionID : Allow user to set TransactionID

type Finding 

type Finding struct {
	// Note provider-assigned severity/impact ranking
	// - LOW: Low Impact
	// - MEDIUM: Medium Impact
	// - HIGH: High Impact
	// - CRITICAL: Critical Impact.
	Severity *string `json:"severity,omitempty"`

	// Note provider-assigned confidence on the validity of an occurrence
	// - LOW: Low Certainty
	// - MEDIUM: Medium Certainty
	// - HIGH: High Certainty.
	Certainty *string `json:"certainty,omitempty"`

	// Remediation steps for the issues reported in this finding. They override the note's next steps.
	NextSteps []RemediationStep `json:"next_steps,omitempty"`

	// It provides details about a network connection.
	NetworkConnection *NetworkConnection `json:"network_connection,omitempty"`

	// It provides details about data transferred between clients and servers.
	DataTransferred *DataTransferred `json:"data_transferred,omitempty"`
}

Finding : Finding provides details about a finding occurrence.

type FindingType 

type FindingType struct {
	// Note provider-assigned severity/impact ranking
	// - LOW: Low Impact
	// - MEDIUM: Medium Impact
	// - HIGH: High Impact
	// - CRITICAL: Critical Impact.
	Severity *string `json:"severity" validate:"required"`

	// Common remediation steps for the finding of this type.
	NextSteps []RemediationStep `json:"next_steps,omitempty"`
}

FindingType : FindingType provides details about a finding note.

type FindingsV1 

type FindingsV1 struct {
	Service *core.BaseService

	// Account ID.
	AccountID *string
}

FindingsV1 : The Findings API is used to find and display occurrences of security issues in your IBM Cloud account by using the artifact metadata specification. Findings are summarized in cards in the Security and Compliance Center that allow you to see the security status of your account at a glance and start an investigation into any potential issues.

API Version: 1.0.0

func NewFindingsV1 

func NewFindingsV1(options *FindingsV1Options) (service *FindingsV1, err error)

NewFindingsV1 : constructs an instance of FindingsV1 with passed in options.

func NewFindingsV1UsingExternalConfig 

func NewFindingsV1UsingExternalConfig(options *FindingsV1Options) (findings *FindingsV1, err error)

NewFindingsV1UsingExternalConfig : constructs an instance of FindingsV1 with passed in options and external configuration.

func (*FindingsV1) Clone 

func (findings *FindingsV1) Clone() *FindingsV1

Clone makes a copy of "findings" suitable for processing requests.

func (*FindingsV1) CreateNote 

func (findings *FindingsV1) CreateNote(createNoteOptions *CreateNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

CreateNote : Create a note Register a new finding type with the Security and Compliance Center.

A successful request creates a note with a high-level description of a particular type of finding. To learn more about creating notes to register findings, see [Custom findings](/docs/security-advisor?topic=security-advisor-setup_custom).

func (*FindingsV1) CreateNoteWithContext 

func (findings *FindingsV1) CreateNoteWithContext(ctx context.Context, createNoteOptions *CreateNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

CreateNoteWithContext is an alternate form of the CreateNote method which supports a Context parameter

func (*FindingsV1) CreateOccurrence 

func (findings *FindingsV1) CreateOccurrence(createOccurrenceOptions *CreateOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

CreateOccurrence : Create an occurrence Create an occurrence to denote the existence of a particular type of finding.

An occurrence describes provider-specific details of a note and contains vulnerability details, remediation steps, and other general information.

func (*FindingsV1) CreateOccurrenceWithContext 

func (findings *FindingsV1) CreateOccurrenceWithContext(ctx context.Context, createOccurrenceOptions *CreateOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

CreateOccurrenceWithContext is an alternate form of the CreateOccurrence method which supports a Context parameter

func (*FindingsV1) DeleteNote 

func (findings *FindingsV1) DeleteNote(deleteNoteOptions *DeleteNoteOptions) (response *core.DetailedResponse, err error)

DeleteNote : Delete a note Delete a note with the ID and provider ID that you specify.

func (*FindingsV1) DeleteNoteWithContext 

func (findings *FindingsV1) DeleteNoteWithContext(ctx context.Context, deleteNoteOptions *DeleteNoteOptions) (response *core.DetailedResponse, err error)

DeleteNoteWithContext is an alternate form of the DeleteNote method which supports a Context parameter

func (*FindingsV1) DeleteOccurrence 

func (findings *FindingsV1) DeleteOccurrence(deleteOccurrenceOptions *DeleteOccurrenceOptions) (response *core.DetailedResponse, err error)

DeleteOccurrence : Delete an occurrence Delete an occurrence by specifying the occurrence ID and provider ID.

func (*FindingsV1) DeleteOccurrenceWithContext 

func (findings *FindingsV1) DeleteOccurrenceWithContext(ctx context.Context, deleteOccurrenceOptions *DeleteOccurrenceOptions) (response *core.DetailedResponse, err error)

DeleteOccurrenceWithContext is an alternate form of the DeleteOccurrence method which supports a Context parameter

func (*FindingsV1) DisableRetries 

func (findings *FindingsV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*FindingsV1) EnableRetries 

func (findings *FindingsV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*FindingsV1) GetEnableGzipCompression 

func (findings *FindingsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*FindingsV1) GetNote 

func (findings *FindingsV1) GetNote(getNoteOptions *GetNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

GetNote : Get a note by provider Get the details of the note that is associated with a specified note ID and provider ID.

func (*FindingsV1) GetNoteWithContext 

func (findings *FindingsV1) GetNoteWithContext(ctx context.Context, getNoteOptions *GetNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

GetNoteWithContext is an alternate form of the GetNote method which supports a Context parameter

func (*FindingsV1) GetOccurrence 

func (findings *FindingsV1) GetOccurrence(getOccurrenceOptions *GetOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

GetOccurrence : Get a specific occurrence Get the details of a specific occurrence by specifying the ID and provider ID.

func (*FindingsV1) GetOccurrenceNote 

func (findings *FindingsV1) GetOccurrenceNote(getOccurrenceNoteOptions *GetOccurrenceNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

GetOccurrenceNote : Get a note by occurrence Get a note that is associated with the occurrence ID that you specify.

func (*FindingsV1) GetOccurrenceNoteWithContext 

func (findings *FindingsV1) GetOccurrenceNoteWithContext(ctx context.Context, getOccurrenceNoteOptions *GetOccurrenceNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

GetOccurrenceNoteWithContext is an alternate form of the GetOccurrenceNote method which supports a Context parameter

func (*FindingsV1) GetOccurrenceWithContext 

func (findings *FindingsV1) GetOccurrenceWithContext(ctx context.Context, getOccurrenceOptions *GetOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

GetOccurrenceWithContext is an alternate form of the GetOccurrence method which supports a Context parameter

func (*FindingsV1) GetServiceURL 

func (findings *FindingsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*FindingsV1) ListNoteOccurrences 

func (findings *FindingsV1) ListNoteOccurrences(listNoteOccurrencesOptions *ListNoteOccurrencesOptions) (result *APIListNoteOccurrencesResponse, response *core.DetailedResponse, err error)

ListNoteOccurrences : List occurrences by note Get a list of occurrences that are associated with a specific note.

func (*FindingsV1) ListNoteOccurrencesWithContext 

func (findings *FindingsV1) ListNoteOccurrencesWithContext(ctx context.Context, listNoteOccurrencesOptions *ListNoteOccurrencesOptions) (result *APIListNoteOccurrencesResponse, response *core.DetailedResponse, err error)

ListNoteOccurrencesWithContext is an alternate form of the ListNoteOccurrences method which supports a Context parameter

func (*FindingsV1) ListNotes 

func (findings *FindingsV1) ListNotes(listNotesOptions *ListNotesOptions) (result *APIListNotesResponse, response *core.DetailedResponse, err error)

ListNotes : List notes List all of the available notes for a specific provider.

func (*FindingsV1) ListNotesWithContext 

func (findings *FindingsV1) ListNotesWithContext(ctx context.Context, listNotesOptions *ListNotesOptions) (result *APIListNotesResponse, response *core.DetailedResponse, err error)

ListNotesWithContext is an alternate form of the ListNotes method which supports a Context parameter

func (*FindingsV1) ListOccurrences 

func (findings *FindingsV1) ListOccurrences(listOccurrencesOptions *ListOccurrencesOptions) (result *APIListOccurrencesResponse, response *core.DetailedResponse, err error)

ListOccurrences : List occurrences List all of the occurrences that are associated with the provider ID that you specify.

func (*FindingsV1) ListOccurrencesWithContext 

func (findings *FindingsV1) ListOccurrencesWithContext(ctx context.Context, listOccurrencesOptions *ListOccurrencesOptions) (result *APIListOccurrencesResponse, response *core.DetailedResponse, err error)

ListOccurrencesWithContext is an alternate form of the ListOccurrences method which supports a Context parameter

func (*FindingsV1) ListProviders 

func (findings *FindingsV1) ListProviders(listProvidersOptions *ListProvidersOptions) (result *APIListProvidersResponse, response *core.DetailedResponse, err error)

ListProviders : List providers List all of the providers for a specified account.

func (*FindingsV1) ListProvidersWithContext 

func (findings *FindingsV1) ListProvidersWithContext(ctx context.Context, listProvidersOptions *ListProvidersOptions) (result *APIListProvidersResponse, response *core.DetailedResponse, err error)

ListProvidersWithContext is an alternate form of the ListProviders method which supports a Context parameter

func (*FindingsV1) NewAPINote 

func (*FindingsV1) NewAPINote(shortDescription string, longDescription string, kind string, id string, reportedBy *Reporter) (_model *APINote, err error)

NewAPINote : Instantiate APINote (Generic Model Constructor)

func (*FindingsV1) NewAPINoteRelatedURL 

func (*FindingsV1) NewAPINoteRelatedURL(label string, url string) (_model *APINoteRelatedURL, err error)

NewAPINoteRelatedURL : Instantiate APINoteRelatedURL (Generic Model Constructor)

func (*FindingsV1) NewAPIOccurrence 

func (*FindingsV1) NewAPIOccurrence(noteName string, kind string, id string) (_model *APIOccurrence, err error)

NewAPIOccurrence : Instantiate APIOccurrence (Generic Model Constructor)

func (*FindingsV1) NewCard 

func (*FindingsV1) NewCard(section string, title string, subtitle string, findingNoteNames []string, elements []CardElementIntf) (_model *Card, err error)

NewCard : Instantiate Card (Generic Model Constructor)

func (*FindingsV1) NewCardElementBreakdownCardElement 

func (*FindingsV1) NewCardElementBreakdownCardElement(text string, kind string, valueTypes []ValueTypeIntf) (_model *CardElementBreakdownCardElement, err error)

NewCardElementBreakdownCardElement : Instantiate CardElementBreakdownCardElement (Generic Model Constructor)

func (*FindingsV1) NewCardElementNumericCardElement 

func (*FindingsV1) NewCardElementNumericCardElement(text string, kind string, valueType *NumericCardElementValueType) (_model *CardElementNumericCardElement, err error)

NewCardElementNumericCardElement : Instantiate CardElementNumericCardElement (Generic Model Constructor)

func (*FindingsV1) NewCardElementTimeSeriesCardElement 

func (*FindingsV1) NewCardElementTimeSeriesCardElement(text string, kind string, valueTypes []ValueTypeIntf) (_model *CardElementTimeSeriesCardElement, err error)

NewCardElementTimeSeriesCardElement : Instantiate CardElementTimeSeriesCardElement (Generic Model Constructor)

func (*FindingsV1) NewCreateNoteOptions 

func (*FindingsV1) NewCreateNoteOptions(providerID string, shortDescription string, longDescription string, kind string, id string, reportedBy *Reporter) *CreateNoteOptions

NewCreateNoteOptions : Instantiate CreateNoteOptions

func (*FindingsV1) NewCreateOccurrenceOptions 

func (*FindingsV1) NewCreateOccurrenceOptions(providerID string, noteName string, kind string, id string) *CreateOccurrenceOptions

NewCreateOccurrenceOptions : Instantiate CreateOccurrenceOptions

func (*FindingsV1) NewDeleteNoteOptions 

func (*FindingsV1) NewDeleteNoteOptions(providerID string, noteID string) *DeleteNoteOptions

NewDeleteNoteOptions : Instantiate DeleteNoteOptions

func (*FindingsV1) NewDeleteOccurrenceOptions 

func (*FindingsV1) NewDeleteOccurrenceOptions(providerID string, occurrenceID string) *DeleteOccurrenceOptions

NewDeleteOccurrenceOptions : Instantiate DeleteOccurrenceOptions

func (*FindingsV1) NewFindingType 

func (*FindingsV1) NewFindingType(severity string) (_model *FindingType, err error)

NewFindingType : Instantiate FindingType (Generic Model Constructor)

func (*FindingsV1) NewGetNoteOptions 

func (*FindingsV1) NewGetNoteOptions(providerID string, noteID string) *GetNoteOptions

NewGetNoteOptions : Instantiate GetNoteOptions

func (*FindingsV1) NewGetOccurrenceNoteOptions 

func (*FindingsV1) NewGetOccurrenceNoteOptions(providerID string, occurrenceID string) *GetOccurrenceNoteOptions

NewGetOccurrenceNoteOptions : Instantiate GetOccurrenceNoteOptions

func (*FindingsV1) NewGetOccurrenceOptions 

func (*FindingsV1) NewGetOccurrenceOptions(providerID string, occurrenceID string) *GetOccurrenceOptions

NewGetOccurrenceOptions : Instantiate GetOccurrenceOptions

func (*FindingsV1) NewKpi 

func (*FindingsV1) NewKpi(value float64) (_model *Kpi, err error)

NewKpi : Instantiate Kpi (Generic Model Constructor)

func (*FindingsV1) NewKpiType 

func (*FindingsV1) NewKpiType(aggregationType string) (_model *KpiType, err error)

NewKpiType : Instantiate KpiType (Generic Model Constructor)

func (*FindingsV1) NewListNoteOccurrencesOptions 

func (*FindingsV1) NewListNoteOccurrencesOptions(providerID string, noteID string) *ListNoteOccurrencesOptions

NewListNoteOccurrencesOptions : Instantiate ListNoteOccurrencesOptions

func (*FindingsV1) NewListNotesOptions 

func (*FindingsV1) NewListNotesOptions(providerID string) *ListNotesOptions

NewListNotesOptions : Instantiate ListNotesOptions

func (*FindingsV1) NewListOccurrencesOptions 

func (*FindingsV1) NewListOccurrencesOptions(providerID string) *ListOccurrencesOptions

NewListOccurrencesOptions : Instantiate ListOccurrencesOptions

func (*FindingsV1) NewListProvidersOptions 

func (*FindingsV1) NewListProvidersOptions() *ListProvidersOptions

NewListProvidersOptions : Instantiate ListProvidersOptions

func (*FindingsV1) NewPostGraphOptions 

func (*FindingsV1) NewPostGraphOptions() *PostGraphOptions

NewPostGraphOptions : Instantiate PostGraphOptions

func (*FindingsV1) NewReporter 

func (*FindingsV1) NewReporter(id string, title string) (_model *Reporter, err error)

NewReporter : Instantiate Reporter (Generic Model Constructor)

func (*FindingsV1) NewSection 

func (*FindingsV1) NewSection(title string, image string) (_model *Section, err error)

NewSection : Instantiate Section (Generic Model Constructor)

func (*FindingsV1) NewSocketAddress 

func (*FindingsV1) NewSocketAddress(address string) (_model *SocketAddress, err error)

NewSocketAddress : Instantiate SocketAddress (Generic Model Constructor)

func (*FindingsV1) NewUpdateNoteOptions 

func (*FindingsV1) NewUpdateNoteOptions(providerID string, noteID string, shortDescription string, longDescription string, kind string, id string, reportedBy *Reporter) *UpdateNoteOptions

NewUpdateNoteOptions : Instantiate UpdateNoteOptions

func (*FindingsV1) NewUpdateOccurrenceOptions 

func (*FindingsV1) NewUpdateOccurrenceOptions(providerID string, occurrenceID string, noteName string, kind string, id string) *UpdateOccurrenceOptions

NewUpdateOccurrenceOptions : Instantiate UpdateOccurrenceOptions

func (*FindingsV1) NewValueTypeFindingCountValueType 

func (*FindingsV1) NewValueTypeFindingCountValueType(kind string, findingNoteNames []string, text string) (_model *ValueTypeFindingCountValueType, err error)

NewValueTypeFindingCountValueType : Instantiate ValueTypeFindingCountValueType (Generic Model Constructor)

func (*FindingsV1) NewValueTypeKpiValueType 

func (*FindingsV1) NewValueTypeKpiValueType(kind string, kpiNoteName string, text string) (_model *ValueTypeKpiValueType, err error)

NewValueTypeKpiValueType : Instantiate ValueTypeKpiValueType (Generic Model Constructor)

func (*FindingsV1) PostGraph 

func (findings *FindingsV1) PostGraph(postGraphOptions *PostGraphOptions) (response *core.DetailedResponse, err error)

PostGraph : Query findings Query findings by using the GraphQL query language. For more information about using GraphQL, see the [GraphQL documentation](https://graphql.org/learn/).

func (*FindingsV1) PostGraphWithContext 

func (findings *FindingsV1) PostGraphWithContext(ctx context.Context, postGraphOptions *PostGraphOptions) (response *core.DetailedResponse, err error)

PostGraphWithContext is an alternate form of the PostGraph method which supports a Context parameter

func (*FindingsV1) SetDefaultHeaders 

func (findings *FindingsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*FindingsV1) SetEnableGzipCompression 

func (findings *FindingsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*FindingsV1) SetServiceURL 

func (findings *FindingsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*FindingsV1) UpdateNote 

func (findings *FindingsV1) UpdateNote(updateNoteOptions *UpdateNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

UpdateNote : Update a note Update a note that already exists in your account.

func (*FindingsV1) UpdateNoteWithContext 

func (findings *FindingsV1) UpdateNoteWithContext(ctx context.Context, updateNoteOptions *UpdateNoteOptions) (result *APINote, response *core.DetailedResponse, err error)

UpdateNoteWithContext is an alternate form of the UpdateNote method which supports a Context parameter

func (*FindingsV1) UpdateOccurrence 

func (findings *FindingsV1) UpdateOccurrence(updateOccurrenceOptions *UpdateOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

UpdateOccurrence : Update an occurrence Update an occurrence that already exists in your account.

func (*FindingsV1) UpdateOccurrenceWithContext 

func (findings *FindingsV1) UpdateOccurrenceWithContext(ctx context.Context, updateOccurrenceOptions *UpdateOccurrenceOptions) (result *APIOccurrence, response *core.DetailedResponse, err error)

UpdateOccurrenceWithContext is an alternate form of the UpdateOccurrence method which supports a Context parameter

type FindingsV1Options 

type FindingsV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator

	// Account ID.
	AccountID *string `validate:"required"`
}

FindingsV1Options : Service options

type GetNoteOptions 

type GetNoteOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of note `name`: providers/{provider_id}/notes/{note_id}.
	NoteID *string `json:"note_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetNoteOptions : The GetNote options.

func (*GetNoteOptions) SetHeaders 

func (options *GetNoteOptions) SetHeaders(param map[string]string) *GetNoteOptions

SetHeaders : Allow user to set Headers

func (*GetNoteOptions) SetNoteID 

func (_options *GetNoteOptions) SetNoteID(noteID string) *GetNoteOptions

SetNoteID : Allow user to set NoteID

func (*GetNoteOptions) SetProviderID 

func (_options *GetNoteOptions) SetProviderID(providerID string) *GetNoteOptions

SetProviderID : Allow user to set ProviderID

func (*GetNoteOptions) SetTransactionID 

func (_options *GetNoteOptions) SetTransactionID(transactionID string) *GetNoteOptions

SetTransactionID : Allow user to set TransactionID

type GetOccurrenceNoteOptions 

type GetOccurrenceNoteOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}.
	OccurrenceID *string `json:"occurrence_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetOccurrenceNoteOptions : The GetOccurrenceNote options.

func (*GetOccurrenceNoteOptions) SetHeaders 

func (options *GetOccurrenceNoteOptions) SetHeaders(param map[string]string) *GetOccurrenceNoteOptions

SetHeaders : Allow user to set Headers

func (*GetOccurrenceNoteOptions) SetOccurrenceID 

func (_options *GetOccurrenceNoteOptions) SetOccurrenceID(occurrenceID string) *GetOccurrenceNoteOptions

SetOccurrenceID : Allow user to set OccurrenceID

func (*GetOccurrenceNoteOptions) SetProviderID 

func (_options *GetOccurrenceNoteOptions) SetProviderID(providerID string) *GetOccurrenceNoteOptions

SetProviderID : Allow user to set ProviderID

func (*GetOccurrenceNoteOptions) SetTransactionID 

func (_options *GetOccurrenceNoteOptions) SetTransactionID(transactionID string) *GetOccurrenceNoteOptions

SetTransactionID : Allow user to set TransactionID

type GetOccurrenceOptions 

type GetOccurrenceOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}.
	OccurrenceID *string `json:"occurrence_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetOccurrenceOptions : The GetOccurrence options.

func (*GetOccurrenceOptions) SetHeaders 

func (options *GetOccurrenceOptions) SetHeaders(param map[string]string) *GetOccurrenceOptions

SetHeaders : Allow user to set Headers

func (*GetOccurrenceOptions) SetOccurrenceID 

func (_options *GetOccurrenceOptions) SetOccurrenceID(occurrenceID string) *GetOccurrenceOptions

SetOccurrenceID : Allow user to set OccurrenceID

func (*GetOccurrenceOptions) SetProviderID 

func (_options *GetOccurrenceOptions) SetProviderID(providerID string) *GetOccurrenceOptions

SetProviderID : Allow user to set ProviderID

func (*GetOccurrenceOptions) SetTransactionID 

func (_options *GetOccurrenceOptions) SetTransactionID(transactionID string) *GetOccurrenceOptions

SetTransactionID : Allow user to set TransactionID

type Kpi 

type Kpi struct {
	// The value of this KPI.
	Value *float64 `json:"value" validate:"required"`

	// The total value of this KPI.
	Total *float64 `json:"total,omitempty"`
}

Kpi : Kpi provides details about a KPI occurrence.

type KpiType 

type KpiType struct {
	Severity *string `json:"Severity,omitempty"`

	// The aggregation type of the KPI values. - SUM: A single-value metrics aggregation type that sums up numeric
	// values
	//   that are extracted from KPI occurrences.
	AggregationType *string `json:"aggregation_type" validate:"required"`
}

KpiType : KpiType provides details about a KPI note.

type ListNoteOccurrencesOptions 

type ListNoteOccurrencesOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of note `name`: providers/{provider_id}/notes/{note_id}.
	NoteID *string `json:"note_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Number of notes to return in the list.
	PageSize *int64 `json:"page_size,omitempty"`

	// Token to provide to skip to a particular spot in the list.
	PageToken *string `json:"page_token,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListNoteOccurrencesOptions : The ListNoteOccurrences options.

func (*ListNoteOccurrencesOptions) SetHeaders 

func (options *ListNoteOccurrencesOptions) SetHeaders(param map[string]string) *ListNoteOccurrencesOptions

SetHeaders : Allow user to set Headers

func (*ListNoteOccurrencesOptions) SetNoteID 

func (_options *ListNoteOccurrencesOptions) SetNoteID(noteID string) *ListNoteOccurrencesOptions

SetNoteID : Allow user to set NoteID

func (*ListNoteOccurrencesOptions) SetPageSize 

func (_options *ListNoteOccurrencesOptions) SetPageSize(pageSize int64) *ListNoteOccurrencesOptions

SetPageSize : Allow user to set PageSize

func (*ListNoteOccurrencesOptions) SetPageToken 

func (_options *ListNoteOccurrencesOptions) SetPageToken(pageToken string) *ListNoteOccurrencesOptions

SetPageToken : Allow user to set PageToken

func (*ListNoteOccurrencesOptions) SetProviderID 

func (_options *ListNoteOccurrencesOptions) SetProviderID(providerID string) *ListNoteOccurrencesOptions

SetProviderID : Allow user to set ProviderID

func (*ListNoteOccurrencesOptions) SetTransactionID 

func (_options *ListNoteOccurrencesOptions) SetTransactionID(transactionID string) *ListNoteOccurrencesOptions

SetTransactionID : Allow user to set TransactionID

type ListNotesOptions 

type ListNotesOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Number of notes to return in the list.
	PageSize *int64 `json:"page_size,omitempty"`

	// Token to provide to skip to a particular spot in the list.
	PageToken *string `json:"page_token,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListNotesOptions : The ListNotes options.

func (*ListNotesOptions) SetHeaders 

func (options *ListNotesOptions) SetHeaders(param map[string]string) *ListNotesOptions

SetHeaders : Allow user to set Headers

func (*ListNotesOptions) SetPageSize 

func (_options *ListNotesOptions) SetPageSize(pageSize int64) *ListNotesOptions

SetPageSize : Allow user to set PageSize

func (*ListNotesOptions) SetPageToken 

func (_options *ListNotesOptions) SetPageToken(pageToken string) *ListNotesOptions

SetPageToken : Allow user to set PageToken

func (*ListNotesOptions) SetProviderID 

func (_options *ListNotesOptions) SetProviderID(providerID string) *ListNotesOptions

SetProviderID : Allow user to set ProviderID

func (*ListNotesOptions) SetTransactionID 

func (_options *ListNotesOptions) SetTransactionID(transactionID string) *ListNotesOptions

SetTransactionID : Allow user to set TransactionID

type ListOccurrencesOptions 

type ListOccurrencesOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Number of notes to return in the list.
	PageSize *int64 `json:"page_size,omitempty"`

	// Token to provide to skip to a particular spot in the list.
	PageToken *string `json:"page_token,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListOccurrencesOptions : The ListOccurrences options.

func (*ListOccurrencesOptions) SetHeaders 

func (options *ListOccurrencesOptions) SetHeaders(param map[string]string) *ListOccurrencesOptions

SetHeaders : Allow user to set Headers

func (*ListOccurrencesOptions) SetPageSize 

func (_options *ListOccurrencesOptions) SetPageSize(pageSize int64) *ListOccurrencesOptions

SetPageSize : Allow user to set PageSize

func (*ListOccurrencesOptions) SetPageToken 

func (_options *ListOccurrencesOptions) SetPageToken(pageToken string) *ListOccurrencesOptions

SetPageToken : Allow user to set PageToken

func (*ListOccurrencesOptions) SetProviderID 

func (_options *ListOccurrencesOptions) SetProviderID(providerID string) *ListOccurrencesOptions

SetProviderID : Allow user to set ProviderID

func (*ListOccurrencesOptions) SetTransactionID 

func (_options *ListOccurrencesOptions) SetTransactionID(transactionID string) *ListOccurrencesOptions

SetTransactionID : Allow user to set TransactionID

type ListProvidersOptions 

type ListProvidersOptions struct {
	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// The number of documents that you want to return.
	Limit *int64 `json:"limit,omitempty"`

	// The offset is the index of the item from which you want to start returning data from. Default is 0.
	Skip *int64 `json:"skip,omitempty"`

	// The first provider ID included in the result, sorted in ascending order. If not provided, this parameter is ignored.
	StartProviderID *string `json:"start_provider_id,omitempty"`

	// The last provider ID included in the result, sorted in ascending order. If not provided, this parameter is ignored.
	EndProviderID *string `json:"end_provider_id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListProvidersOptions : The ListProviders options.

func (*ListProvidersOptions) SetEndProviderID 

func (_options *ListProvidersOptions) SetEndProviderID(endProviderID string) *ListProvidersOptions

SetEndProviderID : Allow user to set EndProviderID

func (*ListProvidersOptions) SetHeaders 

func (options *ListProvidersOptions) SetHeaders(param map[string]string) *ListProvidersOptions

SetHeaders : Allow user to set Headers

func (*ListProvidersOptions) SetLimit 

func (_options *ListProvidersOptions) SetLimit(limit int64) *ListProvidersOptions

SetLimit : Allow user to set Limit

func (*ListProvidersOptions) SetSkip 

func (_options *ListProvidersOptions) SetSkip(skip int64) *ListProvidersOptions

SetSkip : Allow user to set Skip

func (*ListProvidersOptions) SetStartProviderID 

func (_options *ListProvidersOptions) SetStartProviderID(startProviderID string) *ListProvidersOptions

SetStartProviderID : Allow user to set StartProviderID

func (*ListProvidersOptions) SetTransactionID 

func (_options *ListProvidersOptions) SetTransactionID(transactionID string) *ListProvidersOptions

SetTransactionID : Allow user to set TransactionID

type NetworkConnection 

type NetworkConnection struct {
	// The direction of this network connection.
	Direction *string `json:"direction,omitempty"`

	// The protocol of this network connection.
	Protocol *string `json:"protocol,omitempty"`

	// It provides details about a socket address.
	Client *SocketAddress `json:"client,omitempty"`

	// It provides details about a socket address.
	Server *SocketAddress `json:"server,omitempty"`
}

NetworkConnection : It provides details about a network connection.

type NumericCardElementValueType 

type NumericCardElementValueType struct {
	// Kind of element
	// - KPI: Kind of value derived from a KPI occurrence.
	Kind *string `json:"kind,omitempty"`

	// The name of the kpi note associated to the occurrence with the value for this card element value type.
	KpiNoteName *string `json:"kpi_note_name,omitempty"`

	// The text of this element type.
	Text *string `json:"text,omitempty"`

	// the names of the finding note associated that act as filters for counting the occurrences.
	FindingNoteNames []string `json:"finding_note_names,omitempty"`
}

NumericCardElementValueType : NumericCardElementValueType struct This model "extends" ValueType

type PostGraphOptions 

type PostGraphOptions struct {
	// Body for query findings.
	Body io.ReadCloser `json:"body,omitempty"`

	// The type of the input.
	ContentType *string `json:"Content-Type,omitempty"`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

PostGraphOptions : The PostGraph options.

func (*PostGraphOptions) SetBody 

func (_options *PostGraphOptions) SetBody(body io.ReadCloser) *PostGraphOptions

SetBody : Allow user to set Body

func (*PostGraphOptions) SetContentType 

func (_options *PostGraphOptions) SetContentType(contentType string) *PostGraphOptions

SetContentType : Allow user to set ContentType

func (*PostGraphOptions) SetHeaders 

func (options *PostGraphOptions) SetHeaders(param map[string]string) *PostGraphOptions

SetHeaders : Allow user to set Headers

func (*PostGraphOptions) SetTransactionID 

func (_options *PostGraphOptions) SetTransactionID(transactionID string) *PostGraphOptions

SetTransactionID : Allow user to set TransactionID

type RemediationStep 

type RemediationStep struct {
	// Title of this next step.
	Title *string `json:"title,omitempty"`

	// The URL associated to this next steps.
	URL *string `json:"url,omitempty"`
}

RemediationStep : A remediation step description and associated URL.

type Reporter 

type Reporter struct {
	// The id of this reporter.
	ID *string `json:"id" validate:"required"`

	// The title of this reporter.
	Title *string `json:"title" validate:"required"`

	// The url of this reporter.
	URL *string `json:"url,omitempty"`
}

Reporter : The entity reporting a note.

type Section 

type Section struct {
	// The title of this section.
	Title *string `json:"title" validate:"required"`

	// The image of this section.
	Image *string `json:"image" validate:"required"`
}

Section : Card provides details about a card kind of note.

type SocketAddress 

type SocketAddress struct {
	// The IP address of this socket address.
	Address *string `json:"address" validate:"required"`

	// The port number of this socket address.
	Port *int64 `json:"port,omitempty"`
}

SocketAddress : It provides details about a socket address.

type UpdateNoteOptions 

type UpdateNoteOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of note `name`: providers/{provider_id}/notes/{note_id}.
	NoteID *string `json:"note_id" validate:"required,ne="`

	// A one sentence description of your note.
	ShortDescription *string `json:"short_description" validate:"required"`

	// A more detailed description of your note.
	LongDescription *string `json:"long_description" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	// The ID of the note.
	ID *string `json:"id" validate:"required"`

	// The entity reporting a note.
	ReportedBy *Reporter `json:"reported_by" validate:"required"`

	RelatedURL []APINoteRelatedURL `json:"related_url,omitempty"`

	// Output only. The time this note was created. This field can be used as a filter in list requests.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this note was last updated. This field can be used as a filter in list requests.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	// True if this note can be shared by multiple accounts.
	Shared *bool `json:"shared,omitempty"`

	// FindingType provides details about a finding note.
	Finding *FindingType `json:"finding,omitempty"`

	// KpiType provides details about a KPI note.
	Kpi *KpiType `json:"kpi,omitempty"`

	// Card provides details about a card kind of note.
	Card *Card `json:"card,omitempty"`

	// Card provides details about a card kind of note.
	Section *Section `json:"section,omitempty"`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateNoteOptions : The UpdateNote options.

func (*UpdateNoteOptions) SetCard 

func (_options *UpdateNoteOptions) SetCard(card *Card) *UpdateNoteOptions

SetCard : Allow user to set Card

func (*UpdateNoteOptions) SetCreateTime added in v1.2.1 

func (_options *UpdateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *UpdateNoteOptions

SetCreateTime : Allow user to set CreateTime

func (*UpdateNoteOptions) SetFinding 

func (_options *UpdateNoteOptions) SetFinding(finding *FindingType) *UpdateNoteOptions

SetFinding : Allow user to set Finding

func (*UpdateNoteOptions) SetHeaders 

func (options *UpdateNoteOptions) SetHeaders(param map[string]string) *UpdateNoteOptions

SetHeaders : Allow user to set Headers

func (*UpdateNoteOptions) SetID 

func (_options *UpdateNoteOptions) SetID(id string) *UpdateNoteOptions

SetID : Allow user to set ID

func (*UpdateNoteOptions) SetKind 

func (_options *UpdateNoteOptions) SetKind(kind string) *UpdateNoteOptions

SetKind : Allow user to set Kind

func (*UpdateNoteOptions) SetKpi 

func (_options *UpdateNoteOptions) SetKpi(kpi *KpiType) *UpdateNoteOptions

SetKpi : Allow user to set Kpi

func (*UpdateNoteOptions) SetLongDescription 

func (_options *UpdateNoteOptions) SetLongDescription(longDescription string) *UpdateNoteOptions

SetLongDescription : Allow user to set LongDescription

func (*UpdateNoteOptions) SetNoteID 

func (_options *UpdateNoteOptions) SetNoteID(noteID string) *UpdateNoteOptions

SetNoteID : Allow user to set NoteID

func (*UpdateNoteOptions) SetProviderID 

func (_options *UpdateNoteOptions) SetProviderID(providerID string) *UpdateNoteOptions

SetProviderID : Allow user to set ProviderID

func (*UpdateNoteOptions) SetRelatedURL 

func (_options *UpdateNoteOptions) SetRelatedURL(relatedURL []APINoteRelatedURL) *UpdateNoteOptions

SetRelatedURL : Allow user to set RelatedURL

func (*UpdateNoteOptions) SetReportedBy 

func (_options *UpdateNoteOptions) SetReportedBy(reportedBy *Reporter) *UpdateNoteOptions

SetReportedBy : Allow user to set ReportedBy

func (*UpdateNoteOptions) SetSection 

func (_options *UpdateNoteOptions) SetSection(section *Section) *UpdateNoteOptions

SetSection : Allow user to set Section

func (*UpdateNoteOptions) SetShared 

func (_options *UpdateNoteOptions) SetShared(shared bool) *UpdateNoteOptions

SetShared : Allow user to set Shared

func (*UpdateNoteOptions) SetShortDescription 

func (_options *UpdateNoteOptions) SetShortDescription(shortDescription string) *UpdateNoteOptions

SetShortDescription : Allow user to set ShortDescription

func (*UpdateNoteOptions) SetTransactionID 

func (_options *UpdateNoteOptions) SetTransactionID(transactionID string) *UpdateNoteOptions

SetTransactionID : Allow user to set TransactionID

func (*UpdateNoteOptions) SetUpdateTime added in v1.2.1 

func (_options *UpdateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *UpdateNoteOptions

SetUpdateTime : Allow user to set UpdateTime

type UpdateOccurrenceOptions 

type UpdateOccurrenceOptions struct {
	// Part of the parent. This field contains the provider ID. For example: providers/{provider_id}.
	ProviderID *string `json:"provider_id" validate:"required,ne="`

	// Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}.
	OccurrenceID *string `json:"occurrence_id" validate:"required,ne="`

	// An analysis note associated with this image, in the form "{account_id}/providers/{provider_id}/notes/{note_id}" This
	// field can be used as a filter in list requests.
	NoteName *string `json:"note_name" validate:"required"`

	// The type of note. Use this field to filter notes and occurences by kind.
	//  - FINDING: The note and occurrence represent a finding.
	//  - KPI: The note and occurrence represent a KPI value.
	//  - CARD: The note represents a card showing findings and related metric values.
	//  - CARD_CONFIGURED: The note represents a card configured for a user account.
	//  - SECTION: The note represents a section in a dashboard.
	Kind *string `json:"kind" validate:"required"`

	// The id of the occurrence.
	ID *string `json:"id" validate:"required"`

	// The unique URL of the resource, image or the container, for which the `Occurrence` applies. For example,
	// https://gcr.io/provider/image@sha256:foo. This field can be used as a filter in list requests.
	ResourceURL *string `json:"resource_url,omitempty"`

	// A description of actions that can be taken to remedy the `Note`.
	Remediation *string `json:"remediation,omitempty"`

	// Output only. The time this `Occurrence` was created.
	CreateTime *strfmt.DateTime `json:"create_time,omitempty"`

	// Output only. The time this `Occurrence` was last updated.
	UpdateTime *strfmt.DateTime `json:"update_time,omitempty"`

	Context *Context `json:"context,omitempty"`

	// Finding provides details about a finding occurrence.
	Finding *Finding `json:"finding,omitempty"`

	// Kpi provides details about a KPI occurrence.
	Kpi *Kpi `json:"kpi,omitempty"`

	// Additional data for the finding, like AT event etc.
	ReferenceData interface{} `json:"reference_data,omitempty"`

	// The transaction ID for the request in UUID v4 format.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateOccurrenceOptions : The UpdateOccurrence options.

func (*UpdateOccurrenceOptions) SetContext 

func (_options *UpdateOccurrenceOptions) SetContext(context *Context) *UpdateOccurrenceOptions

SetContext : Allow user to set Context

func (*UpdateOccurrenceOptions) SetCreateTime added in v1.3.3 

func (_options *UpdateOccurrenceOptions) SetCreateTime(createTime *strfmt.DateTime) *UpdateOccurrenceOptions

SetCreateTime : Allow user to set CreateTime

func (*UpdateOccurrenceOptions) SetFinding 

func (_options *UpdateOccurrenceOptions) SetFinding(finding *Finding) *UpdateOccurrenceOptions

SetFinding : Allow user to set Finding

func (*UpdateOccurrenceOptions) SetHeaders 

func (options *UpdateOccurrenceOptions) SetHeaders(param map[string]string) *UpdateOccurrenceOptions

SetHeaders : Allow user to set Headers

func (*UpdateOccurrenceOptions) SetID 

func (_options *UpdateOccurrenceOptions) SetID(id string) *UpdateOccurrenceOptions

SetID : Allow user to set ID

func (*UpdateOccurrenceOptions) SetKind 

func (_options *UpdateOccurrenceOptions) SetKind(kind string) *UpdateOccurrenceOptions

SetKind : Allow user to set Kind

func (*UpdateOccurrenceOptions) SetKpi 

func (_options *UpdateOccurrenceOptions) SetKpi(kpi *Kpi) *UpdateOccurrenceOptions

SetKpi : Allow user to set Kpi

func (*UpdateOccurrenceOptions) SetNoteName 

func (_options *UpdateOccurrenceOptions) SetNoteName(noteName string) *UpdateOccurrenceOptions

SetNoteName : Allow user to set NoteName

func (*UpdateOccurrenceOptions) SetOccurrenceID 

func (_options *UpdateOccurrenceOptions) SetOccurrenceID(occurrenceID string) *UpdateOccurrenceOptions

SetOccurrenceID : Allow user to set OccurrenceID

func (*UpdateOccurrenceOptions) SetProviderID 

func (_options *UpdateOccurrenceOptions) SetProviderID(providerID string) *UpdateOccurrenceOptions

SetProviderID : Allow user to set ProviderID

func (*UpdateOccurrenceOptions) SetReferenceData 

func (_options *UpdateOccurrenceOptions) SetReferenceData(referenceData interface{}) *UpdateOccurrenceOptions

SetReferenceData : Allow user to set ReferenceData

func (*UpdateOccurrenceOptions) SetRemediation 

func (_options *UpdateOccurrenceOptions) SetRemediation(remediation string) *UpdateOccurrenceOptions

SetRemediation : Allow user to set Remediation

func (*UpdateOccurrenceOptions) SetResourceURL 

func (_options *UpdateOccurrenceOptions) SetResourceURL(resourceURL string) *UpdateOccurrenceOptions

SetResourceURL : Allow user to set ResourceURL

func (*UpdateOccurrenceOptions) SetTransactionID 

func (_options *UpdateOccurrenceOptions) SetTransactionID(transactionID string) *UpdateOccurrenceOptions

SetTransactionID : Allow user to set TransactionID

func (*UpdateOccurrenceOptions) SetUpdateTime added in v1.3.3 

func (_options *UpdateOccurrenceOptions) SetUpdateTime(updateTime *strfmt.DateTime) *UpdateOccurrenceOptions

SetUpdateTime : Allow user to set UpdateTime

type ValueType 

type ValueType struct {
	// Kind of element
	// - KPI: Kind of value derived from a KPI occurrence.
	Kind *string `json:"kind,omitempty"`

	// The name of the kpi note associated to the occurrence with the value for this card element value type.
	KpiNoteName *string `json:"kpi_note_name,omitempty"`

	// The text of this element type.
	Text *string `json:"text,omitempty"`

	// the names of the finding note associated that act as filters for counting the occurrences.
	FindingNoteNames []string `json:"finding_note_names,omitempty"`
}

ValueType : the value type of a card element. Models which "extend" this model: - ValueTypeKpiValueType - ValueTypeFindingCountValueType

type ValueTypeFindingCountValueType 

type ValueTypeFindingCountValueType struct {
	// Kind of element - FINDING_COUNT: Kind of value derived from a count of finding occurrences.
	Kind *string `json:"kind" validate:"required"`

	// the names of the finding note associated that act as filters for counting the occurrences.
	FindingNoteNames []string `json:"finding_note_names" validate:"required"`

	// The text of this element type.
	Text *string `json:"text" validate:"required"`
}

ValueTypeFindingCountValueType : ValueTypeFindingCountValueType struct This model "extends" ValueType

type ValueTypeIntf 

type ValueTypeIntf interface {
	// contains filtered or unexported methods
}

type ValueTypeKpiValueType 

type ValueTypeKpiValueType struct {
	// Kind of element
	// - KPI: Kind of value derived from a KPI occurrence.
	Kind *string `json:"kind" validate:"required"`

	// The name of the kpi note associated to the occurrence with the value for this card element value type.
	KpiNoteName *string `json:"kpi_note_name" validate:"required"`

	// The text of this element type.
	Text *string `json:"text" validate:"required"`
}

ValueTypeKpiValueType : ValueTypeKpiValueType struct This model "extends" ValueType

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.