hipcheck_sdk.gen package¶
Submodules¶
hipcheck_sdk.gen.hipcheck_pb2 module¶
Generated protocol buffer code.
hipcheck_sdk.gen.hipcheck_pb2_grpc module¶
Client and server classes corresponding to protobuf-defined services.
- class hipcheck_sdk.gen.hipcheck_pb2_grpc.PluginService[source]¶
Bases:
object
Missing associated documentation comment in .proto file.
- static ExplainDefaultQuery(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]¶
- static GetDefaultPolicyExpression(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]¶
- static GetQuerySchemas(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None)[source]¶
- class hipcheck_sdk.gen.hipcheck_pb2_grpc.PluginServiceServicer[source]¶
Bases:
object
Missing associated documentation comment in .proto file.
- ExplainDefaultQuery(request, context)[source]¶
Get an explanation of what the default query returns, to use when reporting analysis results to users.
Note that, because users can specify their own policy expression, this explanation should not assume the user has used the default policy expression, if one is provided by the plugin.
- GetDefaultPolicyExpression(request, context)[source]¶
Get the default policy for a plugin, which may additionally depend on the plugin’s configuration.
- GetQuerySchemas(request, context)[source]¶
Get schemas for all supported queries by the plugin.
This is used by Hipcheck to validate that:
The plugin supports a default query taking a target type if used
as a top-level plugin in the user’s policy file. - That requests sent to the plugin and data returned by the plugin match the schema during execution.
- InitiateQueryProtocol(request_iterator, context)[source]¶
Open a bidirectional streaming RPC to enable a request/response protocol between Hipcheck and a plugin, where Hipcheck can issue queries to the plugin, and the plugin may issue queries to _other_ plugins through Hipcheck.
Queries are cached by the publisher name, plugin name, query name, and key, and if a match is found for those four values, then Hipcheck will respond with the cached result of that prior matching query rather than running the query again.