NetworkAnchor¶

class oci.multicloud.models.NetworkAnchor(**kwargs)¶

Bases: object

A NetworkAnchor is a description of a NetworkAnchor.

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

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a NetworkAnchor.
`SETUP_MODE_AUTO_BIND`	A constant which can be used with the setup_mode property of a NetworkAnchor.
`SETUP_MODE_NO_AUTO_BIND`	A constant which can be used with the setup_mode property of a NetworkAnchor.
`cloud_service_provider_metadata_item`	Gets the cloud_service_provider_metadata_item of this NetworkAnchor.
`compartment_id`	[Required] Gets the compartment_id of this NetworkAnchor.
`defined_tags`	[Required] Gets the defined_tags of this NetworkAnchor.
`display_name`	[Required] Gets the display_name of this NetworkAnchor.
`freeform_tags`	[Required] Gets the freeform_tags of this NetworkAnchor.
`id`	[Required] Gets the id of this NetworkAnchor.
`lifecycle_details`	Gets the lifecycle_details of this NetworkAnchor.
`lifecycle_state`	[Required] Gets the lifecycle_state of this NetworkAnchor.
`oci_metadata_item`	Gets the oci_metadata_item of this NetworkAnchor.
`resource_anchor_id`	[Required] Gets the resource_anchor_id of this NetworkAnchor.
`setup_mode`	Gets the setup_mode of this NetworkAnchor.
`system_tags`	Gets the system_tags of this NetworkAnchor.
`time_created`	[Required] Gets the time_created of this NetworkAnchor.
`time_updated`	Gets the time_updated of this NetworkAnchor.

Methods

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

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

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

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

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

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

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

SETUP_MODE_AUTO_BIND = 'AUTO_BIND'¶: A constant which can be used with the setup_mode property of a NetworkAnchor. This constant has a value of “AUTO_BIND”

SETUP_MODE_NO_AUTO_BIND = 'NO_AUTO_BIND'¶: A constant which can be used with the setup_mode property of a NetworkAnchor. This constant has a value of “NO_AUTO_BIND”

__init__(**kwargs)¶

Initializes a new NetworkAnchor 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 NetworkAnchor.
display_name (str) – The value to assign to the display_name property of this NetworkAnchor.
compartment_id (str) – The value to assign to the compartment_id property of this NetworkAnchor.
resource_anchor_id (str) – The value to assign to the resource_anchor_id property of this NetworkAnchor.
time_created (datetime) – The value to assign to the time_created property of this NetworkAnchor.
time_updated (datetime) – The value to assign to the time_updated property of this NetworkAnchor.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NetworkAnchor. 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 NetworkAnchor.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NetworkAnchor.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NetworkAnchor.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this NetworkAnchor.
setup_mode (str) – The value to assign to the setup_mode property of this NetworkAnchor. Allowed values for this property are: “AUTO_BIND”, “NO_AUTO_BIND”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
oci_metadata_item (oci.multicloud.models.OciNetworkMetadata) – The value to assign to the oci_metadata_item property of this NetworkAnchor.
cloud_service_provider_metadata_item (oci.multicloud.models.CloudServiceProviderNetworkMetadataItem) – The value to assign to the cloud_service_provider_metadata_item property of this NetworkAnchor.

cloud_service_provider_metadata_item¶

Gets the cloud_service_provider_metadata_item of this NetworkAnchor.

Returns:	The cloud_service_provider_metadata_item of this NetworkAnchor.
Return type:	oci.multicloud.models.CloudServiceProviderNetworkMetadataItem

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this NetworkAnchor. The OCID of the NetworkAnchor.

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

lifecycle_details¶

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

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

lifecycle_state¶

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

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

oci_metadata_item¶

Gets the oci_metadata_item of this NetworkAnchor.

Returns:	The oci_metadata_item of this NetworkAnchor.
Return type:	oci.multicloud.models.OciNetworkMetadata

resource_anchor_id¶

[Required] Gets the resource_anchor_id of this NetworkAnchor. OCI resource anchor Id (OCID).

Returns:	The resource_anchor_id of this NetworkAnchor.
Return type:	str

setup_mode¶

Gets the setup_mode of this NetworkAnchor. AUTO_BIND - when passed compartment will be created on-behalf of customer and bind to this resource anchor NO_AUTO_BIND - compartment will not be created and later customer can bind existing compartment. to this resource anchor. This is for future use only

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

Returns:	The setup_mode of this NetworkAnchor.
Return type:	str

system_tags¶

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

time_created¶

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

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

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

Example: 2016-08-25T21:10:29.600Z

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