OutboundConnectorSummary

class oci.file_storage.models.OutboundConnectorSummary(**kwargs)

Bases: object

Summary information for an outbound connector.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

availability_domain

Gets the availability_domain of this OutboundConnectorSummary.

compartment_id

[Required] Gets the compartment_id of this OutboundConnectorSummary.

connector_type

[Required] Gets the connector_type of this OutboundConnectorSummary.

defined_tags

Gets the defined_tags of this OutboundConnectorSummary.

display_name

[Required] Gets the display_name of this OutboundConnectorSummary.

freeform_tags

Gets the freeform_tags of this OutboundConnectorSummary. 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"}.

id

[Required] Gets the id of this OutboundConnectorSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this OutboundConnectorSummary.

locks

Gets the locks of this OutboundConnectorSummary.

system_tags

Gets the system_tags of this OutboundConnectorSummary.

time_created

[Required] Gets the time_created of this OutboundConnectorSummary.

Methods:

__init__(**kwargs)

Initializes a new OutboundConnectorSummary object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

__init__(**kwargs)

Initializes a new OutboundConnectorSummary object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • availability_domain (str) – The value to assign to the availability_domain property of this OutboundConnectorSummary.

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

  • id (str) – The value to assign to the id property of this OutboundConnectorSummary.

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

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

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

  • locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this OutboundConnectorSummary.

  • connector_type (str) – The value to assign to the connector_type property of this OutboundConnectorSummary.

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

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

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

property availability_domain

Gets the availability_domain of this OutboundConnectorSummary. The availability domain the outbound connector is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns

The availability_domain of this OutboundConnectorSummary.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this OutboundConnectorSummary. The `OCID`__ of the compartment that contains the outbound connector.

Returns

The compartment_id of this OutboundConnectorSummary.

Return type

str

property connector_type

[Required] Gets the connector_type of this OutboundConnectorSummary. The account type of this outbound connector.

Returns

The connector_type of this OutboundConnectorSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this OutboundConnectorSummary. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: My outbound connector

Returns

The display_name of this OutboundConnectorSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id

[Required] Gets the id of this OutboundConnectorSummary. The `OCID`__ of the outbound connector.

Returns

The id of this OutboundConnectorSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this OutboundConnectorSummary. The current state of this outbound connector.

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

Returns

The lifecycle_state of this OutboundConnectorSummary.

Return type

str

property locks

Gets the locks of this OutboundConnectorSummary. Locks associated with this resource.

Returns

The locks of this OutboundConnectorSummary.

Return type

list[oci.file_storage.models.ResourceLock]

property system_tags

Gets the system_tags of this OutboundConnectorSummary. System tags for this resource. System tags are applied to resources by internal OCI services.

Returns

The system_tags of this OutboundConnectorSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this OutboundConnectorSummary. The date and time the outbound connector was created in `RFC 3339`__ timestamp format. Example: 2016-08-25T21:10:29.600Z

Returns

The time_created of this OutboundConnectorSummary.

Return type

datetime