OccAvailabilityCatalog

class oci.capacity_management.models.OccAvailabilityCatalog(**kwargs)

Bases: object

Details of the availability catalog resource.

Attributes:

CATALOG_STATE_DELETED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

CATALOG_STATE_NOT_UPLOADED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

CATALOG_STATE_OUTDATED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

CATALOG_STATE_PUBLISHED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

CATALOG_STATE_STAGED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

CATALOG_STATE_UPLOAD_FAILED

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog.

NAMESPACE_COMPUTE

A constant which can be used with the namespace property of a OccAvailabilityCatalog.

catalog_state

[Required] Gets the catalog_state of this OccAvailabilityCatalog.

compartment_id

[Required] Gets the compartment_id of this OccAvailabilityCatalog.

defined_tags

Gets the defined_tags of this OccAvailabilityCatalog.

description

Gets the description of this OccAvailabilityCatalog.

details

Gets the details of this OccAvailabilityCatalog.

display_name

[Required] Gets the display_name of this OccAvailabilityCatalog.

freeform_tags

Gets the freeform_tags of this OccAvailabilityCatalog.

id

[Required] Gets the id of this OccAvailabilityCatalog.

lifecycle_details

Gets the lifecycle_details of this OccAvailabilityCatalog.

lifecycle_state

[Required] Gets the lifecycle_state of this OccAvailabilityCatalog.

metadata_details

[Required] Gets the metadata_details of this OccAvailabilityCatalog.

namespace

[Required] Gets the namespace of this OccAvailabilityCatalog.

occ_customer_group_id

[Required] Gets the occ_customer_group_id of this OccAvailabilityCatalog.

system_tags

Gets the system_tags of this OccAvailabilityCatalog.

time_created

[Required] Gets the time_created of this OccAvailabilityCatalog.

time_updated

[Required] Gets the time_updated of this OccAvailabilityCatalog.

Methods:

__init__(**kwargs)

Initializes a new OccAvailabilityCatalog object with values from keyword arguments.

CATALOG_STATE_DELETED = 'DELETED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “DELETED”

CATALOG_STATE_NOT_UPLOADED = 'NOT_UPLOADED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “NOT_UPLOADED”

CATALOG_STATE_OUTDATED = 'OUTDATED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “OUTDATED”

CATALOG_STATE_PUBLISHED = 'PUBLISHED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “PUBLISHED”

CATALOG_STATE_STAGED = 'STAGED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “STAGED”

CATALOG_STATE_UPLOAD_FAILED = 'UPLOAD_FAILED'

A constant which can be used with the catalog_state property of a OccAvailabilityCatalog. This constant has a value of “UPLOAD_FAILED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a OccAvailabilityCatalog. This constant has a value of “UPDATING”

NAMESPACE_COMPUTE = 'COMPUTE'

A constant which can be used with the namespace property of a OccAvailabilityCatalog. This constant has a value of “COMPUTE”

__init__(**kwargs)

Initializes a new OccAvailabilityCatalog 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 OccAvailabilityCatalog.

  • namespace (str) – The value to assign to the namespace property of this OccAvailabilityCatalog. Allowed values for this property are: “COMPUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • compartment_id (str) – The value to assign to the compartment_id property of this OccAvailabilityCatalog.

  • display_name (str) – The value to assign to the display_name property of this OccAvailabilityCatalog.

  • description (str) – The value to assign to the description property of this OccAvailabilityCatalog.

  • occ_customer_group_id (str) – The value to assign to the occ_customer_group_id property of this OccAvailabilityCatalog.

  • catalog_state (str) – The value to assign to the catalog_state property of this OccAvailabilityCatalog. Allowed values for this property are: “NOT_UPLOADED”, “UPLOAD_FAILED”, “STAGED”, “PUBLISHED”, “OUTDATED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • metadata_details (oci.capacity_management.models.MetadataDetails) – The value to assign to the metadata_details property of this OccAvailabilityCatalog.

  • time_created (datetime) – The value to assign to the time_created property of this OccAvailabilityCatalog.

  • time_updated (datetime) – The value to assign to the time_updated property of this OccAvailabilityCatalog.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccAvailabilityCatalog. 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 OccAvailabilityCatalog.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccAvailabilityCatalog.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccAvailabilityCatalog.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccAvailabilityCatalog.

  • details (list[oci.capacity_management.models.OccAvailabilitySummary]) – The value to assign to the details property of this OccAvailabilityCatalog.

property catalog_state

[Required] Gets the catalog_state of this OccAvailabilityCatalog. The different states associated with the availability catalog.

Allowed values for this property are: “NOT_UPLOADED”, “UPLOAD_FAILED”, “STAGED”, “PUBLISHED”, “OUTDATED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The catalog_state of this OccAvailabilityCatalog.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this OccAvailabilityCatalog. The OCID of the tenancy where the availability catalog resides.

Returns

The compartment_id of this OccAvailabilityCatalog.

Return type

str

property defined_tags

Gets the defined_tags of this OccAvailabilityCatalog. 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 OccAvailabilityCatalog.

Return type

dict(str, dict(str, object))

property description

Gets the description of this OccAvailabilityCatalog. Text information about the availability catalog.

Returns

The description of this OccAvailabilityCatalog.

Return type

str

property details

Gets the details of this OccAvailabilityCatalog. Details about capacity available for different resources in catalog.

Returns

The details of this OccAvailabilityCatalog.

Return type

list[oci.capacity_management.models.OccAvailabilitySummary]

property display_name

[Required] Gets the display_name of this OccAvailabilityCatalog. A user-friendly name for the availability catalog.

Returns

The display_name of this OccAvailabilityCatalog.

Return type

str

property freeform_tags

Gets the freeform_tags of this OccAvailabilityCatalog. 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 OccAvailabilityCatalog.

Return type

dict(str, str)

property id

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

Returns

The id of this OccAvailabilityCatalog.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this OccAvailabilityCatalog. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.

Returns

The lifecycle_details of this OccAvailabilityCatalog.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this OccAvailabilityCatalog. The current lifecycle state of the resource.

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 OccAvailabilityCatalog.

Return type

str

property metadata_details

[Required] Gets the metadata_details of this OccAvailabilityCatalog.

Returns

The metadata_details of this OccAvailabilityCatalog.

Return type

oci.capacity_management.models.MetadataDetails

property namespace

[Required] Gets the namespace of this OccAvailabilityCatalog. The name of the OCI service in consideration. For example, Compute, Exadata, and so on.

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

Returns

The namespace of this OccAvailabilityCatalog.

Return type

str

property occ_customer_group_id

[Required] Gets the occ_customer_group_id of this OccAvailabilityCatalog. The customer group OCID to which the availability catalog belongs.

Returns

The occ_customer_group_id of this OccAvailabilityCatalog.

Return type

str

property system_tags

Gets the system_tags of this OccAvailabilityCatalog. 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 OccAvailabilityCatalog.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this OccAvailabilityCatalog. The time when the availability catalog was created.

Returns

The time_created of this OccAvailabilityCatalog.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this OccAvailabilityCatalog. The time when the availability catalog was last updated.

Returns

The time_updated of this OccAvailabilityCatalog.

Return type

datetime