package cs3.storage.registry.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Storage Registry API The Storage Registry API is meant to as registry to obtain information of available storage providers. The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. The following are global requirements that apply to all methods: Any method MUST return CODE_OK on a succesful operation. Any method MAY return NOT_IMPLEMENTED. Any method MAY return INTERNAL. Any method MAY return UNKNOWN. Any method MAY return UNAUTHENTICATED.

• rpc GetHome (GetHomeRequest, GetHomeResponse)

  registry_api.proto:60

  Gets the user home storage provider.

  TODO(labkode): missing methods for adding and removing a storage provider with different visibility levels (system-wide, user-wide, group-wide)...

  message GetHomeRequest

  registry_api.proto:65

  • optional types.v1beta1.Opaque opaque = 1

    OPTIONAL. Opaque information.

  message GetHomeResponse

  registry_api.proto:71

  • optional rpc.v1beta1.Status status = 1

    REQUIRED. The response status.

  • optional types.v1beta1.Opaque opaque = 2

    OPTIONAL. Opaque information.

  • optional ProviderInfo provider = 3

    REQUIRED. The storage provider for the user home.

• rpc GetStorageProviders (GetStorageProvidersRequest, GetStorageProvidersResponse)

  registry_api.proto:56

  Returns the storage provider that is reponsible for the given resource reference. MUST return CODE_NOT_FOUND if the reference does not exist.

  message GetStorageProvidersRequest

  registry_api.proto:83

  • optional types.v1beta1.Opaque opaque = 1

    OPTIONAL. Opaque information.

  • optional provider.v1beta1.Reference ref = 2

    REQUIRED. The reference for the resource.

  message GetStorageProvidersResponse

  registry_api.proto:92

  • optional rpc.v1beta1.Status status = 1

    REQUIRED. The response status.

  • optional types.v1beta1.Opaque opaque = 2

    OPTIONAL. Opaque information.

  • repeated ProviderInfo providers = 3

    REQUIRED. The storage providers handling the requested storage resource.

• rpc ListStorageProviders (ListStorageProvidersRequest, ListStorageProvidersResponse)

  registry_api.proto:58

  Returns a list of the available storage providers known by this registry.

  message ListStorageProvidersRequest

  registry_api.proto:104

  • optional types.v1beta1.Opaque opaque = 1

    OPTIONAL. Opaque information.

    TODO(labkode): maybe add some filter?

  message ListStorageProvidersResponse

  registry_api.proto:111

  • optional rpc.v1beta1.Status status = 1

    REQUIRED. The response status.

  • optional types.v1beta1.Opaque opaque = 2

    OPTIONAL. Opaque information.

  • repeated ProviderInfo providers = 3

    REQUIRED. The list of storage providers this registry knows about.

The information for the storage provider.

Used in: GetHomeResponse, GetStorageProvidersResponse, ListStorageProvidersResponse

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information (containing storage-specific information). For example, additional metadata attached to the resource.

• string provider_id = 2

  REQUIRED. The storage provider id that will become part of the resource id. For example, if the provider_id is "home", resources obtained from this storage provider will have a resource id like "home:1234".

• string provider_path = 3

  REQUIRED. The public path prefix this storage provider handles. In Unix literature, the mount path. For example, if the provider_path is "/home", resources obtained from this storage provier will have a resource path lik "/home/docs".

• string address = 4

  REQUIRED. The address where the storage provider can be reached. For example, tcp://localhost:1099.

• string description = 5

  OPTIONAL. Information to describe the functionalities offered by the storage provider. Meant to be read by humans.

• optional ProviderInfo.Features features = 6

  REQUIRED. List of available methods.

REQUIRED. Represents the list of features available on this storage provider. If the feature is not supported, the related service methods MUST return CODE_UNIMPLEMENTED.

Used in: ProviderInfo

• bool recycle = 1

• bool file_versions = 2