OccAvailabilityCatalogSummary

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

Bases: object

A catalog containing resource availability details for a customer.

Attributes:

NAMESPACE_COMPUTE

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

catalog_state

[Required] Gets the catalog_state of this OccAvailabilityCatalogSummary.

compartment_id

[Required] Gets the compartment_id of this OccAvailabilityCatalogSummary.

defined_tags

Gets the defined_tags of this OccAvailabilityCatalogSummary.

description

Gets the description of this OccAvailabilityCatalogSummary.

display_name

[Required] Gets the display_name of this OccAvailabilityCatalogSummary.

freeform_tags

Gets the freeform_tags of this OccAvailabilityCatalogSummary.

id

[Required] Gets the id of this OccAvailabilityCatalogSummary.

lifecycle_details

Gets the lifecycle_details of this OccAvailabilityCatalogSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this OccAvailabilityCatalogSummary.

metadata_details

[Required] Gets the metadata_details of this OccAvailabilityCatalogSummary.

namespace

[Required] Gets the namespace of this OccAvailabilityCatalogSummary.

occ_customer_group_id

[Required] Gets the occ_customer_group_id of this OccAvailabilityCatalogSummary.

system_tags

Gets the system_tags of this OccAvailabilityCatalogSummary.

time_created

[Required] Gets the time_created of this OccAvailabilityCatalogSummary.

time_updated

[Required] Gets the time_updated of this OccAvailabilityCatalogSummary.

Methods:

__init__(**kwargs)

Initializes a new OccAvailabilityCatalogSummary object with values from keyword arguments.

NAMESPACE_COMPUTE = 'COMPUTE'

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

__init__(**kwargs)

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

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

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

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

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

  • catalog_state (str) – The value to assign to the catalog_state property of this OccAvailabilityCatalogSummary.

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccAvailabilityCatalogSummary.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this OccAvailabilityCatalogSummary.

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

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

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

property catalog_state

[Required] Gets the catalog_state of this OccAvailabilityCatalogSummary. Represents whether this version of the availability catalog has been made available to the customer. The state is No by default.

Returns

The catalog_state of this OccAvailabilityCatalogSummary.

Return type

str

property compartment_id

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

Returns

The compartment_id of this OccAvailabilityCatalogSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this OccAvailabilityCatalogSummary.

Return type

str

property display_name

[Required] Gets the display_name of this OccAvailabilityCatalogSummary. An user-friendly name for the availability catalog. Does not have to be unique, and is changeable. Avoid entering confidential information.

Returns

The display_name of this OccAvailabilityCatalogSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this OccAvailabilityCatalogSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this OccAvailabilityCatalogSummary. 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 OccAvailabilityCatalogSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this OccAvailabilityCatalogSummary. The current lifecycle state of the customer group.

Returns

The lifecycle_state of this OccAvailabilityCatalogSummary.

Return type

str

property metadata_details

[Required] Gets the metadata_details of this OccAvailabilityCatalogSummary.

Returns

The metadata_details of this OccAvailabilityCatalogSummary.

Return type

oci.capacity_management.models.MetadataDetails

property namespace

[Required] Gets the namespace of this OccAvailabilityCatalogSummary. 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 OccAvailabilityCatalogSummary.

Return type

str

property occ_customer_group_id

[Required] Gets the occ_customer_group_id of this OccAvailabilityCatalogSummary. The Customer Group OCID to which the availability catalog belongs.

Returns

The occ_customer_group_id of this OccAvailabilityCatalogSummary.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this OccAvailabilityCatalogSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this OccAvailabilityCatalogSummary.

Return type

datetime