PluginSourceDetailsResponse¶
-
class
oci.sch.models.
PluginSourceDetailsResponse
(**kwargs)¶ Bases:
oci.sch.models.source_details_response.SourceDetailsResponse
Details about a connector plugin used to fetch data from a source. For configuration instructions, see Creating a Connector.
Attributes
KIND_LOGGING
str(object=’’) -> str KIND_MONITORING
str(object=’’) -> str KIND_PLUGIN
str(object=’’) -> str KIND_STREAMING
str(object=’’) -> str config_map
[Required] Gets the config_map of this PluginSourceDetailsResponse. kind
[Required] Gets the kind of this SourceDetailsResponse. plugin_name
[Required] Gets the plugin_name of this PluginSourceDetailsResponse. private_endpoint_metadata
Gets the private_endpoint_metadata of this SourceDetailsResponse. Methods
__init__
(**kwargs)Initializes a new PluginSourceDetailsResponse 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. -
KIND_LOGGING
= 'logging'¶
-
KIND_MONITORING
= 'monitoring'¶
-
KIND_PLUGIN
= 'plugin'¶
-
KIND_STREAMING
= 'streaming'¶
-
__init__
(**kwargs)¶ Initializes a new PluginSourceDetailsResponse object with values from keyword arguments. The default value of the
kind
attribute of this class isplugin
and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):Parameters: - private_endpoint_metadata (oci.sch.models.PrivateEndpointMetadata) – The value to assign to the private_endpoint_metadata property of this PluginSourceDetailsResponse.
- kind (str) – The value to assign to the kind property of this PluginSourceDetailsResponse. Allowed values for this property are: “logging”, “monitoring”, “streaming”, “plugin”
- plugin_name (str) – The value to assign to the plugin_name property of this PluginSourceDetailsResponse.
- config_map (object) – The value to assign to the config_map property of this PluginSourceDetailsResponse.
-
config_map
¶ [Required] Gets the config_map of this PluginSourceDetailsResponse. The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for QueueSource, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using
get_connector_plugin()
and review its schema value.Returns: The config_map of this PluginSourceDetailsResponse. Return type: object
-
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 SourceDetailsResponse. The type discriminator.
Allowed values for this property are: “logging”, “monitoring”, “streaming”, “plugin”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The kind of this SourceDetailsResponse. Return type: str
-
plugin_name
¶ [Required] Gets the plugin_name of this PluginSourceDetailsResponse. The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, QueueSource indicates the Queue service. To find names of connector plugins, list the plugin using
list_connector_plugins()
.Returns: The plugin_name of this PluginSourceDetailsResponse. Return type: str
-
private_endpoint_metadata
¶ Gets the private_endpoint_metadata of this SourceDetailsResponse.
Returns: The private_endpoint_metadata of this SourceDetailsResponse. Return type: oci.sch.models.PrivateEndpointMetadata
-