MulticloudResourceSummary

class oci.multicloud.models.MulticloudResourceSummary(**kwargs)

Bases: object

The properties that define the Multicloud resource. Details for each resource include Multicloud base compartment, name, state, resource type, and network anchor. For more information, see Multicloud Resources.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_INACTIVE

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

compartment_id

Gets the compartment_id of this MulticloudResourceSummary.

compartment_name

Gets the compartment_name of this MulticloudResourceSummary.

csp_additional_properties

Gets the csp_additional_properties of this MulticloudResourceSummary.

csp_resource_id

Gets the csp_resource_id of this MulticloudResourceSummary.

defined_tags

Gets the defined_tags of this MulticloudResourceSummary.

freeform_tags

Gets the freeform_tags of this MulticloudResourceSummary.

lifecycle_state

Gets the lifecycle_state of this MulticloudResourceSummary.

network_anchor_id

Gets the network_anchor_id of this MulticloudResourceSummary.

network_anchor_name

Gets the network_anchor_name of this MulticloudResourceSummary.

resource_additional_properties

Gets the resource_additional_properties of this MulticloudResourceSummary.

resource_display_name

Gets the resource_display_name of this MulticloudResourceSummary.

resource_id

[Required] Gets the resource_id of this MulticloudResourceSummary.

resource_type

Gets the resource_type of this MulticloudResourceSummary.

system_tags

Gets the system_tags of this MulticloudResourceSummary.

time_created

[Required] Gets the time_created of this MulticloudResourceSummary.

time_updated

Gets the time_updated of this MulticloudResourceSummary.

vcn_id

Gets the vcn_id of this MulticloudResourceSummary.

vcn_name

Gets the vcn_name of this MulticloudResourceSummary.

Methods:

__init__(**kwargs)

Initializes a new MulticloudResourceSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

__init__(**kwargs)

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

Parameters
  • resource_id (str) – The value to assign to the resource_id property of this MulticloudResourceSummary.

  • resource_display_name (str) – The value to assign to the resource_display_name property of this MulticloudResourceSummary.

  • resource_type (str) – The value to assign to the resource_type property of this MulticloudResourceSummary.

  • compartment_name (str) – The value to assign to the compartment_name property of this MulticloudResourceSummary.

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

  • vcn_name (str) – The value to assign to the vcn_name property of this MulticloudResourceSummary.

  • vcn_id (str) – The value to assign to the vcn_id property of this MulticloudResourceSummary.

  • network_anchor_name (str) – The value to assign to the network_anchor_name property of this MulticloudResourceSummary.

  • network_anchor_id (str) – The value to assign to the network_anchor_id property of this MulticloudResourceSummary.

  • csp_resource_id (str) – The value to assign to the csp_resource_id property of this MulticloudResourceSummary.

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

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

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

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

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

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

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

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

property compartment_id

Gets the compartment_id of this MulticloudResourceSummary. Id of the compartment associated with the resource.

Returns

The compartment_id of this MulticloudResourceSummary.

Return type

str

property compartment_name

Gets the compartment_name of this MulticloudResourceSummary. Name of the compartment associated with the resource.

Returns

The compartment_name of this MulticloudResourceSummary.

Return type

str

property csp_additional_properties

Gets the csp_additional_properties of this MulticloudResourceSummary. Properties specific to the cloud service provider. For example, AzureSubnetId for Azure.

Returns

The csp_additional_properties of this MulticloudResourceSummary.

Return type

dict(str, str)

property csp_resource_id

Gets the csp_resource_id of this MulticloudResourceSummary. The resource Id that comes from the Multicloud control plane.

Returns

The csp_resource_id of this MulticloudResourceSummary.

Return type

str

property defined_tags

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

Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this MulticloudResourceSummary.

Return type

dict(str, dict(str, object))

property freeform_tags

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

Return type

dict(str, str)

property lifecycle_state

Gets the lifecycle_state of this MulticloudResourceSummary. The current state of the Multicloud resource.

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

Returns

The lifecycle_state of this MulticloudResourceSummary.

Return type

str

property network_anchor_id

Gets the network_anchor_id of this MulticloudResourceSummary. The OCID of the network anchor associated with the resource.

Returns

The network_anchor_id of this MulticloudResourceSummary.

Return type

str

property network_anchor_name

Gets the network_anchor_name of this MulticloudResourceSummary. Name of the network anchor associated with the resource.

Returns

The network_anchor_name of this MulticloudResourceSummary.

Return type

str

property resource_additional_properties

Gets the resource_additional_properties of this MulticloudResourceSummary. Additional attributes specific to certain resource types, used to construct a URL for accessing the resource in the OCI console.

Returns

The resource_additional_properties of this MulticloudResourceSummary.

Return type

dict(str, object)

property resource_display_name

Gets the resource_display_name of this MulticloudResourceSummary. Endpoint used to retrieve the resource’s display name and lifecycle state.

Returns

The resource_display_name of this MulticloudResourceSummary.

Return type

str

property resource_id

[Required] Gets the resource_id of this MulticloudResourceSummary. The Id of the multicloud resource.

Returns

The resource_id of this MulticloudResourceSummary.

Return type

str

property resource_type

Gets the resource_type of this MulticloudResourceSummary. Type of resource, such as VMCluster or ExaInfra,

Returns

The resource_type of this MulticloudResourceSummary.

Return type

str

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this MulticloudResourceSummary. The date and time the subscription was created, in the format defined by RFC 3339.

Returns

The time_created of this MulticloudResourceSummary.

Return type

datetime

property time_updated

Gets the time_updated of this MulticloudResourceSummary. The date and time the subscription was updated, in the format defined by RFC 3339.

Returns

The time_updated of this MulticloudResourceSummary.

Return type

datetime

property vcn_id

Gets the vcn_id of this MulticloudResourceSummary. Id of the virtual cloud network (VCN) associated with the resource.

Returns

The vcn_id of this MulticloudResourceSummary.

Return type

str

property vcn_name

Gets the vcn_name of this MulticloudResourceSummary. Name of the virtual cloud network (VCN) associated with the resource.

Returns

The vcn_name of this MulticloudResourceSummary.

Return type

str