CatalogItem¶

class oci.fleet_apps_management.models.CatalogItem(**kwargs)¶

Bases: object

A description of a CatalogItem resource.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`CONFIG_SOURCE_TYPE_GIT_CATALOG_SOURCE`	A constant which can be used with the config_source_type property of a CatalogItem.
`CONFIG_SOURCE_TYPE_MARKETPLACE_CATALOG_SOURCE`	A constant which can be used with the config_source_type property of a CatalogItem.
`CONFIG_SOURCE_TYPE_PAR_CATALOG_SOURCE`	A constant which can be used with the config_source_type property of a CatalogItem.
`CONFIG_SOURCE_TYPE_STACK_TEMPLATE_CATALOG_SOURCE`	A constant which can be used with the config_source_type property of a CatalogItem.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a CatalogItem.
`PACKAGE_TYPE_CONFIG_FILE`	A constant which can be used with the package_type property of a CatalogItem.
`PACKAGE_TYPE_NON_TF_PACKAGE`	A constant which can be used with the package_type property of a CatalogItem.
`PACKAGE_TYPE_TF_PACKAGE`	A constant which can be used with the package_type property of a CatalogItem.
`catalog_result_payload`	Gets the catalog_result_payload of this CatalogItem.
`catalog_source_payload`	Gets the catalog_source_payload of this CatalogItem.
`compartment_id`	[Required] Gets the compartment_id of this CatalogItem.
`config_source_type`	[Required] Gets the config_source_type of this CatalogItem.
`defined_tags`	Gets the defined_tags of this CatalogItem.
`description`	[Required] Gets the description of this CatalogItem.
`display_name`	[Required] Gets the display_name of this CatalogItem.
`freeform_tags`	Gets the freeform_tags of this CatalogItem.
`id`	[Required] Gets the id of this CatalogItem.
`lifecycle_details`	[Required] Gets the lifecycle_details of this CatalogItem.
`lifecycle_state`	[Required] Gets the lifecycle_state of this CatalogItem.
`listing_id`	[Required] Gets the listing_id of this CatalogItem.
`listing_version`	[Required] Gets the listing_version of this CatalogItem.
`package_type`	[Required] Gets the package_type of this CatalogItem.
`short_description`	Gets the short_description of this CatalogItem.
`should_list_public_items`	Gets the should_list_public_items of this CatalogItem.
`system_tags`	Gets the system_tags of this CatalogItem.
`time_backfill_last_checked`	Gets the time_backfill_last_checked of this CatalogItem.
`time_created`	[Required] Gets the time_created of this CatalogItem.
`time_last_checked`	Gets the time_last_checked of this CatalogItem.
`time_released`	Gets the time_released of this CatalogItem.
`time_updated`	[Required] Gets the time_updated of this CatalogItem.
`version_description`	Gets the version_description of this CatalogItem.

Methods

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

CONFIG_SOURCE_TYPE_GIT_CATALOG_SOURCE = 'GIT_CATALOG_SOURCE'¶: A constant which can be used with the config_source_type property of a CatalogItem. This constant has a value of “GIT_CATALOG_SOURCE”

CONFIG_SOURCE_TYPE_MARKETPLACE_CATALOG_SOURCE = 'MARKETPLACE_CATALOG_SOURCE'¶: A constant which can be used with the config_source_type property of a CatalogItem. This constant has a value of “MARKETPLACE_CATALOG_SOURCE”

CONFIG_SOURCE_TYPE_PAR_CATALOG_SOURCE = 'PAR_CATALOG_SOURCE'¶: A constant which can be used with the config_source_type property of a CatalogItem. This constant has a value of “PAR_CATALOG_SOURCE”

CONFIG_SOURCE_TYPE_STACK_TEMPLATE_CATALOG_SOURCE = 'STACK_TEMPLATE_CATALOG_SOURCE'¶: A constant which can be used with the config_source_type property of a CatalogItem. This constant has a value of “STACK_TEMPLATE_CATALOG_SOURCE”

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

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

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

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

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

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

PACKAGE_TYPE_CONFIG_FILE = 'CONFIG_FILE'¶: A constant which can be used with the package_type property of a CatalogItem. This constant has a value of “CONFIG_FILE”

PACKAGE_TYPE_NON_TF_PACKAGE = 'NON_TF_PACKAGE'¶: A constant which can be used with the package_type property of a CatalogItem. This constant has a value of “NON_TF_PACKAGE”

PACKAGE_TYPE_TF_PACKAGE = 'TF_PACKAGE'¶: A constant which can be used with the package_type property of a CatalogItem. This constant has a value of “TF_PACKAGE”

__init__(**kwargs)¶

