SourceConnectorPluginSummary

class oci.sch.models.SourceConnectorPluginSummary(**kwargs)

Bases: oci.sch.models.connector_plugin_summary.ConnectorPluginSummary

Summary information for a connector plugin that fetches data from a source service. For configuration instructions, see Creating a Connector.

Attributes

ESTIMATED_THROUGHPUT_HIGH str(object=’’) -> str
ESTIMATED_THROUGHPUT_LOW str(object=’’) -> str
ESTIMATED_THROUGHPUT_MEDIUM str(object=’’) -> str
ESTIMATED_THROUGHPUT_UNKNOWN str(object=’’) -> str
KIND_SOURCE str(object=’’) -> str
KIND_TARGET str(object=’’) -> str
LIFECYCLE_STATE_ACTIVE str(object=’’) -> str
LIFECYCLE_STATE_DELETED str(object=’’) -> str
display_name [Required] Gets the display_name of this ConnectorPluginSummary.
estimated_throughput Gets the estimated_throughput of this ConnectorPluginSummary.
kind [Required] Gets the kind of this ConnectorPluginSummary.
lifecycle_state [Required] Gets the lifecycle_state of this ConnectorPluginSummary.
max_retention Gets the max_retention of this SourceConnectorPluginSummary.
name [Required] Gets the name of this ConnectorPluginSummary.
time_created [Required] Gets the time_created of this ConnectorPluginSummary.

Methods

__init__(**kwargs) Initializes a new SourceConnectorPluginSummary 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'
ESTIMATED_THROUGHPUT_LOW = 'LOW'
ESTIMATED_THROUGHPUT_MEDIUM = 'MEDIUM'
ESTIMATED_THROUGHPUT_UNKNOWN = 'UNKNOWN'
KIND_SOURCE = 'SOURCE'
KIND_TARGET = 'TARGET'
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'
LIFECYCLE_STATE_DELETED = 'DELETED'
__init__(**kwargs)

Initializes a new SourceConnectorPluginSummary object with values from keyword arguments. The default value of the kind attribute of this class is SOURCE and it should not be changed. 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 SourceConnectorPluginSummary. Allowed values for this property are: “SOURCE”, “TARGET”
  • name (str) – The value to assign to the name property of this SourceConnectorPluginSummary.
  • time_created (datetime) – The value to assign to the time_created property of this SourceConnectorPluginSummary.
  • estimated_throughput (str) – The value to assign to the estimated_throughput property of this SourceConnectorPluginSummary. Allowed values for this property are: “LOW”, “MEDIUM”, “HIGH”, “UNKNOWN”
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SourceConnectorPluginSummary. Allowed values for this property are: “ACTIVE”, “DELETED”
  • display_name (str) – The value to assign to the display_name property of this SourceConnectorPluginSummary.
  • max_retention (str) – The value to assign to the max_retention property of this SourceConnectorPluginSummary.
display_name

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

Gets the estimated_throughput of this ConnectorPluginSummary. 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 ConnectorPluginSummary.
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 ConnectorPluginSummary. 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 ConnectorPluginSummary.
Return type:str
lifecycle_state

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

Gets the max_retention of this SourceConnectorPluginSummary. The estimated maximum period of time the data will be kept at the source.

description: |
Returns:The max_retention of this SourceConnectorPluginSummary.
Return type:str
name

[Required] Gets the name of this ConnectorPluginSummary. The service to be called by the connector plugin.

Returns:The name of this ConnectorPluginSummary.
Return type:str
time_created

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

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