DatabaseSoftwareImage¶

class oci.database.models.DatabaseSoftwareImage(**kwargs)¶

Bases: object

Database software images are created by specifying a patch set, one-off patches and patches for the database home (listed by ls inventory).

Attributes

`IMAGE_SHAPE_FAMILY_EXACC_SHAPE`	A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage.
`IMAGE_SHAPE_FAMILY_EXADATA_SHAPE`	A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage.
`IMAGE_SHAPE_FAMILY_VM_BM_SHAPE`	A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage.
`IMAGE_TYPE_DATABASE_IMAGE`	A constant which can be used with the image_type property of a DatabaseSoftwareImage.
`IMAGE_TYPE_GRID_IMAGE`	A constant which can be used with the image_type property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_AVAILABLE`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_PROVISIONING`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_TERMINATED`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_TERMINATING`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseSoftwareImage.
`database_software_image_included_patches`	Gets the database_software_image_included_patches of this DatabaseSoftwareImage.
`database_software_image_one_off_patches`	Gets the database_software_image_one_off_patches of this DatabaseSoftwareImage.
`database_version`	[Required] Gets the database_version of this DatabaseSoftwareImage.
`defined_tags`	Gets the defined_tags of this DatabaseSoftwareImage.
`display_name`	[Required] Gets the display_name of this DatabaseSoftwareImage.
`freeform_tags`	Gets the freeform_tags of this DatabaseSoftwareImage.
`id`	[Required] Gets the id of this DatabaseSoftwareImage.
`image_shape_family`	[Required] Gets the image_shape_family of this DatabaseSoftwareImage.
`image_type`	[Required] Gets the image_type of this DatabaseSoftwareImage.
`included_patches_summary`	Gets the included_patches_summary of this DatabaseSoftwareImage.
`is_upgrade_supported`	Gets the is_upgrade_supported of this DatabaseSoftwareImage.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseSoftwareImage.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseSoftwareImage.
`ls_inventory`	Gets the ls_inventory of this DatabaseSoftwareImage.
`patch_set`	[Required] Gets the patch_set of this DatabaseSoftwareImage.
`time_created`	[Required] Gets the time_created of this DatabaseSoftwareImage.

Methods

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

IMAGE_SHAPE_FAMILY_EXACC_SHAPE = 'EXACC_SHAPE'¶: A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage. This constant has a value of “EXACC_SHAPE”

IMAGE_SHAPE_FAMILY_EXADATA_SHAPE = 'EXADATA_SHAPE'¶: A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage. This constant has a value of “EXADATA_SHAPE”

IMAGE_SHAPE_FAMILY_VM_BM_SHAPE = 'VM_BM_SHAPE'¶: A constant which can be used with the image_shape_family property of a DatabaseSoftwareImage. This constant has a value of “VM_BM_SHAPE”

IMAGE_TYPE_DATABASE_IMAGE = 'DATABASE_IMAGE'¶: A constant which can be used with the image_type property of a DatabaseSoftwareImage. This constant has a value of “DATABASE_IMAGE”

IMAGE_TYPE_GRID_IMAGE = 'GRID_IMAGE'¶: A constant which can be used with the image_type property of a DatabaseSoftwareImage. This constant has a value of “GRID_IMAGE”

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'¶: A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage. This constant has a value of “AVAILABLE”

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

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

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

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseSoftwareImage. This constant has a value of “TERMINATING”

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

__init__(**kwargs)¶

