| | |
- builtins.object
-
- ApiListNoteOccurrencesResponse
- ApiListNotesResponse
- ApiListOccurrencesResponse
- ApiListProvidersResponse
- ApiNote
- ApiNoteKind
- ApiNoteRelatedUrl
- ApiOccurrence
- ApiProvider
- Card
- CardElement
-
- BreakdownCardElement
- NumericCardElement
- TimeSeriesCardElement
- Certainty
- Context
- DataTransferred
- Finding
- FindingCountValueType
- FindingType
- Kpi
- KpiType
- NetworkConnection
- PostGraphEnums
- RemediationStep
- Reporter
- Section
- Severity
- SocketAddress
- ValueType
- ibm_cloud_sdk_core.base_service.BaseService(builtins.object)
-
- FindingsApiV1
class ApiListNoteOccurrencesResponse(builtins.object) |
| |
ApiListNoteOccurrencesResponse(*, occurrences: List[ForwardRef('ApiOccurrence')] = None, next_page_token: str = None) -> None
Response including listed occurrences for a note.
:attr List[ApiOccurrence] occurrences: (optional) The occurrences attached to
the specified note.
:attr str next_page_token: (optional) Token to receive the next page of notes.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiListNoteOccurrencesResponse') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, occurrences: List[ForwardRef('ApiOccurrence')] = None, next_page_token: str = None) -> None
- Initialize a ApiListNoteOccurrencesResponse object.
:param List[ApiOccurrence] occurrences: (optional) The occurrences attached
to the specified note.
:param str next_page_token: (optional) Token to receive the next page of
notes.
- __ne__(self, other: 'ApiListNoteOccurrencesResponse') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiListNoteOccurrencesResponse object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiListNoteOccurrencesResponse' from builtins.type
- Initialize a ApiListNoteOccurrencesResponse object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiListNotesResponse(builtins.object) |
| |
ApiListNotesResponse(*, notes: List[ForwardRef('ApiNote')] = None, next_page_token: str = None) -> None
Response including listed notes.
:attr List[ApiNote] notes: (optional)
:attr str next_page_token: (optional) 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.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiListNotesResponse') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, notes: List[ForwardRef('ApiNote')] = None, next_page_token: str = None) -> None
- Initialize a ApiListNotesResponse object.
:param List[ApiNote] notes: (optional)
:param str next_page_token: (optional) 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.
- __ne__(self, other: 'ApiListNotesResponse') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiListNotesResponse object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiListNotesResponse' from builtins.type
- Initialize a ApiListNotesResponse object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiListOccurrencesResponse(builtins.object) |
| |
ApiListOccurrencesResponse(*, occurrences: List[ForwardRef('ApiOccurrence')] = None, next_page_token: str = None) -> None
Response including listed active occurrences.
:attr List[ApiOccurrence] occurrences: (optional) The occurrences requested.
:attr str next_page_token: (optional) 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.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiListOccurrencesResponse') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, occurrences: List[ForwardRef('ApiOccurrence')] = None, next_page_token: str = None) -> None
- Initialize a ApiListOccurrencesResponse object.
:param List[ApiOccurrence] occurrences: (optional) The occurrences
requested.
:param str next_page_token: (optional) 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.
- __ne__(self, other: 'ApiListOccurrencesResponse') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiListOccurrencesResponse object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiListOccurrencesResponse' from builtins.type
- Initialize a ApiListOccurrencesResponse object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiNote(builtins.object) |
| |
ApiNote(short_description: str, long_description: str, kind: 'ApiNoteKind', id: str, reported_by: 'Reporter', *, related_url: List[ForwardRef('ApiNoteRelatedUrl')] = None, expiration_time: datetime.datetime = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, shared: bool = None, finding: 'FindingType' = None, kpi: 'KpiType' = None, card: 'Card' = None, section: 'Section' = None) -> None
Provides a detailed description of a `Note`.
:attr str short_description: A one sentence description of this `Note`.
:attr str long_description: A detailed description of this `Note`.
:attr ApiNoteKind kind: Output only. This explicitly denotes which kind of note
is specified. This
field can be used as a filter in list requests.
:attr List[ApiNoteRelatedUrl] related_url: (optional)
:attr datetime expiration_time: (optional) Time of expiration for this note,
null if note does not expire.
:attr datetime create_time: (optional) Output only. The time this note was
created. This field can be used as a filter in list requests.
:attr datetime update_time: (optional) Output only. The time this note was last
updated. This field can be used as a filter in list requests.
:attr str id:
:attr bool shared: (optional) True if this `Note` can be shared by multiple
accounts.
:attr Reporter reported_by: Details about the reporter of this `Note`.
:attr FindingType finding: (optional) The finding details of the note.
:attr KpiType kpi: (optional) The KPI details of the note.
:attr Card card: (optional) The card details of the note.
:attr Section section: (optional) The section details of the note.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiNote') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, short_description: str, long_description: str, kind: 'ApiNoteKind', id: str, reported_by: 'Reporter', *, related_url: List[ForwardRef('ApiNoteRelatedUrl')] = None, expiration_time: datetime.datetime = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, shared: bool = None, finding: 'FindingType' = None, kpi: 'KpiType' = None, card: 'Card' = None, section: 'Section' = None) -> None
- Initialize a ApiNote object.
:param str short_description: A one sentence description of this `Note`.
:param str long_description: A detailed description of this `Note`.
:param ApiNoteKind kind: Output only. This explicitly denotes which kind of
note is specified. This
field can be used as a filter in list requests.
:param str id:
:param Reporter reported_by: Details about the reporter of this `Note`.
:param List[ApiNoteRelatedUrl] related_url: (optional)
:param datetime expiration_time: (optional) Time of expiration for this
note, null if note does not expire.
:param datetime create_time: (optional) Output only. The time this note was
created. This field can be used as a filter in list requests.
:param datetime update_time: (optional) Output only. The time this note was
last updated. This field can be used as a filter in list requests.
:param bool shared: (optional) True if this `Note` can be shared by
multiple accounts.
:param FindingType finding: (optional) The finding details of the note.
:param KpiType kpi: (optional) The KPI details of the note.
:param Card card: (optional) The card details of the note.
:param Section section: (optional) The section details of the note.
- __ne__(self, other: 'ApiNote') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiNote object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiNote' from builtins.type
- Initialize a ApiNote object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiNoteKind(builtins.object) |
| |
ApiNoteKind() -> None
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.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiNoteKind') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self) -> None
- Initialize a ApiNoteKind object.
- __ne__(self, other: 'ApiNoteKind') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiNoteKind object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiNoteKind' from builtins.type
- Initialize a ApiNoteKind object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiNoteRelatedUrl(builtins.object) |
| |
ApiNoteRelatedUrl(*, label: str = None, url: str = None) -> None
Metadata for any related URL information.
:attr str label: (optional)
:attr str url: (optional)
|
| |
Methods defined here:
- __eq__(self, other: 'ApiNoteRelatedUrl') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, label: str = None, url: str = None) -> None
- Initialize a ApiNoteRelatedUrl object.
:param str label: (optional)
:param str url: (optional)
- __ne__(self, other: 'ApiNoteRelatedUrl') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiNoteRelatedUrl object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiNoteRelatedUrl' from builtins.type
- Initialize a ApiNoteRelatedUrl object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiOccurrence(builtins.object) |
| |
ApiOccurrence(note_name: str, kind: 'ApiNoteKind', id: str, *, resource_url: str = None, remediation: str = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, context: 'Context' = None, finding: 'Finding' = None, kpi: 'Kpi' = None) -> None
`Occurrence` includes information about analysis occurrences for an image.
:attr str resource_url: (optional) 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.
:attr str note_name: 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.
:attr ApiNoteKind kind: Output only. This explicitly denotes which of the
`Occurrence` details are specified.
This field can be used as a filter in list requests.
:attr str remediation: (optional)
:attr datetime create_time: (optional) Output only. The time this `Occurrence`
was created.
:attr datetime update_time: (optional) Output only. The time this `Occurrence`
was last updated.
:attr str id:
:attr Context context: (optional) Details about the context of this
`Occurrence`.
:attr Finding finding: (optional) Details of the occurrence of a finding.
:attr Kpi kpi: (optional) Details of the occurrence of a KPI.
|
| |
Methods defined here:
- __eq__(self, other: 'ApiOccurrence') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, note_name: str, kind: 'ApiNoteKind', id: str, *, resource_url: str = None, remediation: str = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, context: 'Context' = None, finding: 'Finding' = None, kpi: 'Kpi' = None) -> None
- Initialize a ApiOccurrence object.
:param str note_name: 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.
:param ApiNoteKind kind: Output only. This explicitly denotes which of the
`Occurrence` details are specified.
This field can be used as a filter in list requests.
:param str id:
:param str resource_url: (optional) 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.
:param str remediation: (optional)
:param datetime create_time: (optional) Output only. The time this
`Occurrence` was created.
:param datetime update_time: (optional) Output only. The time this
`Occurrence` was last updated.
:param Context context: (optional) Details about the context of this
`Occurrence`.
:param Finding finding: (optional) Details of the occurrence of a finding.
:param Kpi kpi: (optional) Details of the occurrence of a KPI.
- __ne__(self, other: 'ApiOccurrence') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiOccurrence object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiOccurrence' from builtins.type
- Initialize a ApiOccurrence object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class ApiProvider(builtins.object) |
| |
ApiProvider(name: str, id: str) -> None
Provides a detailed description of a `Provider`.
:attr str name:
:attr str id:
|
| |
Methods defined here:
- __eq__(self, other: 'ApiProvider') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, name: str, id: str) -> None
- Initialize a ApiProvider object.
:param str name:
:param str id:
- __ne__(self, other: 'ApiProvider') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ApiProvider object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ApiProvider' from builtins.type
- Initialize a ApiProvider object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class BreakdownCardElement(CardElement) |
| |
BreakdownCardElement(kind: str, text: str, value_types: List[ForwardRef('ValueType')], *, default_time_range: str = None) -> None
A card element with a breakdown of values.
:attr str text: The text of this card element.
:attr List[ValueType] value_types: the value types associated to this card
element.
|
| |
- Method resolution order:
- BreakdownCardElement
- CardElement
- builtins.object
Methods defined here:
- __eq__(self, other: 'BreakdownCardElement') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, text: str, value_types: List[ForwardRef('ValueType')], *, default_time_range: str = None) -> None
- Initialize a BreakdownCardElement object.
:param str kind: Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
:param str text: The text of this card element.
:param List[ValueType] value_types: the value types associated to this card
element.
:param str default_time_range: (optional) The default time range of this
card element.
- __ne__(self, other: 'BreakdownCardElement') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this BreakdownCardElement object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'BreakdownCardElement' from builtins.type
- Initialize a BreakdownCardElement object from a json dictionary.
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
- __hash__ = None
Data descriptors inherited from CardElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class Card(builtins.object) |
| |
Card(section: str, title: str, subtitle: str, finding_note_names: List[str], elements: List[ForwardRef('CardElement')], *, order: int = None, requires_configuration: bool = None, badge_text: str = None, badge_image: str = None) -> None
Card provides details about a card kind of note.
{
"section": "string",
"title": "string",
"subtitle": "string",
"order": 1,
"finding_note_names": [
"string"
],
"requires_configuration": false,
"badge_text": "string",
"badge_image": "string",
"elements": [
{
"kind": "NUMERIC",
"default_time_range": "4d"
}
]
}
:attr str section: The section this card belongs to.
:attr str title: The title of this card.
:attr str subtitle: The subtitle of this card.
:attr int order: (optional) The order of the card in which it will appear on SA
dashboard in the mentioned section.
:attr List[str] finding_note_names: The finding note names associated to this
card.
:attr bool requires_configuration: (optional)
:attr str badge_text: (optional) The text associated to the card's badge.
:attr str badge_image: (optional) The base64 content of the image associated to
the card's badge.
:attr List[CardElement] elements: The elements of this card.
|
| |
Methods defined here:
- __eq__(self, other: 'Card') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, section: str, title: str, subtitle: str, finding_note_names: List[str], elements: List[ForwardRef('CardElement')], *, order: int = None, requires_configuration: bool = None, badge_text: str = None, badge_image: str = None) -> None
- Initialize a Card object.
:param str section: The section this card belongs to.
:param str title: The title of this card.
:param str subtitle: The subtitle of this card.
:param List[str] finding_note_names: The finding note names associated to
this card.
:param List[CardElement] elements: The elements of this card.
:param int order: (optional) The order of the card in which it will appear
on SA dashboard in the mentioned section.
:param bool requires_configuration: (optional)
:param str badge_text: (optional) The text associated to the card's badge.
:param str badge_image: (optional) The base64 content of the image
associated to the card's badge.
- __ne__(self, other: 'Card') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Card object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Card' from builtins.type
- Initialize a Card object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class CardElement(builtins.object) |
| |
CardElement(kind: str, *, default_time_range: str = None) -> None
CardElement provides details about the elements of a Card.
:attr str kind: Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
:attr str default_time_range: (optional) The default time range of this card
element.
|
| |
Methods defined here:
- __eq__(self, other: 'CardElement') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, *, default_time_range: str = None) -> None
- Initialize a CardElement object.
:param str kind: Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
:param str default_time_range: (optional) The default time range of this
card element.
- __ne__(self, other: 'CardElement') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this CardElement object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'CardElement' from builtins.type
- Initialize a CardElement object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
- __hash__ = None
|
class Certainty(builtins.object) |
| |
Certainty() -> None
Note provider-assigned confidence on the validity of an occurrence
- LOW: Low Certainty
- MEDIUM: Medium Certainty
- HIGH: High Certainty.
|
| |
Methods defined here:
- __eq__(self, other: 'Certainty') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self) -> None
- Initialize a Certainty object.
- __ne__(self, other: 'Certainty') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Certainty object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Certainty' from builtins.type
- Initialize a Certainty object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class Context(builtins.object) |
| |
Context(*, region: str = None, resource_crn: str = None, resource_id: str = None, resource_name: str = None, resource_type: str = None, service_crn: str = None, service_name: str = None, environment_name: str = None, component_name: str = None, toolchain_id: str = None) -> None
Context.
{
"region": "string",
"resource_crn": "string",
"resource_id": "string",
"resource_name": "string",
"resource_type": "string",
"service_crn": "string",
"service_name": "string",
"environment_name": "string",
"component_name": "string",
"toolchain_id": "string"
}
:attr str region: (optional) The IBM Cloud region.
:attr str resource_crn: (optional) The resource CRN (e.g. certificate CRN, image
CRN).
:attr str resource_id: (optional) The resource ID, in case the CRN is not
available.
:attr str resource_name: (optional) The user-friendly resource name.
:attr str resource_type: (optional) The resource type name (e.g. Pod, Cluster,
Certificate, Image).
:attr str service_crn: (optional) The service CRN (e.g. CertMgr Instance CRN).
:attr str service_name: (optional) The service name (e.g. CertMgr).
:attr str environment_name: (optional) The name of the environment the
occurrence applies to.
:attr str component_name: (optional) The name of the component the occurrence
applies to.
:attr str toolchain_id: (optional) The id of the toolchain the occurrence
applies to.
|
| |
Methods defined here:
- __eq__(self, other: 'Context') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, region: str = None, resource_crn: str = None, resource_id: str = None, resource_name: str = None, resource_type: str = None, service_crn: str = None, service_name: str = None, environment_name: str = None, component_name: str = None, toolchain_id: str = None) -> None
- Initialize a Context object.
:param str region: (optional) The IBM Cloud region.
:param str resource_crn: (optional) The resource CRN (e.g. certificate CRN,
image CRN).
:param str resource_id: (optional) The resource ID, in case the CRN is not
available.
:param str resource_name: (optional) The user-friendly resource name.
:param str resource_type: (optional) The resource type name (e.g. Pod,
Cluster, Certificate, Image).
:param str service_crn: (optional) The service CRN (e.g. CertMgr Instance
CRN).
:param str service_name: (optional) The service name (e.g. CertMgr).
:param str environment_name: (optional) The name of the environment the
occurrence applies to.
:param str component_name: (optional) The name of the component the
occurrence applies to.
:param str toolchain_id: (optional) The id of the toolchain the occurrence
applies to.
- __ne__(self, other: 'Context') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Context object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Context' from builtins.type
- Initialize a Context object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class DataTransferred(builtins.object) |
| |
DataTransferred(*, client_bytes: int = None, server_bytes: int = None, client_packets: int = None, server_packets: int = None) -> None
It provides details about data transferred between clients and servers.
:attr int client_bytes: (optional) The number of client bytes transferred.
:attr int server_bytes: (optional) The number of server bytes transferred.
:attr int client_packets: (optional) The number of client packets transferred.
:attr int server_packets: (optional) The number of server packets transferred.
|
| |
Methods defined here:
- __eq__(self, other: 'DataTransferred') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, client_bytes: int = None, server_bytes: int = None, client_packets: int = None, server_packets: int = None) -> None
- Initialize a DataTransferred object.
:param int client_bytes: (optional) The number of client bytes transferred.
:param int server_bytes: (optional) The number of server bytes transferred.
:param int client_packets: (optional) The number of client packets
transferred.
:param int server_packets: (optional) The number of server packets
transferred.
- __ne__(self, other: 'DataTransferred') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this DataTransferred object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'DataTransferred' from builtins.type
- Initialize a DataTransferred object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class Finding(builtins.object) |
| |
Finding(*, severity: 'Severity' = None, certainty: 'Certainty' = None, next_steps: List[ForwardRef('RemediationStep')] = None, network_connection: 'NetworkConnection' = None, data_transferred: 'DataTransferred' = None) -> None
Finding provides details about a finding occurrence.
{
"severity": "LOW",
"certainty": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
],
"network_connection": {
"direction": "string",
"protocol": "string",
"client": {
"address": "string",
"port": 0
},
"server": {
"address": "string",
"port": 0
}
},
"data_transferred": {
"client_bytes": 0,
"server_bytes": 0,
"client_packets": 0,
"server_packets": 0
}
}
:attr Severity severity: (optional) The common severity of this `Occurrence`.
:attr Certainty certainty: (optional) The confidence level on this `Occurrence`.
:attr List[RemediationStep] next_steps: (optional) Remediation steps for the
issues reported in this finding. They override the note's next steps.
:attr NetworkConnection network_connection: (optional) Network connection
details of this finding.
:attr DataTransferred data_transferred: (optional) Data transferred details of
this finding.
|
| |
Methods defined here:
- __eq__(self, other: 'Finding') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, severity: 'Severity' = None, certainty: 'Certainty' = None, next_steps: List[ForwardRef('RemediationStep')] = None, network_connection: 'NetworkConnection' = None, data_transferred: 'DataTransferred' = None) -> None
- Initialize a Finding object.
:param Severity severity: (optional) The common severity of this
`Occurrence`.
:param Certainty certainty: (optional) The confidence level on this
`Occurrence`.
:param List[RemediationStep] next_steps: (optional) Remediation steps for
the issues reported in this finding. They override the note's next steps.
:param NetworkConnection network_connection: (optional) Network connection
details of this finding.
:param DataTransferred data_transferred: (optional) Data transferred
details of this finding.
- __ne__(self, other: 'Finding') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Finding object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Finding' from builtins.type
- Initialize a Finding object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class FindingCountValueType(builtins.object) |
| |
FindingCountValueType(kind: str, finding_note_names: List[str], text: str) -> None
FindingCountValueType.
:attr str kind: Kind of element
- FINDING_COUNT: Kind of value derived from a count of finding occurrences.
:attr List[str] finding_note_names: the names of the finding note associated
that act as filters for counting the occurrences.
:attr str text: The text of this element type.
|
| |
Methods defined here:
- __eq__(self, other: 'FindingCountValueType') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, finding_note_names: List[str], text: str) -> None
- Initialize a FindingCountValueType object.
:param str kind: Kind of element
- FINDING_COUNT: Kind of value derived from a count of finding
occurrences.
:param List[str] finding_note_names: the names of the finding note
associated that act as filters for counting the occurrences.
:param str text: The text of this element type.
- __ne__(self, other: 'FindingCountValueType') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this FindingCountValueType object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'FindingCountValueType' from builtins.type
- Initialize a FindingCountValueType object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- FINDING_COUNT: Kind of value derived from a count of finding occurrences.
- __hash__ = None
|
class FindingType(builtins.object) |
| |
FindingType(severity: 'Severity', *, next_steps: List[ForwardRef('RemediationStep')] = None) -> None
FindingType provides details about a finding note.
{
"severity": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
]
}
:attr Severity severity: The default severity of the findings related to this
`Note`.
:attr List[RemediationStep] next_steps: (optional) Common remediation steps for
the finding of this type.
|
| |
Methods defined here:
- __eq__(self, other: 'FindingType') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, severity: 'Severity', *, next_steps: List[ForwardRef('RemediationStep')] = None) -> None
- Initialize a FindingType object.
:param Severity severity: The default severity of the findings related to
this `Note`.
:param List[RemediationStep] next_steps: (optional) Common remediation
steps for the finding of this type.
- __ne__(self, other: 'FindingType') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this FindingType object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'FindingType' from builtins.type
- Initialize a FindingType object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class FindingsApiV1(ibm_cloud_sdk_core.base_service.BaseService) |
| |
FindingsApiV1(authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None, service_name: str = 'findings_api', enable_error_log: bool = False) -> None
The Findings API V1 service.
|
| |
- Method resolution order:
- FindingsApiV1
- ibm_cloud_sdk_core.base_service.BaseService
- builtins.object
Methods defined here:
- __init__(self, authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None, service_name: str = 'findings_api', enable_error_log: bool = False) -> None
- Construct a new client for the Findings API service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/master/README.md
about initializing the authenticator of your choice.
- create_note(self, account_id: str, provider_id: str, short_description: str, long_description: str, kind: 'ApiNoteKind', id: str, reported_by: 'Reporter', *, related_url: List[ForwardRef('ApiNoteRelatedUrl')] = None, expiration_time: datetime.datetime = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, shared: bool = None, finding: 'FindingType' = None, kpi: 'KpiType' = None, card: 'Card' = None, section: 'Section' = None, **kwargs) -> 'DetailedResponse'
- Creates a new `Note`.
:param str account_id: Account ID.
:param str provider_id: Part of `parent`. This field contains the
provider_id for example: providers/{provider_id}.
:param str short_description: A one sentence description of this `Note`.
:param str long_description: A detailed description of this `Note`.
:param ApiNoteKind kind: Output only. This explicitly denotes which
kind of note is specified. This
field can be used as a filter in list requests.
kind could be -
- FINDING
- KPI
- CARD
- CARD_CONFIGURED
- SECTION
example:
kind="FINDING"
:param str id:
:param Reporter reported_by: Details about the reporter of this `Note`.
example-
reported_by={'id':'1','title':'test1','url':'www.test.com'},
:param List[ApiNoteRelatedUrl] related_url: (optional)
:param datetime expiration_time: (optional) Time of expiration for this
note, null if note does not expire.
:param datetime create_time: (optional) Output only. The time this note was
created. This field can be used as a filter in list requests.
:param datetime update_time: (optional) Output only. The time this note was
last updated. This field can be used as a filter in list requests.
:param bool shared: (optional) True if this `Note` can be shared by
multiple accounts.
:param FindingType finding: (optional) The finding details of the note.
example -
finding={
"severity": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
]
}
:param KpiType kpi: (optional) The KPI details of the note.
example -
kpi={
"aggregation_type":"SUM",
}
:param Card card: (optional) The card details of the note.
example -
card={
"elements": [
{
"default_time_range": "1d",
"kind": "NUMERIC",
"text": "Count of findings reported by my security tool",
"value_type": {
"finding_note_names": [
"providers/sdktest/notes/sdk_note_name1"
],
"kind": "FINDING_COUNT"
}
}
],
"finding_note_names": [
"providers/sdktest/notes/sdk_note_name1"
],
"section": "My Security Tools",
"order": 1,
"title": "My Security Tool Findings",
"subtitle": "My Security Tool",
}
:param Section section: (optional) The section details of the note.
example -
section={
"title":"s1",
"image":"s1img"
}
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- create_occurrence(self, account_id: str, provider_id: str, note_name: str, kind: 'ApiNoteKind', id: str, *, resource_url: str = None, remediation: str = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, context: 'Context' = None, finding: 'Finding' = None, kpi: 'Kpi' = None, replace_if_exists: bool = None, **kwargs) -> 'DetailedResponse'
- Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.
:param str account_id: Account ID.
:param str provider_id: Part of `parent`. This contains the provider_id for
example: providers/{provider_id}.
:param str note_name: 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.
:param ApiNoteKind kind: Output only. This explicitly denotes which of the
`Occurrence` details are specified.
This field can be used as a filter in list requests.
kind could be -
- FINDING
- KPI
- CARD
- CARD_CONFIGURED
- SECTION
example:
kind="FINDING"
:param str id:
:param str resource_url: (optional) 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.
:param str remediation: (optional)
:param datetime create_time: (optional) Output only. The time this
`Occurrence` was created.
:param datetime update_time: (optional) Output only. The time this
`Occurrence` was last updated.
:param Context context: (optional) Details about the context of this
`Occurrence`.
example -
context = {
"region": "us-south",
"resource_type": "Cluster",
"service_name": "Kubernetes Cluster",
"account_id": "abc123"
}
:param Finding finding: (optional) Details of the occurrence of a
finding.
example -
finding = {
"severity": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
]
}
:param Kpi kpi: (optional) Details of the occurrence of a KPI.
example -
kpi={
"value":1,
"total":1
}
:param bool replace_if_exists: (optional) It allows replacing an existing
occurrence when set to true.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- delete_note(self, account_id: str, provider_id: str, note_id: str, **kwargs) -> 'DetailedResponse'
- Deletes the given `Note` from the system.
:param str account_id: Account ID.
:param str provider_id: First part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param str note_id: Second part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- delete_occurrence(self, account_id: str, provider_id: str, occurrence_id: str, **kwargs) -> 'DetailedResponse'
- Deletes the given `Occurrence` from the system.
:param str account_id: Account ID.
:param str provider_id: First part of occurrence `name`:
providers/{provider_id}/notes/{occurrence_id}.
:param str occurrence_id: Second part of occurrence `name`:
providers/{provider_id}/notes/{occurrence_id}.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- get_note(self, account_id: str, provider_id: str, note_id: str, **kwargs) -> 'DetailedResponse'
- Returns the requested `Note`.
:param str account_id: Account ID.
:param str provider_id: First part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param str note_id: Second part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- get_occurrence(self, account_id: str, provider_id: str, occurrence_id: str, **kwargs) -> 'DetailedResponse'
- Returns the requested `Occurrence`.
:param str account_id: Account ID.
:param str provider_id: First part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param str occurrence_id: Second part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- get_occurrence_note(self, account_id: str, provider_id: str, occurrence_id: str, **kwargs) -> 'DetailedResponse'
- Gets the `Note` attached to the given `Occurrence`.
:param str account_id: Account ID.
:param str provider_id: First part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param str occurrence_id: Second part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- list_note_occurrences(self, account_id: str, provider_id: str, note_id: str, *, page_size: int = None, page_token: str = None, **kwargs) -> 'DetailedResponse'
- Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer providers.
:param str account_id: Account ID.
:param str provider_id: First part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param str note_id: Second part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param int page_size: (optional) Number of notes to return in the list.
:param str page_token: (optional) Token to provide to skip to a particular
spot in the list.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- list_notes(self, account_id: str, provider_id: str, *, page_size: int = None, page_token: str = None, **kwargs) -> 'DetailedResponse'
- Lists all `Notes` for a given provider.
:param str account_id: Account ID.
:param str provider_id: Part of `parent`. This field contains the
provider_id for example: providers/{provider_id}.
:param int page_size: (optional) Number of notes to return in the list.
:param str page_token: (optional) Token to provide to skip to a particular
spot in the list.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- list_occurrences(self, account_id: str, provider_id: str, *, page_size: int = None, page_token: str = None, **kwargs) -> 'DetailedResponse'
- Lists active `Occurrences` for a given provider matching the filters.
:param str account_id: Account ID.
:param str provider_id: Part of `parent`. This contains the provider_id for
example: providers/{provider_id}.
:param int page_size: (optional) Number of occurrences to return in the
list.
:param str page_token: (optional) Token to provide to skip to a particular
spot in the list.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- list_providers(self, account_id: str, *, limit: int = None, skip: int = None, start_provider_id: str = None, end_provider_id: str = None, **kwargs) -> 'DetailedResponse'
- Lists all `Providers` for a given account id.
:param str account_id: Account ID.
:param int limit: (optional) Limit the number of the returned documents to
the specified number.
:param int skip: (optional) The offset is the index of the item from which
you want to start returning data from. Default is 0.
:param str start_provider_id: (optional) The first provider_id to include
in the result (sorted in ascending order). Ignored if not provided.
:param str end_provider_id: (optional) The last provider_id to include in
the result (sorted in ascending order). Ignored if not provided.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- post_graph(self, account_id: str, body: str, *, content_type: str = None, **kwargs) -> 'DetailedResponse'
- Query findings.
:param str account_id: Account ID.
:param str body: Body for query findings.
:param str content_type: (optional) The type of the input.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- update_note(self, account_id: str, provider_id: str, note_id: str, short_description: str, long_description: str, kind: 'ApiNoteKind', id: str, reported_by: 'Reporter', *, related_url: List[ForwardRef('ApiNoteRelatedUrl')] = None, expiration_time: datetime.datetime = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, shared: bool = None, finding: 'FindingType' = None, kpi: 'KpiType' = None, card: 'Card' = None, section: 'Section' = None, **kwargs) -> 'DetailedResponse'
- Updates an existing `Note`.
:param str account_id: Account ID.
:param str provider_id: First part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param str note_id: Second part of note `name`:
providers/{provider_id}/notes/{note_id}.
:param str short_description: A one sentence description of this `Note`.
:param str long_description: A detailed description of this `Note`.
:param ApiNoteKind kind: Output only. This explicitly denotes which
kind of note is specified. This
field can be used as a filter in list requests.
kind could be -
- FINDING
- KPI
- CARD
- CARD_CONFIGURED
- SECTION
example:
kind="FINDING"
:param str id:
:param Reporter reported_by: Details about the reporter of this `Note`.
example-
reported_by={'id':'1','title':'test1','url':'www.test.com'},
:param List[ApiNoteRelatedUrl] related_url: (optional)
:param datetime expiration_time: (optional) Time of expiration for this
note, null if note does not expire.
:param datetime create_time: (optional) Output only. The time this note was
created. This field can be used as a filter in list requests.
:param datetime update_time: (optional) Output only. The time this note was
last updated. This field can be used as a filter in list requests.
:param bool shared: (optional) True if this `Note` can be shared by
multiple accounts.
:param FindingType finding: (optional) The finding details of the note.
example -
finding={
"severity": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
]
}
:param KpiType kpi: (optional) The KPI details of the note.
example -
kpi={
"aggregation_type":"SUM",
}
:param Card card: (optional) The card details of the note.
example -
card={
"elements": [
{
"default_time_range": "1d",
"kind": "NUMERIC",
"text": "Count of findings reported by my security tool",
"value_type": {
"finding_note_names": [
"providers/sdktest/notes/sdk_note_name1"
],
"kind": "FINDING_COUNT"
}
}
],
"finding_note_names": [
"providers/sdktest/notes/sdk_note_name1"
],
"section": "My Security Tools",
"order": 1,
"title": "My Security Tool Findings",
"subtitle": "My Security Tool",
}
:param Section section: (optional) The section details of the note.
example -
section={
"title":"s1",
"image":"s1img"
}
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
- update_occurrence(self, account_id: str, provider_id: str, occurrence_id: str, note_name: str, kind: 'ApiNoteKind', id: str, *, resource_url: str = None, remediation: str = None, create_time: datetime.datetime = None, update_time: datetime.datetime = None, context: 'Context' = None, finding: 'Finding' = None, kpi: 'Kpi' = None, **kwargs) -> 'DetailedResponse'
- Updates an existing `Occurrence`.
:param str account_id: Account ID.
:param str provider_id: First part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param str occurrence_id: Second part of occurrence `name`:
providers/{provider_id}/occurrences/{occurrence_id}.
:param str note_name: 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.
:param ApiNoteKind kind: Output only. This explicitly denotes which of the
`Occurrence` details are specified.
This field can be used as a filter in list requests.
kind could be -
- FINDING
- KPI
- CARD
- CARD_CONFIGURED
- SECTION
example:
kind="FINDING"
:param str id:
:param str resource_url: (optional) 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.
:param str remediation: (optional)
:param datetime create_time: (optional) Output only. The time this
`Occurrence` was created.
:param datetime update_time: (optional) Output only. The time this
`Occurrence` was last updated.
:param Context context: (optional) Details about the context of this
`Occurrence`.
example -
context = {
"region": "us-south",
"resource_type": "Cluster",
"service_name": "Kubernetes Cluster",
"account_id": "abc123"
}
:param Finding finding: (optional) Details of the occurrence of a
finding.
example -
finding = {
"severity": "LOW",
"next_steps": [
{
"title": "string",
"url": "string"
}
]
}
:param Kpi kpi: (optional) Details of the occurrence of a KPI.
example -
kpi={
"value":1,
"total":1
}
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse
Class methods defined here:
- new_instance(service_name: str = 'findings_api') -> 'FindingsApiV1' from builtins.type
Data and other attributes defined here:
- DEFAULT_SERVICE_NAME = 'findings_api'
- DEFAULT_SERVICE_URL = 'https://us-south.secadvisor.cloud.ibm.com/findings'
Methods inherited from ibm_cloud_sdk_core.base_service.BaseService:
- configure_service(self, service_name: str)
- Look for external configuration of a service. Set service properties.
Try to get config from external sources, with the following priority:
1. Credentials file(ibm-credentials.env)
2. Environment variables
3. VCAP Services(Cloud Foundry)
Args:
service_name: The service name
Raises:
ValueError: If service_name is not a string.
- get_authenticator(self) -> ibm_cloud_sdk_core.authenticators.authenticator.Authenticator
- Get the authenticator currently used by the service.
Returns:
The authenticator currently used by the service.
- prepare_request(self, method: str, url: str, headers: Union[dict, NoneType] = None, params: Union[dict, NoneType] = None, data: Union[str, dict, NoneType] = None, files: Union[Dict[str, Tuple[str]], List[Tuple[str, Tuple[str, ...]]], NoneType] = None, **kwargs) -> dict
- Build a dict that represents an HTTP service request.
Clean up headers, add default http configuration, convert data
into json, process files, and merge all into a single request dict.
Args:
method: The HTTP method of the request ex. GET, POST, etc.
url: The origin + pathname according to WHATWG spec.
Keyword Arguments:
headers: Headers of the request.
params: Querystring data to be appended to the url.
data: The request body. Converted to json if a dict.
files: 'files' can be a dictionary (i.e { '<part-name>': (<tuple>)}),
or a list of tuples [ (<part-name>, (<tuple>))... ]
Returns:
Prepared request dictionary.
- send(self, request: requests.models.Request, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse
- Send a request and wrap the response in a DetailedResponse or APIException.
Args:
request: The request to send to the service endpoint.
Raises:
ApiException: The exception from the API.
Returns:
The response from the request.
- set_default_headers(self, headers: Dict[str, str])
- Set http headers to be sent in every request.
Arguments:
headers: A dictionary of headers
- set_disable_ssl_verification(self, status: bool = False)
- Set the flag that indicates whether verification of
the server's SSL certificate should be disabled or not.
Keyword Arguments:
status: set to true to disable ssl verification (default: {False})
- set_http_config(self, http_config: dict)
- Sets the http config dictionary.
The dictionary can contain values that control the timeout, proxies, and etc of HTTP requests.
Arguments:
http_config: Configuration values to customize HTTP behaviors.
Raises:
TypeError: http_config is not a dict.
- set_service_url(self, service_url: str)
- Set the url the service will make HTTP requests too.
Arguments:
service_url: The WHATWG URL standard origin ex. https://example.service.com
Raises:
ValueError: Improperly formatted service_url
Static methods inherited from ibm_cloud_sdk_core.base_service.BaseService:
- encode_path_vars(*args: str) -> List[str]
- Encode path variables to be substituted into a URL path.
Arguments:
args: A list of strings to be URL path encoded
Returns:
A list of encoded strings that are safe to substitute into a URL path.
Data descriptors inherited from ibm_cloud_sdk_core.base_service.BaseService:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes inherited from ibm_cloud_sdk_core.base_service.BaseService:
- ERROR_MSG_DISABLE_SSL = 'The connection failed because the SSL certificat...ble_ssl_verification option of the authenticator.'
- SDK_NAME = 'ibm-python-sdk-core'
|
class Kpi(builtins.object) |
| |
Kpi(value: float, *, total: float = None) -> None
Kpi provides details about a KPI occurrence.
{
"value": 0,
"total": 0
}
:attr float value: The value of this KPI.
:attr float total: (optional) The total value of this KPI.
|
| |
Methods defined here:
- __eq__(self, other: 'Kpi') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, value: float, *, total: float = None) -> None
- Initialize a Kpi object.
:param float value: The value of this KPI.
:param float total: (optional) The total value of this KPI.
- __ne__(self, other: 'Kpi') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Kpi object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Kpi' from builtins.type
- Initialize a Kpi object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class KpiType(builtins.object) |
| |
KpiType(aggregation_type: str) -> None
KpiType provides details about a KPI note.
{
"aggregation_type": "SUM"
}
:attr str aggregation_type: 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.
|
| |
Methods defined here:
- __eq__(self, other: 'KpiType') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, aggregation_type: str) -> None
- Initialize a KpiType object.
:param str aggregation_type: 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.
- __ne__(self, other: 'KpiType') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this KpiType object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'KpiType' from builtins.type
- Initialize a KpiType object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- AggregationTypeEnum = <enum 'AggregationTypeEnum'>
- 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.
- __hash__ = None
|
class NetworkConnection(builtins.object) |
| |
NetworkConnection(*, direction: str = None, protocol: str = None, client: 'SocketAddress' = None, server: 'SocketAddress' = None) -> None
It provides details about a network connection.
:attr str direction: (optional) The direction of this network connection.
:attr str protocol: (optional) The protocol of this network connection.
:attr SocketAddress client: (optional) The client socket address of this network
connection.
:attr SocketAddress server: (optional) The server socket address of this network
connection.
|
| |
Methods defined here:
- __eq__(self, other: 'NetworkConnection') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, direction: str = None, protocol: str = None, client: 'SocketAddress' = None, server: 'SocketAddress' = None) -> None
- Initialize a NetworkConnection object.
:param str direction: (optional) The direction of this network connection.
:param str protocol: (optional) The protocol of this network connection.
:param SocketAddress client: (optional) The client socket address of this
network connection.
:param SocketAddress server: (optional) The server socket address of this
network connection.
- __ne__(self, other: 'NetworkConnection') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this NetworkConnection object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'NetworkConnection' from builtins.type
- Initialize a NetworkConnection object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class NumericCardElement(CardElement) |
| |
NumericCardElement(kind: str, text: str, value_type: object, *, default_time_range: str = None) -> None
A card element with a single numeric value.
:attr str text: The text of this card element.
:attr object value_type:
|
| |
- Method resolution order:
- NumericCardElement
- CardElement
- builtins.object
Methods defined here:
- __eq__(self, other: 'NumericCardElement') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, text: str, value_type: object, *, default_time_range: str = None) -> None
- Initialize a NumericCardElement object.
:param str kind: Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
:param str text: The text of this card element.
:param object value_type:
:param str default_time_range: (optional) The default time range of this
card element.
- __ne__(self, other: 'NumericCardElement') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this NumericCardElement object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'NumericCardElement' from builtins.type
- Initialize a NumericCardElement object from a json dictionary.
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
- __hash__ = None
Data descriptors inherited from CardElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class PostGraphEnums(builtins.object) |
| | |
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- ContentType = <enum 'ContentType'>
- The type of the input.
|
class RemediationStep(builtins.object) |
| |
RemediationStep(*, title: str = None, url: str = None) -> None
A remediation step description and associated URL.
:attr str title: (optional) Title of this next step.
:attr str url: (optional) The URL associated to this next steps.
|
| |
Methods defined here:
- __eq__(self, other: 'RemediationStep') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, *, title: str = None, url: str = None) -> None
- Initialize a RemediationStep object.
:param str title: (optional) Title of this next step.
:param str url: (optional) The URL associated to this next steps.
- __ne__(self, other: 'RemediationStep') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this RemediationStep object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'RemediationStep' from builtins.type
- Initialize a RemediationStep object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class Reporter(builtins.object) |
| |
Reporter(id: str, title: str, *, url: str = None) -> None
The entity reporting a note.
{
"id": "string",
"title": "string",
"url": "string"
}
:attr str id: The id of this reporter.
:attr str title: The title of this reporter.
:attr str url: (optional) The url of this reporter.
|
| |
Methods defined here:
- __eq__(self, other: 'Reporter') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, id: str, title: str, *, url: str = None) -> None
- Initialize a Reporter object.
:param str id: The id of this reporter.
:param str title: The title of this reporter.
:param str url: (optional) The url of this reporter.
- __ne__(self, other: 'Reporter') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Reporter object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Reporter' from builtins.type
- Initialize a Reporter object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class Section(builtins.object) |
| |
Section(title: str, image: str) -> None
Card provides details about a card kind of note.
{
"title": "string",
"image": "string"
}
:attr str title: The title of this section.
:attr str image: The image of this section.
|
| |
Methods defined here:
- __eq__(self, other: 'Section') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, title: str, image: str) -> None
- Initialize a Section object.
:param str title: The title of this section.
:param str image: The image of this section.
- __ne__(self, other: 'Section') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Section object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Section' from builtins.type
- Initialize a Section object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class Severity(builtins.object) |
| |
Severity() -> None
Note provider-assigned severity/impact ranking
- LOW: Low Impact
- MEDIUM: Medium Impact
- HIGH: High Impact.
|
| |
Methods defined here:
- __eq__(self, other: 'Severity') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self) -> None
- Initialize a Severity object.
- __ne__(self, other: 'Severity') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this Severity object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'Severity' from builtins.type
- Initialize a Severity object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class SocketAddress(builtins.object) |
| |
SocketAddress(address: str, *, port: int = None) -> None
It provides details about a socket address.
:attr str address: The IP address of this socket address.
:attr int port: (optional) The port number of this socket address.
|
| |
Methods defined here:
- __eq__(self, other: 'SocketAddress') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, address: str, *, port: int = None) -> None
- Initialize a SocketAddress object.
:param str address: The IP address of this socket address.
:param int port: (optional) The port number of this socket address.
- __ne__(self, other: 'SocketAddress') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this SocketAddress object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'SocketAddress' from builtins.type
- Initialize a SocketAddress object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- __hash__ = None
|
class TimeSeriesCardElement(CardElement) |
| |
TimeSeriesCardElement(kind: str, text: str, value_types: List[ForwardRef('FindingCountValueType')], *, default_time_range: str = None, default_interval: str = None) -> None
A card element with a time series chart.
:attr str text: The text of this card element.
:attr str default_interval: (optional) The default interval of the time series.
:attr List[FindingCountValueType] value_types: the value types associated to
this card element.
|
| |
- Method resolution order:
- TimeSeriesCardElement
- CardElement
- builtins.object
Methods defined here:
- __eq__(self, other: 'TimeSeriesCardElement') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, text: str, value_types: List[ForwardRef('FindingCountValueType')], *, default_time_range: str = None, default_interval: str = None) -> None
- Initialize a TimeSeriesCardElement object.
:param str kind: Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
:param str text: The text of this card element.
:param List[FindingCountValueType] value_types: the value types associated
to this card element.
:param str default_time_range: (optional) The default time range of this
card element.
:param str default_interval: (optional) The default interval of the time
series.
- __ne__(self, other: 'TimeSeriesCardElement') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this TimeSeriesCardElement object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'TimeSeriesCardElement' from builtins.type
- Initialize a TimeSeriesCardElement object from a json dictionary.
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- NUMERIC: Single numeric value
- BREAKDOWN: Breakdown of numeric values
- TIME_SERIES: Time-series of numeric values.
- __hash__ = None
Data descriptors inherited from CardElement:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|
class ValueType(builtins.object) |
| |
ValueType(kind: str, text: str) -> None
the value type of a card element.
:attr str kind: Kind of element
- KPI: Kind of value derived from a KPI occurrence
- FINDING_COUNT: Kind of value derived from a count of finding occurrences.
:attr str text: The text of this element type.
|
| |
Methods defined here:
- __eq__(self, other: 'ValueType') -> bool
- Return `true` when self and other are equal, false otherwise.
- __init__(self, kind: str, text: str) -> None
- Initialize a ValueType object.
:param str kind: Kind of element
- KPI: Kind of value derived from a KPI occurrence
- FINDING_COUNT: Kind of value derived from a count of finding
occurrences.
:param str text: The text of this element type.
- __ne__(self, other: 'ValueType') -> bool
- Return `true` when self and other are not equal, false otherwise.
- __str__(self) -> str
- Return a `str` version of this ValueType object.
- to_dict(self) -> Dict
- Return a json dictionary representing this model.
Class methods defined here:
- from_dict(_dict: Dict) -> 'ValueType' from builtins.type
- Initialize a ValueType object from a json dictionary.
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
Data and other attributes defined here:
- KindEnum = <enum 'KindEnum'>
- Kind of element
- KPI: Kind of value derived from a KPI occurrence
- FINDING_COUNT: Kind of value derived from a count of finding occurrences.
- __hash__ = None
| |