Documentation ¶
Overview ¶
Package findingsapiv1 : Operations and models for the FindingsApiV1 service
Index ¶
- Constants
- type ApiListNoteOccurrencesResponse
- type ApiListNotesResponse
- type ApiListOccurrencesResponse
- type ApiListProvidersResponse
- type ApiNote
- type ApiNoteKind
- type ApiNoteRelatedURL
- type ApiOccurrence
- type ApiProvider
- type BreakdownCardElement
- type Card
- type CardElement
- type CardValueType
- type Certainty
- type Context
- type CreateNoteOptions
- func (options *CreateNoteOptions) SetAccountID(accountID string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetCard(card *Card) *CreateNoteOptions
- func (options *CreateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *CreateNoteOptions
- func (options *CreateNoteOptions) SetExpirationTime(expirationTime *strfmt.DateTime) *CreateNoteOptions
- func (options *CreateNoteOptions) SetFinding(finding *FindingType) *CreateNoteOptions
- func (options *CreateNoteOptions) SetHeaders(param map[string]string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetID(ID string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetKind(kind *string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetKpi(kpi *KpiType) *CreateNoteOptions
- func (options *CreateNoteOptions) SetLongDescription(longDescription string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetProviderID(providerID string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetRelatedURL(relatedURL []ApiNoteRelatedURL) *CreateNoteOptions
- func (options *CreateNoteOptions) SetReportedBy(reportedBy *Reporter) *CreateNoteOptions
- func (options *CreateNoteOptions) SetSection(section *Section) *CreateNoteOptions
- func (options *CreateNoteOptions) SetShared(shared bool) *CreateNoteOptions
- func (options *CreateNoteOptions) SetShortDescription(shortDescription string) *CreateNoteOptions
- func (options *CreateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *CreateNoteOptions
- type CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetAccountID(accountID string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetContext(context *Context) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetCreateTime(createTime *strfmt.DateTime) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetFinding(finding *Finding) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetHeaders(param map[string]string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetID(ID string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetKind(kind string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetKpi(kpi *Kpi) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetNoteName(noteName string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetProviderID(providerID string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetRemediation(remediation string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetReplaceIfExists(replaceIfExists bool) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetResourceURL(resourceURL string) *CreateOccurrenceOptions
- func (options *CreateOccurrenceOptions) SetUpdateTime(updateTime *strfmt.DateTime) *CreateOccurrenceOptions
- type DataTransferred
- type DeleteNoteOptions
- func (options *DeleteNoteOptions) SetAccountID(accountID string) *DeleteNoteOptions
- func (options *DeleteNoteOptions) SetHeaders(param map[string]string) *DeleteNoteOptions
- func (options *DeleteNoteOptions) SetNoteID(noteID string) *DeleteNoteOptions
- func (options *DeleteNoteOptions) SetProviderID(providerID string) *DeleteNoteOptions
- type DeleteOccurrenceOptions
- func (options *DeleteOccurrenceOptions) SetAccountID(accountID string) *DeleteOccurrenceOptions
- func (options *DeleteOccurrenceOptions) SetHeaders(param map[string]string) *DeleteOccurrenceOptions
- func (options *DeleteOccurrenceOptions) SetOccurrenceID(occurrenceID string) *DeleteOccurrenceOptions
- func (options *DeleteOccurrenceOptions) SetProviderID(providerID string) *DeleteOccurrenceOptions
- type Finding
- type FindingCountValueType
- type FindingType
- type FindingsApiV1
- func (findingsApi *FindingsApiV1) CreateNote(createNoteOptions *CreateNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) CreateOccurrence(createOccurrenceOptions *CreateOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) DeleteNote(deleteNoteOptions *DeleteNoteOptions) (response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) DeleteOccurrence(deleteOccurrenceOptions *DeleteOccurrenceOptions) (response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) GetNote(getNoteOptions *GetNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) GetOccurrence(getOccurrenceOptions *GetOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) GetOccurrenceNote(getOccurrenceNoteOptions *GetOccurrenceNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) ListNoteOccurrences(listNoteOccurrencesOptions *ListNoteOccurrencesOptions) (result *ApiListNoteOccurrencesResponse, response *core.DetailedResponse, ...)
- func (findingsApi *FindingsApiV1) ListNotes(listNotesOptions *ListNotesOptions) (result *ApiListNotesResponse, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) ListOccurrences(listOccurrencesOptions *ListOccurrencesOptions) (result *ApiListOccurrencesResponse, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) ListProviders(listProvidersOptions *ListProvidersOptions) (result *ApiListProvidersResponse, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) NewApiNote(shortDescription string, longDescription string, kind string, ID string, ...) (model *ApiNote, err error)
- func (findingsApi *FindingsApiV1) NewApiOccurrence(noteName string, kind string, ID string) (model *ApiOccurrence, err error)
- func (findingsApi *FindingsApiV1) NewBreakdownCardElement(kind string, text string, valueTypes []ValueType) (model *BreakdownCardElement, err error)
- func (findingsApi *FindingsApiV1) NewCard(section string, title string, subtitle string, findingNoteNames []string, ...) (model *Card, err error)
- func (findingsApi *FindingsApiV1) NewCardElement(kind string, text string) (model *CardElement, err error)
- func (findingsApi *FindingsApiV1) NewCreateNoteOptions(accountID string, providerID string, shortDescription string, ...) *CreateNoteOptions
- func (findingsApi *FindingsApiV1) NewCreateOccurrenceOptions(accountID string, providerID string, noteName string, kind string, ID string) *CreateOccurrenceOptions
- func (findingsApi *FindingsApiV1) NewDeleteNoteOptions(accountID string, providerID string, noteID string) *DeleteNoteOptions
- func (findingsApi *FindingsApiV1) NewDeleteOccurrenceOptions(accountID string, providerID string, occurrenceID string) *DeleteOccurrenceOptions
- func (findingsApi *FindingsApiV1) NewFindingCountValueType(kind string, findingNoteNames []string, text string) (model *FindingCountValueType, err error)
- func (findingsApi *FindingsApiV1) NewFindingType(severity *string) (model *FindingType, err error)
- func (findingsApi *FindingsApiV1) NewGetNoteOptions(accountID string, providerID string, noteID string) *GetNoteOptions
- func (findingsApi *FindingsApiV1) NewGetOccurrenceNoteOptions(accountID string, providerID string, occurrenceID string) *GetOccurrenceNoteOptions
- func (findingsApi *FindingsApiV1) NewGetOccurrenceOptions(accountID string, providerID string, occurrenceID string) *GetOccurrenceOptions
- func (findingsApi *FindingsApiV1) NewKpi(value float64) (model *Kpi, err error)
- func (findingsApi *FindingsApiV1) NewKpiType(aggregationType string) (model *KpiType, err error)
- func (findingsApi *FindingsApiV1) NewListNoteOccurrencesOptions(accountID string, providerID string, noteID string) *ListNoteOccurrencesOptions
- func (findingsApi *FindingsApiV1) NewListNotesOptions(accountID string, providerID string) *ListNotesOptions
- func (findingsApi *FindingsApiV1) NewListOccurrencesOptions(accountID string, providerID string) *ListOccurrencesOptions
- func (findingsApi *FindingsApiV1) NewListProvidersOptions(accountID string) *ListProvidersOptions
- func (findingsApi *FindingsApiV1) NewNumericCardElement(kind string, text string, valueType interface{}) (model *NumericCardElement, err error)
- func (findingsApi *FindingsApiV1) NewPostGraphOptions(accountID string) *PostGraphOptions
- func (findingsApi *FindingsApiV1) NewReporter(ID string, title string) (model *Reporter, err error)
- func (findingsApi *FindingsApiV1) NewSection(title string, image string) (model *Section, err error)
- func (findingsApi *FindingsApiV1) NewSocketAddress(address string) (model *SocketAddress, err error)
- func (findingsApi *FindingsApiV1) NewTimeSeriesCardElement(kind string, text string, valueTypes []FindingCountValueType) (model *TimeSeriesCardElement, err error)
- func (findingsApi *FindingsApiV1) NewUpdateNoteOptions(accountID string, providerID string, noteID string, shortDescription string, ...) *UpdateNoteOptions
- func (findingsApi *FindingsApiV1) NewUpdateOccurrenceOptions(accountID string, providerID string, occurrenceID string, noteName string, ...) *UpdateOccurrenceOptions
- func (findingsApi *FindingsApiV1) NewValueType(kind string, text string) (model *ValueType, err error)
- func (findingsApi *FindingsApiV1) PostGraph(postGraphOptions *PostGraphOptions) (response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) SetServiceURL(url string) error
- func (findingsApi *FindingsApiV1) UpdateNote(updateNoteOptions *UpdateNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
- func (findingsApi *FindingsApiV1) UpdateOccurrence(updateOccurrenceOptions *UpdateOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
- type FindingsApiV1Options
- type GetNoteOptions
- func (options *GetNoteOptions) SetAccountID(accountID string) *GetNoteOptions
- func (options *GetNoteOptions) SetHeaders(param map[string]string) *GetNoteOptions
- func (options *GetNoteOptions) SetNoteID(noteID string) *GetNoteOptions
- func (options *GetNoteOptions) SetProviderID(providerID string) *GetNoteOptions
- type GetOccurrenceNoteOptions
- func (options *GetOccurrenceNoteOptions) SetAccountID(accountID string) *GetOccurrenceNoteOptions
- func (options *GetOccurrenceNoteOptions) SetHeaders(param map[string]string) *GetOccurrenceNoteOptions
- func (options *GetOccurrenceNoteOptions) SetOccurrenceID(occurrenceID string) *GetOccurrenceNoteOptions
- func (options *GetOccurrenceNoteOptions) SetProviderID(providerID string) *GetOccurrenceNoteOptions
- type GetOccurrenceOptions
- func (options *GetOccurrenceOptions) SetAccountID(accountID string) *GetOccurrenceOptions
- func (options *GetOccurrenceOptions) SetHeaders(param map[string]string) *GetOccurrenceOptions
- func (options *GetOccurrenceOptions) SetOccurrenceID(occurrenceID string) *GetOccurrenceOptions
- func (options *GetOccurrenceOptions) SetProviderID(providerID string) *GetOccurrenceOptions
- type Kpi
- type KpiType
- type ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetAccountID(accountID string) *ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetHeaders(param map[string]string) *ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetNoteID(noteID string) *ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetPageSize(pageSize int64) *ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetPageToken(pageToken string) *ListNoteOccurrencesOptions
- func (options *ListNoteOccurrencesOptions) SetProviderID(providerID string) *ListNoteOccurrencesOptions
- type ListNotesOptions
- func (options *ListNotesOptions) SetAccountID(accountID string) *ListNotesOptions
- func (options *ListNotesOptions) SetHeaders(param map[string]string) *ListNotesOptions
- func (options *ListNotesOptions) SetPageSize(pageSize int64) *ListNotesOptions
- func (options *ListNotesOptions) SetPageToken(pageToken string) *ListNotesOptions
- func (options *ListNotesOptions) SetProviderID(providerID string) *ListNotesOptions
- type ListOccurrencesOptions
- func (options *ListOccurrencesOptions) SetAccountID(accountID string) *ListOccurrencesOptions
- func (options *ListOccurrencesOptions) SetHeaders(param map[string]string) *ListOccurrencesOptions
- func (options *ListOccurrencesOptions) SetPageSize(pageSize int64) *ListOccurrencesOptions
- func (options *ListOccurrencesOptions) SetPageToken(pageToken string) *ListOccurrencesOptions
- func (options *ListOccurrencesOptions) SetProviderID(providerID string) *ListOccurrencesOptions
- type ListProvidersOptions
- func (options *ListProvidersOptions) SetAccountID(accountID string) *ListProvidersOptions
- func (options *ListProvidersOptions) SetEndProviderID(endProviderID string) *ListProvidersOptions
- func (options *ListProvidersOptions) SetHeaders(param map[string]string) *ListProvidersOptions
- func (options *ListProvidersOptions) SetLimit(limit int64) *ListProvidersOptions
- func (options *ListProvidersOptions) SetSkip(skip int64) *ListProvidersOptions
- func (options *ListProvidersOptions) SetStartProviderID(startProviderID string) *ListProvidersOptions
- type NetworkConnection
- type NumericCardElement
- type PostGraphOptions
- func (options *PostGraphOptions) SetAccountID(accountID string) *PostGraphOptions
- func (options *PostGraphOptions) SetBody(body io.ReadCloser) *PostGraphOptions
- func (options *PostGraphOptions) SetContentType(contentType string) *PostGraphOptions
- func (options *PostGraphOptions) SetHeaders(param map[string]string) *PostGraphOptions
- type RemediationStep
- type Reporter
- type Section
- type Severity
- type SocketAddress
- type TimeSeriesCardElement
- type UpdateNoteOptions
- func (options *UpdateNoteOptions) SetAccountID(accountID string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetCard(card *Card) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetExpirationTime(expirationTime *strfmt.DateTime) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetFinding(finding *FindingType) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetHeaders(param map[string]string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetID(ID string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetKind(kind string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetKpi(kpi *KpiType) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetLongDescription(longDescription string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetNoteID(noteID string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetProviderID(providerID string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetRelatedURL(relatedURL []ApiNoteRelatedURL) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetReportedBy(reportedBy *Reporter) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetSection(section *Section) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetShared(shared bool) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetShortDescription(shortDescription string) *UpdateNoteOptions
- func (options *UpdateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *UpdateNoteOptions
- type UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetAccountID(accountID string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetContext(context *Context) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetCreateTime(createTime *strfmt.DateTime) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetFinding(finding *Finding) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetHeaders(param map[string]string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetID(ID string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetKind(kind string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetKpi(kpi *Kpi) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetNoteName(noteName string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetOccurrenceID(occurrenceID string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetProviderID(providerID string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetRemediation(remediation string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetResourceURL(resourceURL string) *UpdateOccurrenceOptions
- func (options *UpdateOccurrenceOptions) SetUpdateTime(updateTime *strfmt.DateTime) *UpdateOccurrenceOptions
- type ValueType
Constants ¶
const ( CardElement_Kind_Breakdown = "BREAKDOWN" CardElement_Kind_Numeric = "NUMERIC" CardElement_Kind_TimeSeries = "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.
const ( ValueType_Kind_FindingCount = "FINDING_COUNT" ValueType_Kind_Kpi = "KPI" )
Constants associated with the ValueType.Kind property. Kind of element - KPI: Kind of value derived from a KPI occurrence - FINDING_COUNT: Kind of value derived from a count of finding occurrences.
const ( BreakdownCardElement_Kind_Breakdown = "BREAKDOWN" BreakdownCardElement_Kind_Numeric = "NUMERIC" BreakdownCardElement_Kind_TimeSeries = "TIME_SERIES" )
Constants associated with the BreakdownCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.
const ( NumericCardElement_Kind_Breakdown = "BREAKDOWN" NumericCardElement_Kind_Numeric = "NUMERIC" NumericCardElement_Kind_TimeSeries = "TIME_SERIES" )
Constants associated with the NumericCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.
const ( TimeSeriesCardElement_Kind_Breakdown = "BREAKDOWN" TimeSeriesCardElement_Kind_Numeric = "NUMERIC" TimeSeriesCardElement_Kind_TimeSeries = "TIME_SERIES" )
Constants associated with the TimeSeriesCardElement.Kind property. Kind of element - NUMERIC: Single numeric value - BREAKDOWN: Breakdown of numeric values - TIME_SERIES: Time-series of numeric values.
const DefaultServiceName = "findings_api"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://us-south.secadvisor.cloud.ibm.com/findings"
DefaultServiceURL is the default URL to make service requests to.
const (
FindingCountValueType_Kind_FindingCount = "FINDING_COUNT"
)
Constants associated with the FindingCountValueType.Kind property. Kind of element - FINDING_COUNT: Kind of value derived from a count of finding occurrences.
const (
KpiType_AggregationType_Sum = "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.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 { 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 {
Providers []ApiProvider `json:"providers,omitempty"`
}
ApiListProvidersResponse : Response including listed providers.
type ApiNote ¶
type ApiNote struct { // A one sentence description of this `Note`. ShortDescription *string `json:"short_description" validate:"required"` // A detailed description of this `Note`. LongDescription *string `json:"long_description" validate:"required"` // Output only. This explicitly denotes which kind of note is specified. This // field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` RelatedURL []ApiNoteRelatedURL `json:"related_url,omitempty"` // Time of expiration for this note, null if note does not expire. ExpirationTime *strfmt.DateTime `json:"expiration_time,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"` ID *string `json:"id" validate:"required"` Shared *bool `json:"shared,omitempty"` // Details about the reporter of this `Note`. ReportedBy *Reporter `json:"reported_by" validate:"required"` // The finding details of the note. Finding *FindingType `json:"finding,omitempty"` // The KPI details of the note. Kpi *KpiType `json:"kpi,omitempty"` // The card details of the note. Card *Card `json:"card,omitempty"` // The section details of the note. Section *Section `json:"section,omitempty"` }
ApiNote : Provides a detailed description of a `Note`.
type ApiNoteKind ¶
type ApiNoteKind struct { }
ApiNoteKind : This must be 1:1 with members of our oneofs, it can be used for filtering Note and Occurrence on their 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.
type ApiNoteRelatedURL ¶
type ApiNoteRelatedURL struct { Label *string `json:"label,omitempty"` URL *string `json:"url,omitempty"` }
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"` // Output only. This explicitly denotes which of the `Occurrence` details are specified. // This field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` 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"` ID *string `json:"id" validate:"required"` //OccurrenceID of the occurrence OccurrenceID *string `json:"occurrence_id,omitempty"` //ProviderID of the occurrence ProviderID *string `json:"provider_id,omitempty"` //Name of the occurrence Name *string `json:"name,omitempty"` // Details about the context of this `Occurrence`. Context *Context `json:"context,omitempty"` // Details of the occurrence of a finding. Finding *Finding `json:"finding,omitempty"` // Details of the occurrence of a KPI. Kpi *Kpi `json:"kpi,omitempty"` }
ApiOccurrence : `Occurrence` includes information about analysis occurrences for an image.
type ApiProvider ¶
type ApiProvider struct { Name *string `json:"name" validate:"required"` ID *string `json:"id" validate:"required"` }
ApiProvider : Provides a detailed description of a `Provider`.
type BreakdownCardElement ¶
type BreakdownCardElement struct { // The kind of this card element. Kind *string `json:"kind" validate:"required"` // The text of this card element. Text *string `json:"text" validate:"required"` // the value types associated to this card element. ValueTypes []ValueType `json:"value_types" validate:"required"` }
BreakdownCardElement : A card element with a breakdown of values.
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 []CardElement `json:"elements" validate:"required"` }
Card : Card provides details about a card kind of note.
type CardElement ¶
type CardElement struct { // 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"` //Text to display on the card Text *string `json:"text" validate:"required"` //ValueType the type of an element in a card ValueType *CardValueType `json:"value_type,omitempty"` //ValueTypes the type of an element in a card ValueTypes []CardValueType `json:"value_types,omitempty"` // The default time range of this card element. DefaultTimeRange *string `json:"default_time_range,omitempty"` // The default interval of the time series. DefaultInterval *string `json:"default_interval,omitempty"` }
CardElement : CardElement provides details about the elements of a Card.
type CardValueType ¶
type CardValueType struct { //Kind of the value // - KPI: Kind of value derived from a KPI occurrence // - 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. //Required for values of kind "FINDING_COUNT" FindingNoteNames []string `json:"finding_note_names,omitempty"` // The name of the kpi note associated to the occurrence with the value for this card element value type //Required for only for values of kind "KPI" KpiNoteName *string `json:"kpi_note_name,omitempty"` //Text of the element. Required for kind "BREAKDOWN", "TIMESERIES" Text *string `json:"text,omitempty"` }
CardValueType or types associated to this card element
type Certainty ¶
type Certainty struct { }
Certainty : Note provider-assigned confidence on the validity of an occurrence - LOW: Low Certainty - MEDIUM: Medium Certainty - HIGH: High Certainty.
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 { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Part of `parent`. This field contains the provider_id for example: providers/{provider_id}. ProviderID *string `json:"provider_id" validate:"required"` // A one sentence description of this `Note`. ShortDescription *string `json:"short_description" validate:"required"` // A detailed description of this `Note`. LongDescription *string `json:"long_description" validate:"required"` // Output only. This explicitly denotes which kind of note is specified. This // field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` ID *string `json:"id" validate:"required"` // Details about the reporter of this `Note`. ReportedBy *Reporter `json:"reported_by" validate:"required"` RelatedURL []ApiNoteRelatedURL `json:"related_url,omitempty"` // Time of expiration for this note, null if note does not expire. ExpirationTime *strfmt.DateTime `json:"expiration_time,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"` Shared *bool `json:"shared,omitempty"` // The finding details of the note. Finding *FindingType `json:"finding,omitempty"` // The KPI details of the note. Kpi *KpiType `json:"kpi,omitempty"` // The card details of the note. Card *Card `json:"card,omitempty"` // The section details of the note. Section *Section `json:"section,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
CreateNoteOptions : The CreateNote options.
func (*CreateNoteOptions) SetAccountID ¶
func (options *CreateNoteOptions) SetAccountID(accountID string) *CreateNoteOptions
SetAccountID : Allow user to set AccountID
func (*CreateNoteOptions) SetCard ¶
func (options *CreateNoteOptions) SetCard(card *Card) *CreateNoteOptions
SetCard : Allow user to set Card
func (*CreateNoteOptions) SetCreateTime ¶
func (options *CreateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *CreateNoteOptions
SetCreateTime : Allow user to set CreateTime
func (*CreateNoteOptions) SetExpirationTime ¶
func (options *CreateNoteOptions) SetExpirationTime(expirationTime *strfmt.DateTime) *CreateNoteOptions
SetExpirationTime : Allow user to set ExpirationTime
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) SetUpdateTime ¶
func (options *CreateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *CreateNoteOptions
SetUpdateTime : Allow user to set UpdateTime
type CreateOccurrenceOptions ¶
type CreateOccurrenceOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Part of `parent`. This contains the provider_id for example: providers/{provider_id}. ProviderID *string `json:"provider_id" validate:"required"` // 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"` // Output only. This explicitly denotes which of the `Occurrence` details are specified. // This field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` 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"` 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"` // Details about the context of this `Occurrence`. Context *Context `json:"context,omitempty"` // Details of the occurrence of a finding. Finding *Finding `json:"finding,omitempty"` // Details of the occurrence of a KPI. Kpi *Kpi `json:"kpi,omitempty"` // It allows replacing an existing occurrence when set to true. ReplaceIfExists *bool `json:"Replace-If-Exists,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
CreateOccurrenceOptions : The CreateOccurrence options.
func (*CreateOccurrenceOptions) SetAccountID ¶
func (options *CreateOccurrenceOptions) SetAccountID(accountID string) *CreateOccurrenceOptions
SetAccountID : Allow user to set AccountID
func (*CreateOccurrenceOptions) SetContext ¶
func (options *CreateOccurrenceOptions) SetContext(context *Context) *CreateOccurrenceOptions
SetContext : Allow user to set Context
func (*CreateOccurrenceOptions) SetCreateTime ¶
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) 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) SetUpdateTime ¶
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 { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of note `name`: providers/{provider_id}/notes/{note_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of note `name`: providers/{provider_id}/notes/{note_id}. NoteID *string `json:"note_id" validate:"required"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
DeleteNoteOptions : The DeleteNote options.
func (*DeleteNoteOptions) SetAccountID ¶
func (options *DeleteNoteOptions) SetAccountID(accountID string) *DeleteNoteOptions
SetAccountID : Allow user to set AccountID
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
type DeleteOccurrenceOptions ¶
type DeleteOccurrenceOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of occurrence `name`: providers/{provider_id}/notes/{occurrence_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of occurrence `name`: providers/{provider_id}/notes/{occurrence_id}. OccurrenceID *string `json:"occurrence_id" validate:"required"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
DeleteOccurrenceOptions : The DeleteOccurrence options.
func (*DeleteOccurrenceOptions) SetAccountID ¶
func (options *DeleteOccurrenceOptions) SetAccountID(accountID string) *DeleteOccurrenceOptions
SetAccountID : Allow user to set AccountID
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
type Finding ¶
type Finding struct { // Severity : Note provider-assigned severity/impact ranking // - LOW: Low Impact // - MEDIUM: Medium Impact // - HIGH: High Impact. Severity *string `json:"severity,omitempty"` // Certainty : 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"` // Network connection details of this finding. NetworkConnection *NetworkConnection `json:"network_connection,omitempty"` // Data transferred details of this finding. DataTransferred *DataTransferred `json:"data_transferred,omitempty"` }
Finding : Finding provides details about a finding occurrence.
type FindingCountValueType ¶
type FindingCountValueType 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"` }
FindingCountValueType : FindingCountValueType struct
type FindingType ¶
type FindingType struct { // The default severity of the findings related to this `Note`. 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 FindingsApiV1 ¶
type FindingsApiV1 struct {
Service *core.BaseService
}
FindingsApiV1 : The Findings API
Version: 1.0.0
func NewFindingsApiV1 ¶
func NewFindingsApiV1(options *FindingsApiV1Options) (service *FindingsApiV1, err error)
NewFindingsApiV1 : constructs an instance of FindingsApiV1 with passed in options.
func NewFindingsApiV1UsingExternalConfig ¶
func NewFindingsApiV1UsingExternalConfig(options *FindingsApiV1Options) (findingsApi *FindingsApiV1, err error)
NewFindingsApiV1UsingExternalConfig : constructs an instance of FindingsApiV1 with passed in options and external configuration.
func (*FindingsApiV1) CreateNote ¶
func (findingsApi *FindingsApiV1) CreateNote(createNoteOptions *CreateNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
CreateNote : Creates a new `Note`
func (*FindingsApiV1) CreateOccurrence ¶
func (findingsApi *FindingsApiV1) CreateOccurrence(createOccurrenceOptions *CreateOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
CreateOccurrence : Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource
func (*FindingsApiV1) DeleteNote ¶
func (findingsApi *FindingsApiV1) DeleteNote(deleteNoteOptions *DeleteNoteOptions) (response *core.DetailedResponse, err error)
DeleteNote : Deletes the given `Note` from the system
func (*FindingsApiV1) DeleteOccurrence ¶
func (findingsApi *FindingsApiV1) DeleteOccurrence(deleteOccurrenceOptions *DeleteOccurrenceOptions) (response *core.DetailedResponse, err error)
DeleteOccurrence : Deletes the given `Occurrence` from the system
func (*FindingsApiV1) GetNote ¶
func (findingsApi *FindingsApiV1) GetNote(getNoteOptions *GetNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
GetNote : Returns the requested `Note`
func (*FindingsApiV1) GetOccurrence ¶
func (findingsApi *FindingsApiV1) GetOccurrence(getOccurrenceOptions *GetOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
GetOccurrence : Returns the requested `Occurrence`
func (*FindingsApiV1) GetOccurrenceNote ¶
func (findingsApi *FindingsApiV1) GetOccurrenceNote(getOccurrenceNoteOptions *GetOccurrenceNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
GetOccurrenceNote : Gets the `Note` attached to the given `Occurrence`
func (*FindingsApiV1) ListNoteOccurrences ¶
func (findingsApi *FindingsApiV1) ListNoteOccurrences(listNoteOccurrencesOptions *ListNoteOccurrencesOptions) (result *ApiListNoteOccurrencesResponse, response *core.DetailedResponse, err error)
ListNoteOccurrences : Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer providers
func (*FindingsApiV1) ListNotes ¶
func (findingsApi *FindingsApiV1) ListNotes(listNotesOptions *ListNotesOptions) (result *ApiListNotesResponse, response *core.DetailedResponse, err error)
ListNotes : Lists all `Notes` for a given provider
func (*FindingsApiV1) ListOccurrences ¶
func (findingsApi *FindingsApiV1) ListOccurrences(listOccurrencesOptions *ListOccurrencesOptions) (result *ApiListOccurrencesResponse, response *core.DetailedResponse, err error)
ListOccurrences : Lists active `Occurrences` for a given provider matching the filters
func (*FindingsApiV1) ListProviders ¶
func (findingsApi *FindingsApiV1) ListProviders(listProvidersOptions *ListProvidersOptions) (result *ApiListProvidersResponse, response *core.DetailedResponse, err error)
ListProviders : Lists all `Providers` for a given account id
func (*FindingsApiV1) NewApiNote ¶
func (findingsApi *FindingsApiV1) NewApiNote(shortDescription string, longDescription string, kind string, ID string, reportedBy *Reporter) (model *ApiNote, err error)
NewApiNote : Instantiate ApiNote (Generic Model Constructor)
func (*FindingsApiV1) NewApiOccurrence ¶
func (findingsApi *FindingsApiV1) NewApiOccurrence(noteName string, kind string, ID string) (model *ApiOccurrence, err error)
NewApiOccurrence : Instantiate ApiOccurrence (Generic Model Constructor)
func (*FindingsApiV1) NewBreakdownCardElement ¶
func (findingsApi *FindingsApiV1) NewBreakdownCardElement(kind string, text string, valueTypes []ValueType) (model *BreakdownCardElement, err error)
NewBreakdownCardElement : Instantiate BreakdownCardElement (Generic Model Constructor)
func (*FindingsApiV1) NewCard ¶
func (findingsApi *FindingsApiV1) NewCard(section string, title string, subtitle string, findingNoteNames []string, elements []CardElement) (model *Card, err error)
NewCard : Instantiate Card (Generic Model Constructor)
func (*FindingsApiV1) NewCardElement ¶
func (findingsApi *FindingsApiV1) NewCardElement(kind string, text string) (model *CardElement, err error)
NewCardElement : Instantiate CardElement (Generic Model Constructor)
func (*FindingsApiV1) NewCreateNoteOptions ¶
func (findingsApi *FindingsApiV1) NewCreateNoteOptions(accountID string, providerID string, shortDescription string, longDescription string, kind string, ID string, reportedBy *Reporter) *CreateNoteOptions
NewCreateNoteOptions : Instantiate CreateNoteOptions
func (*FindingsApiV1) NewCreateOccurrenceOptions ¶
func (findingsApi *FindingsApiV1) NewCreateOccurrenceOptions(accountID string, providerID string, noteName string, kind string, ID string) *CreateOccurrenceOptions
NewCreateOccurrenceOptions : Instantiate CreateOccurrenceOptions
func (*FindingsApiV1) NewDeleteNoteOptions ¶
func (findingsApi *FindingsApiV1) NewDeleteNoteOptions(accountID string, providerID string, noteID string) *DeleteNoteOptions
NewDeleteNoteOptions : Instantiate DeleteNoteOptions
func (*FindingsApiV1) NewDeleteOccurrenceOptions ¶
func (findingsApi *FindingsApiV1) NewDeleteOccurrenceOptions(accountID string, providerID string, occurrenceID string) *DeleteOccurrenceOptions
NewDeleteOccurrenceOptions : Instantiate DeleteOccurrenceOptions
func (*FindingsApiV1) NewFindingCountValueType ¶
func (findingsApi *FindingsApiV1) NewFindingCountValueType(kind string, findingNoteNames []string, text string) (model *FindingCountValueType, err error)
NewFindingCountValueType : Instantiate FindingCountValueType (Generic Model Constructor)
func (*FindingsApiV1) NewFindingType ¶
func (findingsApi *FindingsApiV1) NewFindingType(severity *string) (model *FindingType, err error)
NewFindingType : Instantiate FindingType (Generic Model Constructor)
func (*FindingsApiV1) NewGetNoteOptions ¶
func (findingsApi *FindingsApiV1) NewGetNoteOptions(accountID string, providerID string, noteID string) *GetNoteOptions
NewGetNoteOptions : Instantiate GetNoteOptions
func (*FindingsApiV1) NewGetOccurrenceNoteOptions ¶
func (findingsApi *FindingsApiV1) NewGetOccurrenceNoteOptions(accountID string, providerID string, occurrenceID string) *GetOccurrenceNoteOptions
NewGetOccurrenceNoteOptions : Instantiate GetOccurrenceNoteOptions
func (*FindingsApiV1) NewGetOccurrenceOptions ¶
func (findingsApi *FindingsApiV1) NewGetOccurrenceOptions(accountID string, providerID string, occurrenceID string) *GetOccurrenceOptions
NewGetOccurrenceOptions : Instantiate GetOccurrenceOptions
func (*FindingsApiV1) NewKpi ¶
func (findingsApi *FindingsApiV1) NewKpi(value float64) (model *Kpi, err error)
NewKpi : Instantiate Kpi (Generic Model Constructor)
func (*FindingsApiV1) NewKpiType ¶
func (findingsApi *FindingsApiV1) NewKpiType(aggregationType string) (model *KpiType, err error)
NewKpiType : Instantiate KpiType (Generic Model Constructor)
func (*FindingsApiV1) NewListNoteOccurrencesOptions ¶
func (findingsApi *FindingsApiV1) NewListNoteOccurrencesOptions(accountID string, providerID string, noteID string) *ListNoteOccurrencesOptions
NewListNoteOccurrencesOptions : Instantiate ListNoteOccurrencesOptions
func (*FindingsApiV1) NewListNotesOptions ¶
func (findingsApi *FindingsApiV1) NewListNotesOptions(accountID string, providerID string) *ListNotesOptions
NewListNotesOptions : Instantiate ListNotesOptions
func (*FindingsApiV1) NewListOccurrencesOptions ¶
func (findingsApi *FindingsApiV1) NewListOccurrencesOptions(accountID string, providerID string) *ListOccurrencesOptions
NewListOccurrencesOptions : Instantiate ListOccurrencesOptions
func (*FindingsApiV1) NewListProvidersOptions ¶
func (findingsApi *FindingsApiV1) NewListProvidersOptions(accountID string) *ListProvidersOptions
NewListProvidersOptions : Instantiate ListProvidersOptions
func (*FindingsApiV1) NewNumericCardElement ¶
func (findingsApi *FindingsApiV1) NewNumericCardElement(kind string, text string, valueType interface{}) (model *NumericCardElement, err error)
NewNumericCardElement : Instantiate NumericCardElement (Generic Model Constructor)
func (*FindingsApiV1) NewPostGraphOptions ¶
func (findingsApi *FindingsApiV1) NewPostGraphOptions(accountID string) *PostGraphOptions
NewPostGraphOptions : Instantiate PostGraphOptions
func (*FindingsApiV1) NewReporter ¶
func (findingsApi *FindingsApiV1) NewReporter(ID string, title string) (model *Reporter, err error)
NewReporter : Instantiate Reporter (Generic Model Constructor)
func (*FindingsApiV1) NewSection ¶
func (findingsApi *FindingsApiV1) NewSection(title string, image string) (model *Section, err error)
NewSection : Instantiate Section (Generic Model Constructor)
func (*FindingsApiV1) NewSocketAddress ¶
func (findingsApi *FindingsApiV1) NewSocketAddress(address string) (model *SocketAddress, err error)
NewSocketAddress : Instantiate SocketAddress (Generic Model Constructor)
func (*FindingsApiV1) NewTimeSeriesCardElement ¶
func (findingsApi *FindingsApiV1) NewTimeSeriesCardElement(kind string, text string, valueTypes []FindingCountValueType) (model *TimeSeriesCardElement, err error)
NewTimeSeriesCardElement : Instantiate TimeSeriesCardElement (Generic Model Constructor)
func (*FindingsApiV1) NewUpdateNoteOptions ¶
func (findingsApi *FindingsApiV1) NewUpdateNoteOptions(accountID string, providerID string, noteID string, shortDescription string, longDescription string, kind string, ID string, reportedBy *Reporter) *UpdateNoteOptions
NewUpdateNoteOptions : Instantiate UpdateNoteOptions
func (*FindingsApiV1) NewUpdateOccurrenceOptions ¶
func (findingsApi *FindingsApiV1) NewUpdateOccurrenceOptions(accountID string, providerID string, occurrenceID string, noteName string, kind string, ID string) *UpdateOccurrenceOptions
NewUpdateOccurrenceOptions : Instantiate UpdateOccurrenceOptions
func (*FindingsApiV1) NewValueType ¶
func (findingsApi *FindingsApiV1) NewValueType(kind string, text string) (model *ValueType, err error)
NewValueType : Instantiate ValueType (Generic Model Constructor)
func (*FindingsApiV1) PostGraph ¶
func (findingsApi *FindingsApiV1) PostGraph(postGraphOptions *PostGraphOptions) (response *core.DetailedResponse, err error)
PostGraph : query findings query findings.
func (*FindingsApiV1) SetServiceURL ¶
func (findingsApi *FindingsApiV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*FindingsApiV1) UpdateNote ¶
func (findingsApi *FindingsApiV1) UpdateNote(updateNoteOptions *UpdateNoteOptions) (result *ApiNote, response *core.DetailedResponse, err error)
UpdateNote : Updates an existing `Note`
func (*FindingsApiV1) UpdateOccurrence ¶
func (findingsApi *FindingsApiV1) UpdateOccurrence(updateOccurrenceOptions *UpdateOccurrenceOptions) (result *ApiOccurrence, response *core.DetailedResponse, err error)
UpdateOccurrence : Updates an existing `Occurrence`
type FindingsApiV1Options ¶
type FindingsApiV1Options struct { ServiceName string URL string Authenticator core.Authenticator }
FindingsApiV1Options : Service options
type GetNoteOptions ¶
type GetNoteOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of note `name`: providers/{provider_id}/notes/{note_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of note `name`: providers/{provider_id}/notes/{note_id}. NoteID *string `json:"note_id" validate:"required"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
GetNoteOptions : The GetNote options.
func (*GetNoteOptions) SetAccountID ¶
func (options *GetNoteOptions) SetAccountID(accountID string) *GetNoteOptions
SetAccountID : Allow user to set AccountID
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
type GetOccurrenceNoteOptions ¶
type GetOccurrenceNoteOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. OccurrenceID *string `json:"occurrence_id" validate:"required"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
GetOccurrenceNoteOptions : The GetOccurrenceNote options.
func (*GetOccurrenceNoteOptions) SetAccountID ¶
func (options *GetOccurrenceNoteOptions) SetAccountID(accountID string) *GetOccurrenceNoteOptions
SetAccountID : Allow user to set AccountID
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
type GetOccurrenceOptions ¶
type GetOccurrenceOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. OccurrenceID *string `json:"occurrence_id" validate:"required"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
GetOccurrenceOptions : The GetOccurrence options.
func (*GetOccurrenceOptions) SetAccountID ¶
func (options *GetOccurrenceOptions) SetAccountID(accountID string) *GetOccurrenceOptions
SetAccountID : Allow user to set AccountID
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
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 { // 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 { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of note `name`: providers/{provider_id}/notes/{note_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of note `name`: providers/{provider_id}/notes/{note_id}. NoteID *string `json:"note_id" validate:"required"` // 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 to be GDPR compliant Headers map[string]string }
ListNoteOccurrencesOptions : The ListNoteOccurrences options.
func (*ListNoteOccurrencesOptions) SetAccountID ¶
func (options *ListNoteOccurrencesOptions) SetAccountID(accountID string) *ListNoteOccurrencesOptions
SetAccountID : Allow user to set AccountID
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
type ListNotesOptions ¶
type ListNotesOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Part of `parent`. This field contains the provider_id for example: providers/{provider_id}. ProviderID *string `json:"provider_id" validate:"required"` // 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 to be GDPR compliant Headers map[string]string }
ListNotesOptions : The ListNotes options.
func (*ListNotesOptions) SetAccountID ¶
func (options *ListNotesOptions) SetAccountID(accountID string) *ListNotesOptions
SetAccountID : Allow user to set AccountID
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
type ListOccurrencesOptions ¶
type ListOccurrencesOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Part of `parent`. This contains the provider_id for example: providers/{provider_id}. ProviderID *string `json:"provider_id" validate:"required"` // Number of occurrences 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 to be GDPR compliant Headers map[string]string }
ListOccurrencesOptions : The ListOccurrences options.
func (*ListOccurrencesOptions) SetAccountID ¶
func (options *ListOccurrencesOptions) SetAccountID(accountID string) *ListOccurrencesOptions
SetAccountID : Allow user to set AccountID
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
type ListProvidersOptions ¶
type ListProvidersOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Limit the number of the returned documents to the specified number. 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 to include in the result (sorted in ascending order). Ignored if not provided. StartProviderID *string `json:"start_provider_id,omitempty"` // The last provider_id to include in the result (sorted in ascending order). Ignored if not provided. EndProviderID *string `json:"end_provider_id,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
ListProvidersOptions : The ListProviders options.
func (*ListProvidersOptions) SetAccountID ¶
func (options *ListProvidersOptions) SetAccountID(accountID string) *ListProvidersOptions
SetAccountID : Allow user to set AccountID
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
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"` // The client socket address of this network connection. Client *SocketAddress `json:"client,omitempty"` // The server socket address of this network connection. Server *SocketAddress `json:"server,omitempty"` }
NetworkConnection : It provides details about a network connection.
type NumericCardElement ¶
type NumericCardElement struct { // The kind of this card element. Kind *string `json:"kind" validate:"required"` // The text of this card element. Text *string `json:"text" validate:"required"` ValueType interface{} `json:"value_type" validate:"required"` }
NumericCardElement : A card element with a single numeric value.
type PostGraphOptions ¶
type PostGraphOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // Body for query findings. Body io.ReadCloser `json:"body,omitempty"` // The type of the input. ContentType *string `json:"Content-Type,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
PostGraphOptions : The PostGraph options.
func (*PostGraphOptions) SetAccountID ¶
func (options *PostGraphOptions) SetAccountID(accountID string) *PostGraphOptions
SetAccountID : Allow user to set AccountID
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
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 Severity ¶
type Severity struct { }
Severity : Note provider-assigned severity/impact ranking - LOW: Low Impact - MEDIUM: Medium Impact - HIGH: High Impact. - CRITICAL: Critical Impact.
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 TimeSeriesCardElement ¶
type TimeSeriesCardElement struct { // The kind of this card element. Kind *string `json:"kind" validate:"required"` // 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"` // the value types associated to this card element. ValueTypes []FindingCountValueType `json:"value_types" validate:"required"` }
TimeSeriesCardElement : A card element with a time series chart.
type UpdateNoteOptions ¶
type UpdateNoteOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of note `name`: providers/{provider_id}/notes/{note_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of note `name`: providers/{provider_id}/notes/{note_id}. NoteID *string `json:"note_id" validate:"required"` // A one sentence description of this `Note`. ShortDescription *string `json:"short_description" validate:"required"` // A detailed description of this `Note`. LongDescription *string `json:"long_description" validate:"required"` // Output only. This explicitly denotes which kind of note is specified. This // field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` ID *string `json:"id" validate:"required"` // Details about the reporter of this `Note`. ReportedBy *Reporter `json:"reported_by" validate:"required"` RelatedURL []ApiNoteRelatedURL `json:"related_url,omitempty"` // Time of expiration for this note, null if note does not expire. ExpirationTime *strfmt.DateTime `json:"expiration_time,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"` Shared *bool `json:"shared,omitempty"` // The finding details of the note. Finding *FindingType `json:"finding,omitempty"` // The KPI details of the note. Kpi *KpiType `json:"kpi,omitempty"` // The card details of the note. Card *Card `json:"card,omitempty"` // The section details of the note. Section *Section `json:"section,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
UpdateNoteOptions : The UpdateNote options.
func (*UpdateNoteOptions) SetAccountID ¶
func (options *UpdateNoteOptions) SetAccountID(accountID string) *UpdateNoteOptions
SetAccountID : Allow user to set AccountID
func (*UpdateNoteOptions) SetCard ¶
func (options *UpdateNoteOptions) SetCard(card *Card) *UpdateNoteOptions
SetCard : Allow user to set Card
func (*UpdateNoteOptions) SetCreateTime ¶
func (options *UpdateNoteOptions) SetCreateTime(createTime *strfmt.DateTime) *UpdateNoteOptions
SetCreateTime : Allow user to set CreateTime
func (*UpdateNoteOptions) SetExpirationTime ¶
func (options *UpdateNoteOptions) SetExpirationTime(expirationTime *strfmt.DateTime) *UpdateNoteOptions
SetExpirationTime : Allow user to set ExpirationTime
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) SetUpdateTime ¶
func (options *UpdateNoteOptions) SetUpdateTime(updateTime *strfmt.DateTime) *UpdateNoteOptions
SetUpdateTime : Allow user to set UpdateTime
type UpdateOccurrenceOptions ¶
type UpdateOccurrenceOptions struct { // Account ID. AccountID *string `json:"account_id" validate:"required"` // First part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. ProviderID *string `json:"provider_id" validate:"required"` // Second part of occurrence `name`: providers/{provider_id}/occurrences/{occurrence_id}. OccurrenceID *string `json:"occurrence_id" validate:"required"` // 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"` // Output only. This explicitly denotes which of the `Occurrence` details are specified. // This field can be used as a filter in list requests. Kind *string `json:"kind" validate:"required"` 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"` 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"` // Details about the context of this `Occurrence`. Context *Context `json:"context,omitempty"` // Details of the occurrence of a finding. Finding *Finding `json:"finding,omitempty"` // Details of the occurrence of a KPI. Kpi *Kpi `json:"kpi,omitempty"` // Allows users to set headers to be GDPR compliant Headers map[string]string }
UpdateOccurrenceOptions : The UpdateOccurrence options.
func (*UpdateOccurrenceOptions) SetAccountID ¶
func (options *UpdateOccurrenceOptions) SetAccountID(accountID string) *UpdateOccurrenceOptions
SetAccountID : Allow user to set AccountID
func (*UpdateOccurrenceOptions) SetContext ¶
func (options *UpdateOccurrenceOptions) SetContext(context *Context) *UpdateOccurrenceOptions
SetContext : Allow user to set Context
func (*UpdateOccurrenceOptions) SetCreateTime ¶
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) 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) SetUpdateTime ¶
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 // - FINDING_COUNT: Kind of value derived from a count of finding occurrences. Kind *string `json:"kind" validate:"required"` // The text of this element type. Text *string `json:"text" validate:"required"` }
ValueType : the value type of a card element.