ContainerScanRecipe¶

class oci.vulnerability_scanning.models.ContainerScanRecipe(**kwargs)¶

Bases: object

A container scan recipe (collection of container scanning configuration settings)

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ContainerScanRecipe.
`compartment_id`	[Required] Gets the compartment_id of this ContainerScanRecipe.
`defined_tags`	Gets the defined_tags of this ContainerScanRecipe.
`display_name`	[Required] Gets the display_name of this ContainerScanRecipe.
`freeform_tags`	Gets the freeform_tags of this ContainerScanRecipe.
`id`	[Required] Gets the id of this ContainerScanRecipe.
`image_count`	Gets the image_count of this ContainerScanRecipe.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerScanRecipe.
`scan_settings`	[Required] Gets the scan_settings of this ContainerScanRecipe.
`system_tags`	Gets the system_tags of this ContainerScanRecipe.
`time_created`	[Required] Gets the time_created of this ContainerScanRecipe.
`time_updated`	[Required] Gets the time_updated of this ContainerScanRecipe.

Methods

__init__(**kwargs) Initializes a new ContainerScanRecipe object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ContainerScanRecipe. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ContainerScanRecipe object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this ContainerScanRecipe.
display_name (str) – The value to assign to the display_name property of this ContainerScanRecipe.
compartment_id (str) – The value to assign to the compartment_id property of this ContainerScanRecipe.
image_count (int) – The value to assign to the image_count property of this ContainerScanRecipe.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerScanRecipe. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this ContainerScanRecipe.
time_updated (datetime) – The value to assign to the time_updated property of this ContainerScanRecipe.
scan_settings (oci.vulnerability_scanning.models.ContainerScanSettings) – The value to assign to the scan_settings property of this ContainerScanRecipe.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerScanRecipe.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerScanRecipe.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ContainerScanRecipe.

compartment_id¶

[Required] Gets the compartment_id of this ContainerScanRecipe. The OCID of the container scan recipe’s compartment

Returns:	The compartment_id of this ContainerScanRecipe.
Return type:	str

defined_tags¶

Gets the defined_tags of this ContainerScanRecipe. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this ContainerScanRecipe.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this ContainerScanRecipe. User friendly name of container scan recipe

Returns:	The display_name of this ContainerScanRecipe.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ContainerScanRecipe. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this ContainerScanRecipe.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ContainerScanRecipe. The OCID of container scan recipe. Immutable and generated on creation.

Returns:	The id of this ContainerScanRecipe.
Return type:	str

image_count¶

Gets the image_count of this ContainerScanRecipe. This field is set equal to the number of images we want to scan in the first go when the recipe is created

Returns:	The image_count of this ContainerScanRecipe.
Return type:	int

lifecycle_state¶

[Required] Gets the lifecycle_state of this ContainerScanRecipe. The current state of the config.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ContainerScanRecipe.
Return type:	str

scan_settings¶

[Required] Gets the scan_settings of this ContainerScanRecipe.

Returns:	The scan_settings of this ContainerScanRecipe.
Return type:	oci.vulnerability_scanning.models.ContainerScanSettings

system_tags¶

Gets the system_tags of this ContainerScanRecipe. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ContainerScanRecipe.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ContainerScanRecipe. Date and time the recipe was created, format as described in RFC 3339

Returns:	The time_created of this ContainerScanRecipe.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this ContainerScanRecipe. Date and time the recipe was last updated, format as described in RFC 3339

Returns:	The time_updated of this ContainerScanRecipe.
Return type:	datetime