Control Plane

This library exposes request and response structs under com.dataspine.controlplane, plus the ControlPlane interface that performs authenticated gRPC calls using credentials supplied by the data plane execution context. Use it when a data product needs to create or mutate control plane state as part of its processing logic.

• Library id: control-plane
• Namespace: com.dataspine.controlplane
• Version: 1
• Crate: dataspine-control-plane-runtime-library@0.1.0
• Stability: stable
• Since: 0.1.0

Types

• AddDataProductVersionRequest — Payload for publishing a semver-tagged version of an existing data product.
• AddDataProductVersionResponse — Identifier assigned to the newly published data product version.
• ApplicationDetails — Snapshot of an application's persisted metadata.
• AwsPrincipalAssociationRow — Single AWS principal association row returned by list APIs.
• BindOutletLambdaTriggerRequest — Attach outlet semver versions to a Lambda trigger.
• BindOutletLambdaTriggerResponse — Echo of the trigger binding operation.
• ClearDataProductProfileRequest — Remove a data product's custom profile so reconciler defaults apply.
• ClearDataProductProfileResponse — Acknowledgement that a data product profile was cleared.
• ControlPlane — Authenticated client for Dataspine control plane administration APIs.
• CreateApplicationAwsPrincipalAssociationRequest — Bind an AWS IAM principal ARN to an application via a Dataspine principal record.
• CreateApplicationAwsPrincipalAssociationResponse — Echo of the association that was created.
• CreateApplicationRequest — Input for registering a new application under a data product.
• CreateApplicationResponse — Identifier returned after a successful application creation.
• CreateApplicationSshPrincipalAssociationRequest — Register an SSH public key for a principal scoped to an application.
• CreateApplicationSshPrincipalAssociationResponse — Echo of the SSH association that was created.
• CreateDataProductRequest — Input for registering a new data product under an organization.
• CreateDataProductResponse — Identifiers returned after creating a data product.
• CreateOrganizationRequest — Input for provisioning a new organization in the control plane catalog.
• CreateOrganizationResponse — Identifier returned after creating an organization.
• CreateOutletLambdaTriggerRequest — Define a new AWS Lambda trigger that forwards outlet events for an application.
• CreateOutletLambdaTriggerResponse — Identifier returned after registering an outlet Lambda trigger.
• CreatePrincipalAssociationRequest — Link a Dataspine principal to an identity provider subject.
• CreatePrincipalAssociationResponse — Echo of the association that was created.
• CreatePrincipalRequest — Input for registering a new logical principal under an organization.
• CreatePrincipalResponse — Identifier returned after creating a principal.
• DataProductFile — Relative path and encoded contents for a file uploaded with a new data product version.
• DataProductSummary — Lightweight projection of a data product for list responses.
• DataProductVersionInfo — Summary metadata for a single published data product version.
• DeleteApplicationAwsPrincipalAssociationRequest — Remove an AWS IAM principal association from an application.
• DeleteApplicationAwsPrincipalAssociationResponse — Confirmation payload after removing an AWS principal association.
• DeleteApplicationRequest — Input for removing an application record from a data product.
• DeleteApplicationResponse — Confirmation payload after deleting an application.
• DeleteApplicationSshPrincipalAssociationRequest — Remove an SSH public key association from an application.
• DeleteApplicationSshPrincipalAssociationResponse — Echo of the SSH association that was deleted.
• DeleteDataProductRequest — Selector for deleting a data product and its dependent metadata.
• DeleteDataProductResponse — Confirmation payload after deleting a data product.
• DeleteDataProductVersionRequest — Delete a published semver for a data product.
• DeleteDataProductVersionResponse — Confirmation payload after deleting a data product version.
• DeleteOrganizationRequest — Delete an organization and dependent control plane metadata.
• DeleteOrganizationResponse — Acknowledgement payload for organization deletion.
• DeleteOutletLambdaTriggerRequest — Delete an outlet Lambda trigger and its delivery configuration.
• DeleteOutletLambdaTriggerResponse — Confirmation payload after deleting an outlet Lambda trigger.
• DeletePrincipalAssociationRequest — Remove an identity provider association from a principal.
• DeletePrincipalAssociationResponse — Echo of the association that was deleted.
• DeletePrincipalRequest — Delete a principal and dependent control plane metadata.
• DeletePrincipalResponse — Confirmation payload after deleting a principal.
• DescribeDataProductProfileRequest — Select a data product to read its reconciler profile and kill-switch snapshot.
• DescribeDataProductProfileResponse — Current profile document and kill-switch JSON for a data product.
• DescribeDataProductRequest — Selector for reading a single data product's metadata.
• DescribeDataProductResponse — Core metadata describing a data product.
• DescribeDataProductVersionRequest — Select a specific data product version by its UUID.
• DescribeDataProductVersionResponse — Detailed metadata for a single data product version.
• DescribeOrganizationRequest — Selector for reading a single organization's metadata.
• DescribeOrganizationResponse — Wrapper returning the fully hydrated organization record.
• DescribePrincipalRequest — Select a principal by UUID for a detailed read.
• DescribePrincipalResponse — Detailed principal view including identity associations.
• GrantPermissionRequest — Grant a relation-style permission from a principal to a resource.
• GrantPermissionResponse — Echo of the permission tuple that was granted.
• LibraryDependency — Declared dependency on a Dataspine native runtime library artifact.
• ListApplicationAwsPrincipalAssociationsRequest — Query parameters for listing AWS principal associations on an application.
• ListApplicationAwsPrincipalAssociationsResponse — Collection of AWS principal associations for an application.
• ListApplicationsRequest — Filter for listing applications that belong to a data product.
• ListApplicationsResponse — Collection of applications matching the list filter.
• ListApplicationSshPrincipalAssociationsRequest — Query parameters for listing SSH key associations on an application.
• ListApplicationSshPrincipalAssociationsResponse — Collection of SSH key associations configured for an application.
• ListDataProductsRequest — Scope a listing of data products to a single organization.
• ListDataProductsResponse — Collection of data products visible within the requested organization.
• ListDataProductVersionsRequest — Selector for listing semver versions of a data product.
• ListDataProductVersionsResponse — Version listing for a data product.
• ListOrganizationsRequest — Scope an organization listing to a parent organization.
• ListOrganizationsResponse — Collection of child organizations for the requested parent.
• ListOutletLambdaTriggerBindingsRequest — Query parameters for listing outlet version bindings on a trigger.
• ListOutletLambdaTriggerBindingsResponse — Outlet version ids currently bound to a Lambda trigger.
• ListOutletLambdaTriggersRequest — List all outlet Lambda triggers configured for an application.
• ListOutletLambdaTriggersResponse — Collection of outlet Lambda triggers for an application.
• ListPermissionsRequest — Query parameters for listing permission tuples attached to a principal.
• ListPermissionsResponse — Collection of permission tuples for a principal.
• ListPrincipalAssociationsRequest — Query parameters for listing identity associations on a principal.
• ListPrincipalAssociationsResponse — Collection of identity provider associations for a principal.
• ListPrincipalsRequest — Scope a principal listing to a single organization.
• ListPrincipalsResponse — Collection of principals for the requested organization.
• OrganizationDetails — Authoritative projection of an organization row.
• OutletLambdaTriggerSummary — Summary metadata for a configured outlet Lambda trigger.
• PermissionTuple — Serialized authorization tuple returned by list APIs.
• PrincipalAssociationDetails — Binding between a principal and an identity provider subject.
• PrincipalDetails — Summary row for a principal returned by list APIs.
• RevokePermissionRequest — Remove a previously granted permission edge.
• RevokePermissionResponse — Echo of the permission tuple that was revoked.
• SetOrganizationDefaultProfileRequest — Persist the default reconciler profile JSON for an organization.
• SetOrganizationDefaultProfileResponse — Acknowledgement of a default profile update.
• SshPrincipalAssociationRow — Single SSH public key association row returned by list APIs.
• UnbindOutletLambdaTriggerRequest — Detach outlet semver versions from a Lambda trigger.
• UnbindOutletLambdaTriggerResponse — Echo of the trigger unbind operation.
• UpdateApplicationRequest — Input for mutating tags and CORS settings on an existing application.
• UpdateApplicationResponse — Echo of the application id that was updated.
• UpdateDataProductProfileRequest — Replace the reconciler profile JSON for a data product.
• UpdateDataProductProfileResponse — Acknowledgement of a profile update operation.
• UpdateOrganizationRequest — Replace mutable fields on an existing organization.
• UpdateOrganizationResponse — Acknowledgement payload for organization updates.
• UpdateOutletLambdaTriggerRequest — Patch fields on an existing outlet Lambda trigger.
• UpdateOutletLambdaTriggerResponse — Acknowledgement of an outlet Lambda trigger update.

Namespace functions

No entries yet.