Initializes a new CatalogItem 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 CatalogItem.
compartment_id (str) – The value to assign to the compartment_id property of this CatalogItem.
config_source_type (str) – The value to assign to the config_source_type property of this CatalogItem. Allowed values for this property are: “PAR_CATALOG_SOURCE”, “GIT_CATALOG_SOURCE”, “MARKETPLACE_CATALOG_SOURCE”, “STACK_TEMPLATE_CATALOG_SOURCE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
should_list_public_items (bool) – The value to assign to the should_list_public_items property of this CatalogItem.
description (str) – The value to assign to the description property of this CatalogItem.
catalog_source_payload (oci.fleet_apps_management.models.CatalogSourcePayload) – The value to assign to the catalog_source_payload property of this CatalogItem.
catalog_result_payload (oci.fleet_apps_management.models.CatalogResultPayload) – The value to assign to the catalog_result_payload property of this CatalogItem.
listing_id (str) – The value to assign to the listing_id property of this CatalogItem.
listing_version (str) – The value to assign to the listing_version property of this CatalogItem.
display_name (str) – The value to assign to the display_name property of this CatalogItem.
version_description (str) – The value to assign to the version_description property of this CatalogItem.
short_description (str) – The value to assign to the short_description property of this CatalogItem.
package_type (str) – The value to assign to the package_type property of this CatalogItem. Allowed values for this property are: “TF_PACKAGE”, “NON_TF_PACKAGE”, “CONFIG_FILE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this CatalogItem. 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’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CatalogItem.
time_created (datetime) – The value to assign to the time_created property of this CatalogItem.
time_updated (datetime) – The value to assign to the time_updated property of this CatalogItem.
time_released (datetime) – The value to assign to the time_released property of this CatalogItem.
time_backfill_last_checked (datetime) – The value to assign to the time_backfill_last_checked property of this CatalogItem.
time_last_checked (datetime) – The value to assign to the time_last_checked property of this CatalogItem.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CatalogItem.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CatalogItem.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CatalogItem.

catalog_result_payload¶

Gets the catalog_result_payload of this CatalogItem.

Returns:	The catalog_result_payload of this CatalogItem.
Return type:	oci.fleet_apps_management.models.CatalogResultPayload

catalog_source_payload¶

Gets the catalog_source_payload of this CatalogItem.

Returns:	The catalog_source_payload of this CatalogItem.
Return type:	oci.fleet_apps_management.models.CatalogSourcePayload

compartment_id¶

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

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

config_source_type¶

[Required] Gets the config_source_type of this CatalogItem. Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

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

Returns:	The config_source_type of this CatalogItem.
Return type:	str

defined_tags¶

Gets the defined_tags of this CatalogItem. 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 CatalogItem.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this CatalogItem. Description about the catalog item.

Returns:	The description of this CatalogItem.
Return type:	str

display_name¶

[Required] Gets the display_name of this CatalogItem. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

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

freeform_tags¶

Gets the freeform_tags of this CatalogItem. 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 CatalogItem.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this CatalogItem. The OCID of the catalog.

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

lifecycle_details¶

[Required] Gets the lifecycle_details of this CatalogItem. The details of lifecycle state CatalogItem.

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

lifecycle_state¶

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

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 CatalogItem.
Return type:	str

listing_id¶

[Required] Gets the listing_id of this CatalogItem. The catalog listing Id.

Returns:	The listing_id of this CatalogItem.
Return type:	str

listing_version¶

[Required] Gets the listing_version of this CatalogItem. The catalog package version.

Returns:	The listing_version of this CatalogItem.
Return type:	str

package_type¶

[Required] Gets the package_type of this CatalogItem. Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE.

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

Returns:	The package_type of this CatalogItem.
Return type:	str

short_description¶

Gets the short_description of this CatalogItem. Short description about the catalog item.

Returns:	The short_description of this CatalogItem.
Return type:	str

should_list_public_items¶

Gets the should_list_public_items of this CatalogItem. The indicator to append Public Items from the root compartment to any query, when set to TRUE.

Returns:	The should_list_public_items of this CatalogItem.
Return type:	bool

system_tags¶

Gets the system_tags of this CatalogItem. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_backfill_last_checked¶

Gets the time_backfill_last_checked of this CatalogItem. The date and time the CatalogItem was last checked by backfill job, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_backfill_last_checked of this CatalogItem.
Return type:	datetime

time_created¶

[Required] Gets the time_created of this CatalogItem. The date and time the CatalogItem was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

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

time_last_checked¶

Gets the time_last_checked of this CatalogItem. The date and time the CatalogItem was last checked, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_last_checked of this CatalogItem.
Return type:	datetime

time_released¶

Gets the time_released of this CatalogItem. The date and time the CatalogItem was released, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_released of this CatalogItem.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this CatalogItem. The date and time the CatalogItem was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

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

version_description¶

Gets the version_description of this CatalogItem. Version description about the catalog item.

Returns:	The version_description of this CatalogItem.
Return type:	str