OutboundConnector¶

class oci.file_storage.models.OutboundConnector(**kwargs)¶

Bases: object

Outbound connectors are used to help File Storage communicate with an external server, such as an LDAP server. An outbound connector contains all the information needed to connect, authenticate, and gain authorization to perform the account’s required functions.

Attributes

`CONNECTOR_TYPE_LDAPBIND`	A constant which can be used with the connector_type property of a OutboundConnector.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OutboundConnector.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OutboundConnector.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OutboundConnector.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OutboundConnector.
`availability_domain`	Gets the availability_domain of this OutboundConnector.
`compartment_id`	[Required] Gets the compartment_id of this OutboundConnector.
`connector_type`	[Required] Gets the connector_type of this OutboundConnector.
`defined_tags`	Gets the defined_tags of this OutboundConnector.
`display_name`	[Required] Gets the display_name of this OutboundConnector.
`freeform_tags`	Gets the freeform_tags of this OutboundConnector.
`id`	[Required] Gets the id of this OutboundConnector.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OutboundConnector.
`time_created`	[Required] Gets the time_created of this OutboundConnector.

Methods

`__init__`(**kwargs)	Initializes a new OutboundConnector 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.

CONNECTOR_TYPE_LDAPBIND = 'LDAPBIND'¶: A constant which can be used with the connector_type property of a OutboundConnector. This constant has a value of “LDAPBIND”

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

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

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

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

__init__(**kwargs)¶

Initializes a new OutboundConnector 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:

LdapBindAccount

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 OutboundConnector.
compartment_id (str) – The value to assign to the compartment_id property of this OutboundConnector.
id (str) – The value to assign to the id property of this OutboundConnector.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OutboundConnector. 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 OutboundConnector.
time_created (datetime) – The value to assign to the time_created property of this OutboundConnector.
connector_type (str) – The value to assign to the connector_type property of this OutboundConnector. Allowed values for this property are: “LDAPBIND”, ‘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 OutboundConnector.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OutboundConnector.

availability_domain¶

Gets the availability_domain of this OutboundConnector. 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 OutboundConnector.
Return type:	str

compartment_id¶

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

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

connector_type¶

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

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

Returns:	The connector_type of this OutboundConnector.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this OutboundConnector. 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 OutboundConnector.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this OutboundConnector. The OCID of the outbound connector.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OutboundConnector. 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 OutboundConnector.
Return type:	str

time_created¶

[Required] Gets the time_created of this OutboundConnector. 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 OutboundConnector.
Return type:	datetime