github.com/m3db/m3@v1.5.0/src/query/generated/proto/admin/namespace.proto (about)

     1  
     2  syntax = "proto3";
     3  package admin;
     4  
     5  import "github.com/m3db/m3/src/dbnode/generated/proto/namespace/namespace.proto";
     6  
     7  message NamespaceGetResponse {
     8    namespace.Registry registry = 1;
     9  }
    10  
    11  message NamespaceAddRequest {
    12    string                        name = 1;
    13    namespace.NamespaceOptions options = 2;
    14  }
    15  
    16  message NamespaceUpdateRequest {
    17    string                        name = 1;
    18    namespace.NamespaceOptions options = 2;
    19  }
    20  
    21  message NamespaceSchemaAddRequest {
    22    // Name is the namespace name.
    23    // Add schema to non-existent namespace will get 404.
    24    string name = 1;
    25    // MsgName is the name of the top level proto message.
    26    string msgName = 2;
    27    // ProtoName is the name of the top level proto file.
    28    // Proto file content will be looked up from protoMap, so the name must corresponds to the map key.
    29    string protoName = 3;
    30    // ProtoMap is a map of name to proto strings.
    31    // Except the top level proto file, other imported proto files' key must be exactly the same
    32    // as how they are imported in the import statement.
    33    // E.g. If import.proto is imported using as below
    34    // import "mainpkg/imported.proto";
    35    // Then the map key for imported.proto must be "mainpkg/imported.proto"
    36    // See src/dbnode/namespame/kvadmin test for example.
    37    map<string, string> protoMap = 4;
    38  }
    39  
    40  message NamespaceSchemaAddResponse {
    41    string deployID = 1;
    42  }
    43  
    44  message NamespaceSchemaResetRequest {
    45    // Name is the namespace name.
    46    // Reset schema to non-existent namespace will get 404.
    47    string name = 1;
    48  }
    49  
    50  message NamespaceSchemaResetResponse {
    51  }
    52  
    53  // NamespaceReadyRequest is the request for transitioning a namespace
    54  // to the ready state. Calls to this endpoint are idempotent and can
    55  // be safely retried on error.
    56  message NamespaceReadyRequest {
    57    // Name is the namespace name.
    58    string name = 1;
    59    // Force forces the StagingStatus of the namespace to be moved to the ready state.
    60    // If the namespace is still not ready in DB nodes, then the coordinator will receive
    61    // errors upon attempted reads or writes until the namespaces is actually ready.
    62    bool force  = 2;
    63  }
    64  
    65  // NamespaceReadyResponse is the response from a request for transitioning
    66  // a namespace to the ready state.
    67  message NamespaceReadyResponse {
    68    bool ready = 1;
    69  }