package keyspacepb

Get desktop application:
View/edit binary Protocol Buffers messages

Keyspace provides services to manage keyspaces.

• rpc GetAllKeyspaces (GetAllKeyspacesRequest, GetAllKeyspacesResponse)

  keyspacepb.proto:35

  message GetAllKeyspacesRequest

  keyspacepb.proto:177

  • optional pdpb.RequestHeader header = 1

  • oneof start_keyspace

    • uint32 start_id = 2

      V1/V2 compatibility pagination cursor. V3 should use namespace_id and start_keyspace_identity.

    • apipb.KeyspaceIdentity start_keyspace_identity = 5

      V3 pagination cursor within namespace_id.

  • uint32 limit = 3

  • optional NamespaceRef namespace = 4

    V3 namespace-scoped pagination. Must be non-zero in V3.

  message GetAllKeyspacesResponse

  keyspacepb.proto:190

  • optional pdpb.ResponseHeader header = 1

  • repeated KeyspaceMeta keyspaces = 2

• rpc LoadKeyspace (LoadKeyspaceRequest, LoadKeyspaceResponse)

  keyspacepb.proto:28

  message LoadKeyspaceRequest

  keyspacepb.proto:120

  • optional pdpb.RequestHeader header = 1

  • string name = 2

  • optional NamespaceRef namespace = 3

    V3 namespace-scoped name lookup. If unset, V3 name-only lookup should use LookupKeyspace and may return multiple keyspaces.

• rpc LoadKeyspaceByID (LoadKeyspaceByIDRequest, LoadKeyspaceResponse)

  keyspacepb.proto:30

  message LoadKeyspaceByIDRequest

  keyspacepb.proto:127

  • optional pdpb.RequestHeader header = 1

  • oneof keyspace

    • uint32 id = 2

      V1/V2 compatibility keyspace id. V3 should use keyspace_identity.

    • apipb.KeyspaceIdentity keyspace_identity = 3

      V3 keyspace identity.

• rpc LookupKeyspace (LookupKeyspaceRequest, LookupKeyspaceResponse)

  keyspacepb.proto:29

  message LookupKeyspaceRequest

  keyspacepb.proto:142

  • optional pdpb.RequestHeader header = 1

  • string name = 2

  message LookupKeyspaceResponse

  keyspacepb.proto:147

  • optional pdpb.ResponseHeader header = 1

  • repeated KeyspaceMeta keyspaces = 2

• rpc UpdateKeyspaceState (UpdateKeyspaceStateRequest, UpdateKeyspaceStateResponse)

  keyspacepb.proto:34

  message UpdateKeyspaceStateRequest

  keyspacepb.proto:161

  • optional pdpb.RequestHeader header = 1

  • oneof keyspace

    • uint32 id = 2

      V1/V2 compatibility keyspace id. V3 should use keyspace_identity.

    • apipb.KeyspaceIdentity keyspace_identity = 4

      V3 keyspace identity.

  • KeyspaceState state = 3

  message UpdateKeyspaceStateResponse

  keyspacepb.proto:172

  • optional pdpb.ResponseHeader header = 1

  • optional KeyspaceMeta keyspace = 2

• rpc WatchKeyspaces (WatchKeyspacesRequest, stream WatchKeyspacesResponse)

  keyspacepb.proto:33

  WatchKeyspaces first return all current keyspaces' metadata as its first response. Then, it returns responses containing keyspaces that had their metadata changed.

  message WatchKeyspacesRequest

  keyspacepb.proto:152

  • optional pdpb.RequestHeader header = 1

  message WatchKeyspacesResponse

  keyspacepb.proto:156

  • optional pdpb.ResponseHeader header = 1

  • repeated KeyspaceMeta keyspaces = 2

Namespace provides services to manage namespaces.

• rpc CreateNamespace (CreateNamespaceRequest, CreateNamespaceResponse)

  keyspacepb.proto:20

  message CreateNamespaceRequest

  keyspacepb.proto:77

  • optional pdpb.RequestHeader header = 1

  • string name = 2

  • map<string, string> config = 3

  message CreateNamespaceResponse

  keyspacepb.proto:83

  • optional pdpb.ResponseHeader header = 1

  • optional NamespaceMeta namespace = 2

• rpc GetAllNamespaces (GetAllNamespacesRequest, GetAllNamespacesResponse)

  keyspacepb.proto:22

  message GetAllNamespacesRequest

  keyspacepb.proto:98

  • optional pdpb.RequestHeader header = 1

  • uint32 start_id = 2

  • uint32 limit = 3

  message GetAllNamespacesResponse

  keyspacepb.proto:104

  • optional pdpb.ResponseHeader header = 1

  • repeated NamespaceMeta namespaces = 2

• rpc LoadNamespace (LoadNamespaceRequest, LoadNamespaceResponse)

  keyspacepb.proto:21

  message LoadNamespaceRequest

  keyspacepb.proto:88

  • optional pdpb.RequestHeader header = 1

  • optional NamespaceRef namespace = 2

  message LoadNamespaceResponse

  keyspacepb.proto:93

  • optional pdpb.ResponseHeader header = 1

  • optional NamespaceMeta namespace = 2

• rpc UpdateNamespaceState (UpdateNamespaceStateRequest, UpdateNamespaceStateResponse)

  keyspacepb.proto:23

  message UpdateNamespaceStateRequest

  keyspacepb.proto:109

  • optional pdpb.RequestHeader header = 1

  • optional NamespaceRef namespace = 2

  • KeyspaceState state = 3

  message UpdateNamespaceStateResponse

  keyspacepb.proto:115

  • optional pdpb.ResponseHeader header = 1

  • optional NamespaceMeta namespace = 2

Used in: GetAllKeyspacesResponse, LoadKeyspaceResponse, LookupKeyspaceResponse, UpdateKeyspaceStateResponse, WatchKeyspacesResponse

• oneof keyspace

  • uint32 id = 1

    V1/V2 compatibility keyspace id. V3 should read keyspace_identity instead.

  • apipb.KeyspaceIdentity keyspace_identity = 8

    Canonical V3 keyspace identity.

• string name = 2

• KeyspaceState state = 3

• int64 created_at = 4

• int64 state_changed_at = 5

• map<string, string> config = 7

Used in: KeyspaceMeta, NamespaceMeta, UpdateKeyspaceStateRequest, UpdateNamespaceStateRequest

• ENABLED = 0

• DISABLED = 1

• ARCHIVED = 2

• TOMBSTONE = 3

Used as response type in: Keyspace.LoadKeyspace, Keyspace.LoadKeyspaceByID

• optional pdpb.ResponseHeader header = 1

• optional KeyspaceMeta keyspace = 2

Used in: CreateNamespaceResponse, GetAllNamespacesResponse, LoadNamespaceResponse, UpdateNamespaceStateResponse

• uint32 id = 1

• string name = 2

• KeyspaceState state = 3

• int64 created_at = 4

• int64 state_changed_at = 5

• map<string, string> config = 7

Used in: GetAllKeyspacesRequest, LoadKeyspaceRequest, LoadNamespaceRequest, UpdateNamespaceStateRequest

• oneof namespace

  • uint32 namespace_id = 1

    API V3 namespace id.

  • string namespace_name = 2

    API V3 namespace name.