Class ScriptServiceGrpc
java.lang.Object
com.soulfiremc.grpc.generated.ScriptServiceGrpc
ScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire. The visual scripting system allows users to create automation workflows by connecting nodes in a graph. Each node represents an action, condition, or event trigger. Nodes are connected by edges that define execution flow and data transfer. SCRIPT LIFECYCLE: 1. Create a script using CreateScript with initial nodes/edges or empty graph 2. Edit the script using UpdateScript to modify the node graph 3. Activate the script using ActivateScript to register event listeners 4. Monitor execution via SubscribeScriptEvents or GetScriptStatus 5. Deactivate using DeactivateScript when done 6. Delete unused scripts with DeleteScript Scripts are reactive state machines - they don't "run" but rather listen for trigger events and execute node chains in response. Activation registers the listeners, deactivation removes them and cancels any pending async operations. PERMISSIONS: Script operations require appropriate instance permissions. The specific permissions are TBD but will likely include: - READ_SCRIPT: View script definitions and status - UPDATE_SCRIPT: Create, modify, and delete scripts - EXECUTE_SCRIPT: Activate and deactivate scripts LOGGING: Script execution logs can be streamed via SubscribeScriptLogs or filtered using InstanceScriptLogScope in the LogsService (see logs.proto).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceScriptService provides management and execution capabilities for visual node-based automation scripts within SoulFire.static final classA stub to allow clients to do limited synchronous rpc calls to service ScriptService.static final classA stub to allow clients to do synchronous rpc calls to service ScriptService.static final classA stub to allow clients to do ListenableFuture-style rpc calls to service ScriptService.static classBase class for the server implementation of the service ScriptService.static final classA stub to allow clients to do asynchronous rpc calls to service ScriptService. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic final io.grpc.ServerServiceDefinitionstatic io.grpc.MethodDescriptor<ActivateScriptRequest, ScriptEvent> static io.grpc.MethodDescriptor<CreateScriptRequest, CreateScriptResponse> static io.grpc.MethodDescriptor<DeactivateScriptRequest, DeactivateScriptResponse> static io.grpc.MethodDescriptor<DeleteScriptRequest, DeleteScriptResponse> static io.grpc.MethodDescriptor<DryRunScriptRequest, ScriptEvent> static io.grpc.MethodDescriptor<GetNodeTypesRequest, GetNodeTypesResponse> static io.grpc.MethodDescriptor<GetRegistryDataRequest, GetRegistryDataResponse> static io.grpc.MethodDescriptor<GetScriptRequest, GetScriptResponse> static io.grpc.MethodDescriptor<GetScriptStatusRequest, GetScriptStatusResponse> static io.grpc.MethodDescriptor<ListScriptsRequest, ListScriptsResponse> static io.grpc.ServiceDescriptorstatic io.grpc.MethodDescriptor<SubscribeScriptLogsRequest, ScriptLogEntry> static io.grpc.MethodDescriptor<UpdateScriptRequest, UpdateScriptResponse> static io.grpc.MethodDescriptor<ValidateScriptRequest, ValidateScriptResponse> newBlockingStub(io.grpc.Channel channel) Creates a new blocking-style stub that supports unary and streaming output calls on the servicenewBlockingV2Stub(io.grpc.Channel channel) Creates a new blocking-style stub that supports all types of calls on the servicenewFutureStub(io.grpc.Channel channel) Creates a new ListenableFuture-style stub that supports unary calls on the servicenewStub(io.grpc.Channel channel) Creates a new async stub that supports all call types for the service
-
Field Details
-
SERVICE_NAME
- See Also:
-
-
Method Details
-
getCreateScriptMethod
public static io.grpc.MethodDescriptor<CreateScriptRequest, CreateScriptResponse> getCreateScriptMethod() -
getGetScriptMethod
-
getUpdateScriptMethod
public static io.grpc.MethodDescriptor<UpdateScriptRequest, UpdateScriptResponse> getUpdateScriptMethod() -
getDeleteScriptMethod
public static io.grpc.MethodDescriptor<DeleteScriptRequest, DeleteScriptResponse> getDeleteScriptMethod() -
getListScriptsMethod
public static io.grpc.MethodDescriptor<ListScriptsRequest, ListScriptsResponse> getListScriptsMethod() -
getActivateScriptMethod
public static io.grpc.MethodDescriptor<ActivateScriptRequest, ScriptEvent> getActivateScriptMethod() -
getDeactivateScriptMethod
public static io.grpc.MethodDescriptor<DeactivateScriptRequest, DeactivateScriptResponse> getDeactivateScriptMethod() -
getGetScriptStatusMethod
public static io.grpc.MethodDescriptor<GetScriptStatusRequest, GetScriptStatusResponse> getGetScriptStatusMethod() -
getSubscribeScriptLogsMethod
public static io.grpc.MethodDescriptor<SubscribeScriptLogsRequest, ScriptLogEntry> getSubscribeScriptLogsMethod() -
getGetNodeTypesMethod
public static io.grpc.MethodDescriptor<GetNodeTypesRequest, GetNodeTypesResponse> getGetNodeTypesMethod() -
getGetRegistryDataMethod
public static io.grpc.MethodDescriptor<GetRegistryDataRequest, GetRegistryDataResponse> getGetRegistryDataMethod() -
getValidateScriptMethod
public static io.grpc.MethodDescriptor<ValidateScriptRequest, ValidateScriptResponse> getValidateScriptMethod() -
getDryRunScriptMethod
-
newStub
Creates a new async stub that supports all call types for the service -
newBlockingV2Stub
public static ScriptServiceGrpc.ScriptServiceBlockingV2Stub newBlockingV2Stub(io.grpc.Channel channel) Creates a new blocking-style stub that supports all types of calls on the service -
newBlockingStub
Creates a new blocking-style stub that supports unary and streaming output calls on the service -
newFutureStub
Creates a new ListenableFuture-style stub that supports unary calls on the service -
bindService
public static final io.grpc.ServerServiceDefinition bindService(ScriptServiceGrpc.AsyncService service) -
getServiceDescriptor
public static io.grpc.ServiceDescriptor getServiceDescriptor()
-