Skip to main content

PluginConfig

This class defines properties that help the system optimize itself to handle a specific plugin. It includes configurations for resource quotas, read and write rate limiters, caching characteristics, and a custom state for resource metadata.

Attributes

AttributeTypeDescription
ResourceQuotas[ResourceQuotas](resourcequotas.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcequotas)ResourceQuotas allows the plugin to register resources' quotas to ensure the system comply with restrictions in the remote service.
ReadRateLimiter[RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig)Defines rate limiter properties for read actions (e.g. retrieve status).
WriteRateLimiter[RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig)Defines rate limiter properties for write actions.
Caching[CachingConfig](cachingconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_cachingconfig)Defines caching characteristics.
ResourceMeta[ResourceMeta](resourcemeta.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcemeta)Gets an empty copy for the custom state that can be used in ResourceMeta when interacting with the remote service.

Constructor

Signature

def PluginConfig(
ResourceQuotas: [ResourceQuotas](resourcequotas.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcequotas) = null,
ReadRateLimiter: [RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig) = null,
WriteRateLimiter: [RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig) = null,
Caching: [CachingConfig](cachingconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_cachingconfig) = null,
ResourceMeta: [ResourceMeta](resourcemeta.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcemeta) = null
) - > null

Parameters

NameTypeDescription
ResourceQuotas[ResourceQuotas](resourcequotas.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcequotas) = nullAllows the plugin to register resources' quotas to ensure the system comply with restrictions in the remote service.
ReadRateLimiter[RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig) = nullDefines rate limiter properties for read actions (e.g. retrieve status).
WriteRateLimiter[RateLimiterConfig](ratelimiterconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_ratelimiterconfig) = nullDefines rate limiter properties for write actions.
Caching[CachingConfig](cachingconfig.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_cachingconfig) = nullDefines caching characteristics.
ResourceMeta[ResourceMeta](resourcemeta.md?sid=flyteplugins_go_tasks_pluginmachinery_webapi_resourcemeta) = nullGets an empty copy for the custom state that can be used in ResourceMeta when interacting with the remote service.