RuntimePlugin

Trait RuntimePlugin 

Source
pub trait RuntimePlugin:
    Debug
    + Send
    + Sync {
    // Provided methods
    fn order(&self) -> Order { ... }
    fn config(&self) -> Option<FrozenLayer> { ... }
    fn runtime_components(
        &self,
        current_components: &RuntimeComponentsBuilder,
    ) -> Cow<'_, RuntimeComponentsBuilder> { ... }
}
Expand description

Runtime plugin trait

A RuntimePlugin is the unit of configuration for augmenting the client with new behavior.

Runtime plugins can register interceptors, set runtime components, and modify configuration.

Provided Methods§

Source

fn order(&self) -> Order

Runtime plugin ordering.

There are two runtime plugin “levels” that run in the following order:

  1. Service runtime plugins - runtime plugins that pertain to the entire service.
  2. Operation runtime plugins - runtime plugins relevant only to a single operation.

This function is used to determine runtime plugin order within those levels. So regardless of this Order value, service runtime plugins will still always execute before operation runtime plugins. However, Defaults service runtime plugins will run before Overrides service runtime plugins.

Source

fn config(&self) -> Option<FrozenLayer>

Optionally returns additional config that should be added to the ConfigBag.

As a best practice, a frozen layer should be stored on the runtime plugin instance as a member, and then cloned upon return since that clone is cheap. Constructing a new Layer and freezing it will require a lot of allocations.

Source

fn runtime_components( &self, current_components: &RuntimeComponentsBuilder, ) -> Cow<'_, RuntimeComponentsBuilder>

Returns a RuntimeComponentsBuilder to incorporate into the final runtime components.

The order of runtime plugins determines which runtime components “win”. Components set by later runtime plugins will override those set by earlier runtime plugins.

If no runtime component changes are desired, just return an empty builder.

This method returns a Cow for flexibility. Some implementers may want to store the components builder as a member and return a reference to it, while others may need to create the builder every call. If possible, returning a reference is preferred for performance.

Components configured by previous runtime plugins are in the current_components argument, and can be used to create nested/wrapped components, such as a connector calling into an inner (customer provided) connector.

Implementations on Foreign Types§

Source§

impl RuntimePlugin for PayloadSigningOverrideRuntimePlugin

Source§

impl RuntimePlugin for NoAuthRuntimePlugin

Source§

impl RuntimePlugin for EnforceContentLengthRuntimePlugin

Source§

impl RuntimePlugin for MetricsRuntimePlugin

Source§

impl RuntimePlugin for CannedResponseDeserializer

Source§

impl RuntimePlugin for CannedRequestSerializer

Implementors§

Source§

impl RuntimePlugin for BatchGetNamedQuery

Source§

impl RuntimePlugin for BatchGetPreparedStatement

Source§

impl RuntimePlugin for BatchGetQueryExecution

Source§

impl RuntimePlugin for CancelCapacityReservation

Source§

impl RuntimePlugin for CreateCapacityReservation

Source§

impl RuntimePlugin for CreateDataCatalog

Source§

impl RuntimePlugin for CreateNamedQuery

Source§

impl RuntimePlugin for CreateNotebook

Source§

impl RuntimePlugin for CreatePreparedStatement

Source§

impl RuntimePlugin for CreatePresignedNotebookUrl

Source§

impl RuntimePlugin for CreateWorkGroup

Source§

impl RuntimePlugin for DeleteCapacityReservation

Source§

impl RuntimePlugin for DeleteDataCatalog

Source§

impl RuntimePlugin for DeleteNamedQuery

Source§

impl RuntimePlugin for DeleteNotebook

Source§

impl RuntimePlugin for DeletePreparedStatement

Source§

impl RuntimePlugin for DeleteWorkGroup

Source§

impl RuntimePlugin for ExportNotebook

Source§

impl RuntimePlugin for GetCalculationExecution

Source§

impl RuntimePlugin for GetCalculationExecutionCode

Source§

impl RuntimePlugin for GetCalculationExecutionStatus

Source§

impl RuntimePlugin for GetCapacityAssignmentConfiguration

Source§

impl RuntimePlugin for GetCapacityReservation

Source§

impl RuntimePlugin for GetDataCatalog

Source§

impl RuntimePlugin for GetDatabase

Source§

impl RuntimePlugin for GetNamedQuery

Source§

impl RuntimePlugin for GetNotebookMetadata

Source§

impl RuntimePlugin for GetPreparedStatement

Source§

impl RuntimePlugin for GetQueryExecution

Source§

impl RuntimePlugin for GetQueryResults

Source§

impl RuntimePlugin for GetQueryRuntimeStatistics

Source§

impl RuntimePlugin for GetSession

Source§

impl RuntimePlugin for GetSessionStatus

Source§

impl RuntimePlugin for GetTableMetadata

Source§

impl RuntimePlugin for GetWorkGroup

Source§

impl RuntimePlugin for ImportNotebook

Source§

impl RuntimePlugin for ListApplicationDPUSizes

Source§

impl RuntimePlugin for ListCalculationExecutions

Source§

impl RuntimePlugin for ListCapacityReservations

Source§

impl RuntimePlugin for ListDataCatalogs

Source§

impl RuntimePlugin for ListDatabases

Source§

impl RuntimePlugin for ListEngineVersions

Source§

impl RuntimePlugin for ListExecutors

Source§

impl RuntimePlugin for ListNamedQueries

Source§

impl RuntimePlugin for ListNotebookMetadata

Source§

impl RuntimePlugin for ListNotebookSessions

Source§

impl RuntimePlugin for ListPreparedStatements

Source§

impl RuntimePlugin for ListQueryExecutions

Source§

impl RuntimePlugin for ListSessions

Source§

impl RuntimePlugin for ListTableMetadata

Source§

impl RuntimePlugin for ListTagsForResource

Source§

impl RuntimePlugin for ListWorkGroups

Source§

impl RuntimePlugin for PutCapacityAssignmentConfiguration

Source§

impl RuntimePlugin for StartCalculationExecution

Source§

impl RuntimePlugin for StartQueryExecution

Source§

impl RuntimePlugin for StartSession

Source§

impl RuntimePlugin for StopCalculationExecution

Source§

impl RuntimePlugin for StopQueryExecution

Source§

impl RuntimePlugin for TagResource

Source§

impl RuntimePlugin for TerminateSession

Source§

impl RuntimePlugin for UntagResource

Source§

impl RuntimePlugin for UpdateCapacityReservation

Source§

impl RuntimePlugin for UpdateDataCatalog

Source§

impl RuntimePlugin for UpdateNamedQuery

Source§

impl RuntimePlugin for UpdateNotebook

Source§

impl RuntimePlugin for UpdateNotebookMetadata

Source§

impl RuntimePlugin for UpdatePreparedStatement

Source§

impl RuntimePlugin for UpdateWorkGroup

Source§

impl RuntimePlugin for StaticRuntimePlugin

Source§

impl RuntimePlugin for SharedRuntimePlugin