Initializes a new DatabaseSoftwareImage 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 DatabaseSoftwareImage.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseSoftwareImage.
database_version (str) – The value to assign to the database_version property of this DatabaseSoftwareImage.
display_name (str) – The value to assign to the display_name property of this DatabaseSoftwareImage.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseSoftwareImage. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “DELETING”, “DELETED”, “FAILED”, “TERMINATING”, “TERMINATED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseSoftwareImage.
time_created (datetime) – The value to assign to the time_created property of this DatabaseSoftwareImage.
image_type (str) – The value to assign to the image_type property of this DatabaseSoftwareImage. Allowed values for this property are: “GRID_IMAGE”, “DATABASE_IMAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
image_shape_family (str) – The value to assign to the image_shape_family property of this DatabaseSoftwareImage. Allowed values for this property are: “VM_BM_SHAPE”, “EXADATA_SHAPE”, “EXACC_SHAPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
patch_set (str) – The value to assign to the patch_set property of this DatabaseSoftwareImage.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseSoftwareImage.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseSoftwareImage.
database_software_image_included_patches (list[str]) – The value to assign to the database_software_image_included_patches property of this DatabaseSoftwareImage.
included_patches_summary (str) – The value to assign to the included_patches_summary property of this DatabaseSoftwareImage.
database_software_image_one_off_patches (list[str]) – The value to assign to the database_software_image_one_off_patches property of this DatabaseSoftwareImage.
ls_inventory (str) – The value to assign to the ls_inventory property of this DatabaseSoftwareImage.
is_upgrade_supported (bool) – The value to assign to the is_upgrade_supported property of this DatabaseSoftwareImage.

compartment_id¶

[Required] Gets the compartment_id of this DatabaseSoftwareImage. The OCID of the compartment.

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

database_software_image_included_patches¶

Gets the database_software_image_included_patches of this DatabaseSoftwareImage. List of one-off patches for Database Homes.

Returns:	The database_software_image_included_patches of this DatabaseSoftwareImage.
Return type:	list[str]

database_software_image_one_off_patches¶

Gets the database_software_image_one_off_patches of this DatabaseSoftwareImage. List of one-off patches for Database Homes.

Returns:	The database_software_image_one_off_patches of this DatabaseSoftwareImage.
Return type:	list[str]

database_version¶

[Required] Gets the database_version of this DatabaseSoftwareImage. The database version with which the database software image is to be built.

Returns:	The database_version of this DatabaseSoftwareImage.
Return type:	str

defined_tags¶

Gets the defined_tags of this DatabaseSoftwareImage. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

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

display_name¶

[Required] Gets the display_name of this DatabaseSoftwareImage. The user-friendly name for the database software image. The name does not have to be unique.

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

freeform_tags¶

Gets the freeform_tags of this DatabaseSoftwareImage. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

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

id¶

[Required] Gets the id of this DatabaseSoftwareImage. The OCID of the database software image.

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

image_shape_family¶

[Required] Gets the image_shape_family of this DatabaseSoftwareImage. To what shape the image is meant for.

Allowed values for this property are: “VM_BM_SHAPE”, “EXADATA_SHAPE”, “EXACC_SHAPE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The image_shape_family of this DatabaseSoftwareImage.
Return type:	str

image_type¶

[Required] Gets the image_type of this DatabaseSoftwareImage. The type of software image. Can be grid or database.

Allowed values for this property are: “GRID_IMAGE”, “DATABASE_IMAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The image_type of this DatabaseSoftwareImage.
Return type:	str

included_patches_summary¶

Gets the included_patches_summary of this DatabaseSoftwareImage. The patches included in the image and the version of the image.

Returns:	The included_patches_summary of this DatabaseSoftwareImage.
Return type:	str

is_upgrade_supported¶

Gets the is_upgrade_supported of this DatabaseSoftwareImage. True if this Database software image is supported for Upgrade.

Returns:	The is_upgrade_supported of this DatabaseSoftwareImage.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this DatabaseSoftwareImage. Detailed message for the lifecycle state.

Returns:	The lifecycle_details of this DatabaseSoftwareImage.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseSoftwareImage. The current state of the database software image.

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

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

ls_inventory¶

Gets the ls_inventory of this DatabaseSoftwareImage. The output from the OPatch lsInventory command, which is passed as a string.

Returns:	The ls_inventory of this DatabaseSoftwareImage.
Return type:	str

patch_set¶

[Required] Gets the patch_set of this DatabaseSoftwareImage. The PSU or PBP or Release Updates. To get a list of supported versions, use the list_db_versions() operation.

Returns:	The patch_set of this DatabaseSoftwareImage.
Return type:	str

time_created¶

[Required] Gets the time_created of this DatabaseSoftwareImage. The date and time the database software image was created.

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