ConnectorPlugin¶

class oci.sch.models.ConnectorPlugin(**kwargs)¶

Bases: object

A service source or service target used to create a connector. Example connector plugins include the Queue source and the Notifications target. For more information about flows defined by connectors, see Overview of Connector Hub. For configuration instructions, see Creating a Connector.

Attributes

`ESTIMATED_THROUGHPUT_HIGH`	A constant which can be used with the estimated_throughput property of a ConnectorPlugin.
`ESTIMATED_THROUGHPUT_LOW`	A constant which can be used with the estimated_throughput property of a ConnectorPlugin.
`ESTIMATED_THROUGHPUT_MEDIUM`	A constant which can be used with the estimated_throughput property of a ConnectorPlugin.
`ESTIMATED_THROUGHPUT_UNKNOWN`	A constant which can be used with the estimated_throughput property of a ConnectorPlugin.
`KIND_SOURCE`	A constant which can be used with the kind property of a ConnectorPlugin.
`KIND_TARGET`	A constant which can be used with the kind property of a ConnectorPlugin.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ConnectorPlugin.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ConnectorPlugin.
`display_name`	[Required] Gets the display_name of this ConnectorPlugin.
`estimated_throughput`	Gets the estimated_throughput of this ConnectorPlugin.
`kind`	[Required] Gets the kind of this ConnectorPlugin.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConnectorPlugin.
`name`	[Required] Gets the name of this ConnectorPlugin.
`schema`	Gets the schema of this ConnectorPlugin.
`time_created`	[Required] Gets the time_created of this ConnectorPlugin.

Methods

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

ESTIMATED_THROUGHPUT_HIGH = 'HIGH'¶: A constant which can be used with the estimated_throughput property of a ConnectorPlugin. This constant has a value of “HIGH”

ESTIMATED_THROUGHPUT_LOW = 'LOW'¶: A constant which can be used with the estimated_throughput property of a ConnectorPlugin. This constant has a value of “LOW”

ESTIMATED_THROUGHPUT_MEDIUM = 'MEDIUM'¶: A constant which can be used with the estimated_throughput property of a ConnectorPlugin. This constant has a value of “MEDIUM”

ESTIMATED_THROUGHPUT_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the estimated_throughput property of a ConnectorPlugin. This constant has a value of “UNKNOWN”

KIND_SOURCE = 'SOURCE'¶: A constant which can be used with the kind property of a ConnectorPlugin. This constant has a value of “SOURCE”

KIND_TARGET = 'TARGET'¶: A constant which can be used with the kind property of a ConnectorPlugin. This constant has a value of “TARGET”

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

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

__init__(**kwargs)¶

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

kind (str) – The value to assign to the kind property of this ConnectorPlugin. Allowed values for this property are: “SOURCE”, “TARGET”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
name (str) – The value to assign to the name property of this ConnectorPlugin.
time_created (datetime) – The value to assign to the time_created property of this ConnectorPlugin.
estimated_throughput (str) – The value to assign to the estimated_throughput property of this ConnectorPlugin. Allowed values for this property are: “LOW”, “MEDIUM”, “HIGH”, “UNKNOWN”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConnectorPlugin. Allowed values for this property are: “ACTIVE”, “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 ConnectorPlugin.
schema (str) – The value to assign to the schema property of this ConnectorPlugin.

display_name¶

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

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

estimated_throughput¶

Gets the estimated_throughput of this ConnectorPlugin. The estimated throughput range (LOW, MEDIUM, HIGH).

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

Returns:	The estimated_throughput of this ConnectorPlugin.
Return type:	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.

kind¶

[Required] Gets the kind of this ConnectorPlugin. The plugin type discriminator.

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

Returns:	The kind of this ConnectorPlugin.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConnectorPlugin. The current state of the service connector.

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

Returns:	The lifecycle_state of this ConnectorPlugin.
Return type:	str

name¶

[Required] Gets the name of this ConnectorPlugin. The service to be called by the connector plugin. Example: QueueSource

Returns:	The name of this ConnectorPlugin.
Return type:	str

schema¶

Gets the schema of this ConnectorPlugin. Gets the specified connector plugin configuration information in OpenAPI specification format.

Returns:	The schema of this ConnectorPlugin.
Return type:	str

time_created¶

[Required] Gets the time_created of this ConnectorPlugin. The date and time when this plugin became available. Format is defined by RFC3339. Example: 2023-09-09T21:10:29.600Z

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