package cs3.storage.provider.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service ProviderAPI
provider_api.proto:49Storage Provider API The Storage Provider API is meant to manipulate storage resources in the underlying storage system behind the service. 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 AddGrant (, )
provider_api.proto:52Adds a new grant for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist
message
provider_api.proto:210optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
optional grant = 3
REQUIRED. The grant to be added.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for setting grants even if the lock does not match.
message
provider_api.proto:228optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
rpc CreateContainer (, )
provider_api.proto:56Creates a new resource of type container. MUST return CODE_FAILED_PRECONDITION if the container cannot be created at the specified reference.
rpc CreateHome (, )
provider_api.proto:186Creates the home directory for a user.
Creates a reference to another resource in the same cluster or another domain (OCM shares). The references resource can be accessed by the protocol specificied in the request message.
message
provider_api.proto:905optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The location where to store the reference.
string target_uri = 3
REQUIRED. The reference resource by RFC3986.
message
provider_api.proto:917optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
rpc CreateSymlink (, )
provider_api.proto:141Creates a symlink to another resource.
rpc Delete (, )
provider_api.proto:66Deletes a resource. If a resource specifies the non-empty container (directory, ...), then the entire directory is deleted recursively. If a resource specifies a reference or symlink type, only the reference is removed (not the target). MUST return CODE_NOT_FOUND if the reference does not exist.
rpc DenyGrant (, )
provider_api.proto:69Denies access to the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist
message
provider_api.proto:237optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
optional grantee = 3
REQUIRED. The grantee to remove permission.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for setting grants even if the lock does not match.
message
provider_api.proto:255optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
rpc GetHome (, )
provider_api.proto:188Gets the home path for the user.
rpc GetLock (, )
provider_api.proto:162Gets the lock metadata of a storage resource. MUST return CODE_NOT_FOUND if the reference does not exist or is not locked. The caller MUST have read permissions on the resource.
rpc GetPath (, )
provider_api.proto:73Returns the path reference for the provided resource id reference. MUST return CODE_NOT_FOUND if the reference does not exist
rpc GetQuota (, )
provider_api.proto:78Returns the quota available under the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist MUST return CODE_RESOURCE_EXHAUSTED on exceeded quota limits.
message
provider_api.proto:348optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
OPTIONAL. Limit the quota Response to the given reference
Initiates the download of a file using an out-of-band data transfer mechanism.
message
provider_api.proto:430optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated protocols = 3
REQUIRED. The protocols through which data can be downloaded.
Initiates the upload of a file using an out-of-band data transfer mechanism. SHOULD return CODE_FAILED_PRECONDITION if the reference is already locked with a mismatched lock. Additionally, the lock check MUST be enforced by the data transfer protocol returned in response.
message
provider_api.proto:405optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated protocols = 3
REQUIRED. The protocols through which data can be uploaded.
rpc ListContainer (, )
provider_api.proto:98Returns a list of resource information for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exists.
rpc ListContainerStream (, stream )
provider_api.proto:94Returns a stream of resource informations for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exists.
Returns a list of the versions for a resource of type file at the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_OK and MUST return an empty list if no versions are available. TODO: What code if resource not of type file?
rpc ListGrants (, )
provider_api.proto:90Returns the list of grants for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exists.
message
provider_api.proto:442optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
int32 page_size = 3
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 4
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:460optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated grants = 3
REQUIRED. The grants.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
rpc ListRecycle (, )
provider_api.proto:109Returns a list of recycle items for this storage provider. MUST return CODE_OK and MUST return an empty list if no recycle items are available.
rpc ListRecycleStream (, stream )
provider_api.proto:106Returns a stream of recycle items for this storage provider.
rpc Move (, )
provider_api.proto:114Moves a resource from one reference to another. MUST return CODE_NOT_FOUND if any of the references do not exist. MUST return CODE_FAILED_PRECONDITION if the source reference cannot be moved to the destination reference.
rpc PurgeRecycle (, )
provider_api.proto:123Permanently removes a recycle item from the recycle. This operation is irrevocable. MUST return CODE_NOT_FOUND if the recycle item id does not exist.
rpc RefreshLock (, )
provider_api.proto:168Refreshes the lock metadata of a storage resource. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_PRECONDITION_FALIED if the reference is not locked or if the caller does not hold the lock. The caller MUST have write permissions on the resource.
rpc RemoveGrant (, )
provider_api.proto:119Removes a grant for the provided reference. This is recursive and atomic for directories. Does not follow references. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_NOT_FOUND if grant does not exist.
message
provider_api.proto:800optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
optional grant = 3
REQUIRED. The grant to remove.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for unsetting grants even if the lock does not match.
message
provider_api.proto:818optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
Restores a file version for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_NOT_FOUND if the version does not exist.
Restores a recycle item from the recycle. MUST return CODE_NOT_FOUND if the recycle item id does not exist. MUST return CODE_FAILED_PRECONDITION if the restore_path is non-empty and the recycle item cannot be restored to the restore_path.
Sets arbitrary metadata into a storage resource. Arbitrary metadata is returned in a cs3.storageprovider.v1beta1.ResourceInfo.
rpc SetImmutable (, )
provider_api.proto:179Sets the immutable (frozen) attribute on a resource. MUST return CODE_NOT_FOUND if the reference does not exist. The caller MUST have management permissions on the resource (space owner, space manager, or administrator).
rpc SetLock (, )
provider_api.proto:158Locks a storage resource. Note that if the resource is a container, MAY return CODE_NOT_IMPLEMENTED as the behavior is yet to be defined at this stage. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_FAILED_PRECONDITION if the reference is already locked. In addition, the implementation MUST ensure atomicity when multiple users concurrently attempt to set a lock. The caller MUST have write permissions on the resource.
rpc Stat (, )
provider_api.proto:135Returns the resource information at the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist.
rpc TouchFile (, )
provider_api.proto:60Creates a new resource of type file. MUST return CODE_FAILED_PRECONDITION if the file cannot be created at the specified reference.
rpc Unlock (, )
provider_api.proto:174Unlocks a storage resource. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_FAILED_PRECONDITION if the reference is not locked or if the caller does not hold the lock. The caller MUST have write permissions on the resource.
Unsets arbitrary metdata into a storage resource. Arbitrary metadata is returned in a cs3.storageprovider.v1beta1.ResourceInfo.
rpc UnsetImmutable (, )
provider_api.proto:184Removes the immutable (frozen) attribute from a resource. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_FAILED_PRECONDITION if the resource is not immutable. The caller MUST have management permissions on the resource.
rpc UpdateGrant (, )
provider_api.proto:139Updates an ACL for the provided reference. MUST return CODE_NOT_FOUND if the reference does not exist. MUST return CODE_FAILED_PRECONDITION if the acl does not exist.
message
provider_api.proto:856optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
optional grant = 3
REQUIRED. The grant to be updated.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for updating grants even if the lock does not match.
message
provider_api.proto:874optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
service SpacesAPI
spaces_api.proto:52Spaces API The Spaces API is meant to manipulate spaces in the service. 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.
Creates a storage space.
Deletes a storage space.
rpc ListStorageSpaces (, )
spaces_api.proto:56Lists storage spaces.
Updates a storage space.
message
resources.proto:158Arbitrary metadata than can be set to the resource.
Used in: ,
map<string, string> metadata = 1
message
resources.proto:147CanonicalMetadata contains extra metadata attached to a resource. This message and the Opaque message differ in that Opaque allows service implementors to include any extra metadata in any format and most clients will ignore it. However, the CanonicalMetadata message contains well defined fileds that clients MUST understand if they are specified.
Used in:
optional target = 1
REQUIRED if resource type is RESOURCE_TYPE_REFERENCE. The target reference the resource points to.
TODO(moscicki): what fields can fit here? executable bit? bool executable = 2; TODO(labkode): at some points maybe we could add here acls and other well-known metadata.
message
provider_api.proto:264Used as request type in: gateway.v1beta1.GatewayAPI.CreateContainer, ProviderAPI.CreateContainer
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
message
provider_api.proto:273Used as response type in: gateway.v1beta1.GatewayAPI.CreateContainer, ProviderAPI.CreateContainer
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:1106Used as request type in: gateway.v1beta1.GatewayAPI.CreateHome, ProviderAPI.CreateHome
optional opaque = 1
OPTIONAL. Opaque information.
optional quota = 2
OPTIONAL.
message
provider_api.proto:1114Used as response type in: gateway.v1beta1.GatewayAPI.CreateHome, ProviderAPI.CreateHome
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
spaces_api.proto:63Used as request type in: gateway.v1beta1.GatewayAPI.CreateStorageSpace, SpacesAPI.CreateStorageSpace
optional opaque = 1
OPTIONAL.
optional owner = 2
REQUIRED.
string type = 3
OPTIONAL. Could be 'home', 'share', 'project', 'space'...
string name = 4
OPTIONAL. User readable name of the storage space.
optional quota = 5
OPTIONAL.
message
spaces_api.proto:78Used as response type in: gateway.v1beta1.GatewayAPI.CreateStorageSpace, SpacesAPI.CreateStorageSpace
optional opaque = 1
OPTIONAL. Opaque information.
optional status = 2
REQUIRED. The response status.
optional storage_space = 3
REQUIRED. The created storage space.
message
provider_api.proto:883Used as request type in: gateway.v1beta1.GatewayAPI.CreateSymlink, ProviderAPI.CreateSymlink
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The location where to store the symlink.
string target = 3
REQUIRED. The link target can hold arbitrary text; if later resolved, a relative link is interpreted in relation to its parent directory
message
provider_api.proto:896Used as response type in: gateway.v1beta1.GatewayAPI.CreateSymlink, ProviderAPI.CreateSymlink
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:305Used as request type in: gateway.v1beta1.GatewayAPI.Delete, ProviderAPI.Delete
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
string lock_id = 3
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id MUST be equal to the given value.
message
provider_api.proto:318Used as response type in: gateway.v1beta1.GatewayAPI.Delete, ProviderAPI.Delete
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
spaces_api.proto:188Used as request type in: gateway.v1beta1.GatewayAPI.DeleteStorageSpace, SpacesAPI.DeleteStorageSpace
optional opaque = 1
OPTIONAL. Opaque information.
optional id = 2
REQUIRED.
message
spaces_api.proto:196Used as response type in: gateway.v1beta1.GatewayAPI.DeleteStorageSpace, SpacesAPI.DeleteStorageSpace
optional opaque = 1
OPTIONAL. Opaque information.
optional status = 2
REQUIRED. The response status.
message
resources.proto:490A file download protocol object stores information about downloading resources using a specific protocol.
Used in:
optional opaque = 1
OPTIONAL. Opaque information.
string protocol = 2
REQUIRED. The protocol to be followed.
string download_endpoint = 3
REQUIRED. The endpoint where to download the data. The value MUST be a Uniform Resource Identifier (URI) as specified in RFC 3986.
bool expose = 4
REQUIRED. Tells to the gateway if the client should be exposed directly to the download_endpoint.
message
resources.proto:463A file upload protocol object stores information about uploading resources using a specific protocol.
Used in:
optional opaque = 1
OPTIONAL. Opaque information.
string protocol = 2
REQUIRED. The protocol to be followed.
string upload_endpoint = 3
REQUIRED. The endpoint where to upload the data. The value MUST be a Uniform Resource Identifier (URI) as specified in RFC 3986.
repeated available_checksums = 4
REQUIRED. List of available checksums the client can use when sending the file.
bool expose = 5
REQUIRED. Tells to the gateway if the client should be exposed directly to the upload_endpoint.
optional expiration = 6
OPTIONAL. The time at which the upload will expire.
message
resources.proto:418The information for a file version. TODO(labkode): make size and mtime OPTIONAL?
Used in:
optional opaque = 1
OPTIONAL. Opaque information.
string key = 3
MUST the specified. The key to identify the version.
uint64 size = 4
REQUIRED. The size in bytes of the file version.
uint64 mtime = 5
REQUIRED. The Unix Epoch timestamp in seconds.
string etag = 6
REQUIRED. As decribed in https://tools.ietf.org/html/rfc7232#section-2.3 For a file version, the etag does not change because a version is immutable.
message
provider_api.proto:191Used as request type in: gateway.v1beta1.GatewayAPI.GetHome, ProviderAPI.GetHome
optional opaque = 1
OPTIONAL. Opaque information.
message
provider_api.proto:197Used as response type in: gateway.v1beta1.GatewayAPI.GetHome, ProviderAPI.GetHome
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
string path = 3
REQUIRED. The path to the home in a storage provider. For example /eos/user/h/hugo in the storage provider with root path /eos/user/.
message
provider_api.proto:1002Used as request type in: gateway.v1beta1.GatewayAPI.GetLock, ProviderAPI.GetLock
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference the lock is associated to.
message
provider_api.proto:1011Used as response type in: gateway.v1beta1.GatewayAPI.GetLock, ProviderAPI.GetLock
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
optional lock = 3
REQUIRED. The lock metadata
message
provider_api.proto:327Used as request type in: gateway.v1beta1.GatewayAPI.GetPath, ProviderAPI.GetPath
optional opaque = 1
OPTIONAL. Opaque information.
optional resource_id = 2
REQUIRED. The resource id of the resource.
message
provider_api.proto:336Used as response type in: gateway.v1beta1.GatewayAPI.GetPath, ProviderAPI.GetPath
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
string path = 3
REQUIRED. The path of the resource.
message
provider_api.proto:357Used as response type in: gateway.v1beta1.GatewayAPI.GetQuota, ProviderAPI.GetQuota
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
uint64 total_bytes = 3
REQUIRED. The total available bytes.
uint64 used_bytes = 4
REQUIRED. The number of used bytes.
message
resources.proto:373A grant grants permissions to a resource to a grantee.
Used in: , , ,
optional grantee = 1
REQUIRED. The grantee of the grant.
optional permissions = 2
REQUIRED. The permissions for the grant.
optional creator = 3
OPTIONAL The Creator of the grant
optional expiration = 4
OPTIONAL Expiration of the grant.
message
resources.proto:389A grantee is the receiver of a grant.
Used in: , , , , , , , , , ,
GranteeType type = 1
REQUIRED. The type of the grantee.
oneof id
REQUIRED. The unique id for the grantee. One of the ids MUST be specified.
user_id = 3
The user id.
group_id = 4
The group id.
optional opaque = 5
OPTIONAL. Opaque information such as UID or GID.
The type of the grantee.
Used in: ,
GRANTEE_TYPE_INVALID = 0
GRANTEE_TYPE_USER = 1
This type represents an individual.
GRANTEE_TYPE_GROUP = 2
This type represents a group of individuals.
message
provider_api.proto:417Used as request type in: gateway.v1beta1.GatewayAPI.InitiateFileDownload, ProviderAPI.InitiateFileDownload
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
string lock_id = 3
OPTIONAL. A lock_id: should the reference be locked and the lock type be LOCK_TYPE_EXCL, the stored lock_id MUST be equal to the given value.
message
provider_api.proto:372Used as request type in: gateway.v1beta1.GatewayAPI.InitiateFileUpload, ProviderAPI.InitiateFileUpload
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
oneof options
bool if_not_exist = 3
OPTIONAL. Whether the file is to be uploaded in exclusive mode. Defaults to false. If true, the request SHALL be processed such that only one of multiple concurrent uploads to the same target reference MAY succeed, whereas all others MUST fail with CODE_FAILED_PRECONDITION. The semantic is similar to the O_CREAT|O_EXCL POSIX flags. The request MUST return CODE_NOT_IMPLEMENTED if the provider does not support this mode.
string if_match = 4
OPTIONAL. Whether the file is to be uploaded if the given etag matches. Default to always upload. If the storage provider has a more recent etag for the target file, the request MUST return CODE_FAILED_PRECONDITION.
if_unmodified_since = 6
OPTIONAL. Whether the file is to be uploaded when it has been modified on the server. Defauls to always upload. If the resource has been modified on the storage provider after the given timestamp the request MUST return CODE_FAILED_PRECONDITION.
string lock_id = 5
OPTIONAL. A lock_id: should the reference exist and be locked, the stored lock_id SHOULD be equal to the given value. Additionally, the check MUST be enforced by the out-of-band transfer protocol.
message
provider_api.proto:520Used as request type in: gateway.v1beta1.GatewayAPI.ListContainer, ProviderAPI.ListContainer
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
repeated string arbitrary_metadata_keys = 3
OPTIONAL. Arbitrary metadata to be included with the resource. A key with the name '*' means to return all available arbitrary metadata.
optional field_mask = 4
OPTIONAL. The field mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
int32 page_size = 5
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 6
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:546Used as response type in: gateway.v1beta1.GatewayAPI.ListContainer, ProviderAPI.ListContainer
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated infos = 3
REQUIRED. The list of resource informations.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
provider_api.proto:477Used as request type in: gateway.v1beta1.GatewayAPI.ListContainerStream, ProviderAPI.ListContainerStream
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
repeated string arbitrary_metadata_keys = 3
OPTIONAL. Arbitrary metadata to be included with the resource. A key with the name '*' means to return all available arbitrary metadata.
optional field_mask = 4
OPTIONAL. The field mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
int32 page_size = 5
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 6
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:503Used as response type in: gateway.v1beta1.GatewayAPI.ListContainerStream, ProviderAPI.ListContainerStream
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
optional info = 3
REQUIRED. The resource information.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
provider_api.proto:563Used as request type in: gateway.v1beta1.GatewayAPI.ListFileVersions, ProviderAPI.ListFileVersions
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
int32 page_size = 3
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 4
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:581Used as response type in: gateway.v1beta1.GatewayAPI.ListFileVersions, ProviderAPI.ListFileVersions
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated versions = 3
REQUIRED. The list of file versions.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
provider_api.proto:598Used as request type in: gateway.v1beta1.GatewayAPI.ListRecycle, ProviderAPI.ListRecycle
optional opaque = 1
OPTIONAL. Opaque information.
optional from_ts = 2
OPTIONAL. SHOULD be specified. The start time range to query for recycle items. The value is the Unix Epoch timestamp in seconds.
optional to_ts = 3
OPTIONAL. SHOULD be specified. The end time range to query for recycle items. The value is Unix Epoch timestamp in seconds.
optional ref = 4
OPTIONAL. The reference to which the action should be performed.
string key = 5
OPTIONAL. The key for a recycle item to be listed. If provided, the item corresponding to the key will be listed.
int32 page_size = 6
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 7
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:630Used as response type in: gateway.v1beta1.GatewayAPI.ListRecycle, ProviderAPI.ListRecycle
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
repeated recycle_items = 3
REQUIRED. The list of recycle items.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
provider_api.proto:647Used as request type in: gateway.v1beta1.GatewayAPI.ListRecycleStream, ProviderAPI.ListRecycleStream
optional opaque = 1
OPTIONAL. Opaque information.
optional from_ts = 2
OPTIONAL. SHOULD be specified. The start time range to query for recycle items. The value is the Unix Epoch timestamp in seconds.
optional to_ts = 3
OPTIONAL. SHOULD be specified. The end time range to query for recycle items. The value is Unix Epoch timestamp in seconds.
optional ref = 4
OPTIONAL. The reference to which the action should be performed.
string key = 5
OPTIONAL. The key for a recycle item to be listed. If provided, the item corresponding to the key will be listed.
int32 page_size = 6
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 7
OPTIONAL. The client uses this field to request a specific page of the list results.
message
provider_api.proto:679Used as response type in: gateway.v1beta1.GatewayAPI.ListRecycleStream, ProviderAPI.ListRecycleStream
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
optional recycle_item = 3
REQUIRED. The recycle items.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
spaces_api.proto:90Used as request type in: gateway.v1beta1.GatewayAPI.ListStorageSpaces, SpacesAPI.ListStorageSpaces
optional opaque = 1
OPTIONAL. Opaque information.
repeated filters = 2
OPTIONAL. The list of filters to apply if any.
optional field_mask = 3
OPTIONAL. The field mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
int32 page_size = 4
OPTIONAL. Clients use this field to specify the maximum number of results to be returned by the server. The server may further constrain the maximum number of results returned in a single page. If the page_size is 0, the server will decide the number of results to be returned. see https://cloud.google.com/apis/design/design_patterns#list_pagination
string page_token = 5
OPTIONAL. The client uses this field to request a specific page of the list results.
message
spaces_api.proto:95Represents a filter to apply to the request.
Used in:
Filter.Type type = 1
REQUIRED.
oneof term
id = 2
owner = 3
string space_type = 4
string path = 5
user = 6
The filter to apply.
Used in:
TYPE_INVALID = 0
TYPE_NO = 1
TYPE_ID = 2
TYPE_OWNER = 3
TYPE_SPACE_TYPE = 4
TYPE_PATH = 5
TYPE_USER = 6
message
spaces_api.proto:134Used as response type in: gateway.v1beta1.GatewayAPI.ListStorageSpaces, SpacesAPI.ListStorageSpaces
optional opaque = 1
OPTIONAL. Opaque information.
optional status = 2
REQUIRED. The response status.
repeated storage_spaces = 3
REQUIRED.
string next_page_token = 4
OPTIONAL. This field represents the pagination token to retrieve the next page of results. If the value is "", it means no further results for the request. see https://cloud.google.com/apis/design/design_patterns#list_pagination
message
resources.proto:184The metadata associated with a lock on a resource. Provided that storage drivers are free to implement the storage of this metadata according to their constraints, a reference implementation is given here. The lock SHOULD be stored as an extended attribute on the referenced filesystem entry. Such extended attribute MUST NOT be exposed via the `Stat` and `SetArbitraryMetadata` APIs. Instead, the `ResourceInfo.Lock` attribute MUST be populated if a lock exists for the given reference.
Used in: , , , ,
optional opaque = 1
OPTIONAL. Opaque information.
string lock_id = 2
REQUIRED. The id of the lock, eg. the X-WOPI-Lock id or the WebDAV opaquelocktoken.
LockType type = 3
REQUIRED. The type of lock.
optional user = 4
OPTIONAL. The userid of a user, which represents either the lock holder, or the user that last created/modified the lock. When non empty, `RefreshLock` and `Unlock` operations MUST check their request's content against it.
string app_name = 5
OPTIONAL. An application name if the lock is held by an app. When non empty, `RefreshLock` and `Unlock` operations MUST check their request's content against it.
optional expiration = 6
OPTIONAL. The time when the lock will expire.
The available type of locks for a resource.
Used in:
LOCK_TYPE_INVALID = 0
LOCK_TYPE_SHARED = 1
Shared (advisory) lock: the resource can be read, written/overwritten or unlocked by everyone who has access.
LOCK_TYPE_WRITE = 2
Write lock: the resource can be read by everyone who has access, but write, refreshlock and unlock operations are restricted to the lock holder.
LOCK_TYPE_EXCL = 3
Exclusive lock: only the lock holder can operate on the resource, anyone else is denied to access it.
message
provider_api.proto:696Used as request type in: gateway.v1beta1.GatewayAPI.Move, ProviderAPI.Move
optional opaque = 1
OPTIONAL. Opaque information.
optional source = 2
REQUIRED. The source reference the resource is moved from.
optional destination = 3
REQUIRED. The destination reference the resource is moved to.
string lock_id = 4
OPTIONAL. A lock_id: should the source reference be locked, the stored lock_id MUST be equal to the given value.
message
provider_api.proto:712Used as response type in: gateway.v1beta1.GatewayAPI.Move, ProviderAPI.Move
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:721Used as request type in: gateway.v1beta1.GatewayAPI.PurgeRecycle, ProviderAPI.PurgeRecycle
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
string key = 3
REQUIRED. The key corresponding to the item to be purged..
message
provider_api.proto:733Used as response type in: gateway.v1beta1.GatewayAPI.PurgeRecycle, ProviderAPI.PurgeRecycle
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
resources.proto:557Represents a quota for a storage space.
Used in: , , ,
optional opaque = 1
OPTIONAL. Opaque information.
uint64 quota_max_bytes = 2
OPTIONAL. The bytes quota for the space.
uint64 quota_max_files = 3
OPTIONAL. The files quota for the space.
uint64 remaining_bytes = 4
OPTIONAL. The remaining bytes for the space.
uint64 remaining_files = 5
OPTIONAL. The remaining files for the space.
message
resources.proto:439A recycle item represents the information of a deleted resource.
Used in: ,
optional opaque = 1
OPTIONAL. Opaque information.
ResourceType type = 2
REQUIRED. The type of the resource.
string key = 3
REQUIRED. The key to identify the deleted resource.
optional ref = 4
REQUIRED. The original reference of the deleted resource.
uint64 size = 5
OPTIONAL. The size of the deleted resource.
optional deletion_time = 6
REQUIRED. The deletion time of the resource in Unix Epoch timestamp in seconds.
message
resources.proto:288The mechanism to identify a resource in the CS3 namespace. It can represent path based, id based and combined references: The storage registry uses the storage_id to determine the responsible storage provider. When the storage_id is not available it will use the path. In a URL the different components can be represented in a string using the following layout: <storage_id>!<node_id>:<path>
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
optional resource_id = 1
OPTIONAL
string path = 2
OPTIONAL. When starting with `/` represents an absolute path. In this case the resource_id MUST be empty. When starting with `.` represents a path relative to the resource_id. The resource_id MUST be given. When path is empty the resource_id must be set. Used to look up the path for a resource_id.
message
provider_api.proto:1023Used as request type in: gateway.v1beta1.GatewayAPI.RefreshLock, ProviderAPI.RefreshLock
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference on which the lock should be refreshed.
optional lock = 3
REQUIRED. The lock metadata.
string existing_lock_id = 4
OPTIONAL. The existing lock id. This can be used to refresh the existing lock with a new lock while checking if the lock holder sends the correct existing lock_id
message
provider_api.proto:1040Used as response type in: gateway.v1beta1.GatewayAPI.RefreshLock, ProviderAPI.RefreshLock
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
resources.proto:258The checksum to verify the integrity of a resource.
Used in:
ResourceChecksumType type = 1
REQUIRED. The type of checksum to use. If no checksum is provided, type MUST be RESOURCE_CHECKSUM_TYPE_UNSET.
string sum = 2
MUST be specified if type is not RESOURCE_CHECKSUM_TYPE_UNSET or type is not RESOURCE_CHECKSUM_TYPE_INVALID. MUST be the hexadecimal representation of the cheksum. The value is case-insensitive, so "1E603A8", "1e603a8" or "1e603A8" are the same.
message
resources.proto:277When negotiating the user of checksum types between client and server, this structure defines the priority of the checksum. Priority 0 means highest priority.
Used in: ,
ResourceChecksumType type = 1
uint32 priority = 2
The type of checksum to use.
Used in: ,
RESOURCE_CHECKSUM_TYPE_INVALID = 0
RESOURCE_CHECKSUM_TYPE_UNSET = 1
unset means no checksum is set.
RESOURCE_CHECKSUM_TYPE_ADLER32 = 2
Use Adler32 checksum.
RESOURCE_CHECKSUM_TYPE_MD5 = 3
Use MD5 checksum.
RESOURCE_CHECKSUM_TYPE_SHA1 = 4
Use SHA-1 checksum.
message
resources.proto:301A resource id uniquely identifies a resource in the storage provider namespace. A ResourceId MUST be unique in the storage provider.
Used in: , , , , , , , , , , , ,
string storage_id = 1
REQUIRED. The logical id of a storage. Used by the storage registry to determine the responsible storage provider.
string opaque_id = 2
REQUIRED. The internal id used by service implementor to uniquely identity the resource in the internal implementation of the service.
string space_id = 3
OPTIONAL. The internal id used by service implementor to uniquely identify the storage space. Used by the storageprovider to locate the correct storage space.
message
resources.proto:37Represents the information (metadata) about a storage resource organized in a hierarchical namespace (file, directory/container, reference, symlink, ...).
Used in: , , , , , , , , , , ,
optional opaque = 1
OPTIONAL. Opaque information.
ResourceType type = 2
REQUIRED. The type of the resource (container, file, ...) See the enum ResourceType for all possible types.
optional id = 3
REQUIRED. Opaque unique identifier of the resource.
optional checksum = 4
REQUIRED. The data checksum for the file resource. For all other resources, the checksum is unset.
string etag = 5
REQUIRED. As decribed in https://tools.ietf.org/html/rfc7232#section-2.3 For file resources, the etag must change if data or metadata changes. For container types, the etag must change if etag of any of the (indirectly) contained resources change. For reference types, the etag must change if etag of the target changes and the target is on the same storage provider. In all other cases the etag does not change.
string mime_type = 6
REQUIRED. As described in [RFC 2015](https://tools.ietf.org/html/rfc2045#page-7)
optional mtime = 7
REQUIRED. Last modification time (mtime) of file or directory contents. For reference types this is NOT the mtime of the target.
string path = 8
REQUIRED. The path for the resource: MUST start with `/` when the reference had no resource_id, indicating an absolute path. MUST start with `.` when the reference had a resource_id, indicating a relative path.
optional permission_set = 9
REQUIRED. The set of permissions for the resource effective for the authenticated user.
uint64 size = 10
REQUIRED. The size of the resource in bytes (file size) TODO(moscicki): This is undefined for container type. Is the accounting recursive?, could it be set to 0 for directories if recursive not supported? use another field? TODO(moscicki): This needs to be defined also for other types (such as a symlink to a directory or file)
optional owner = 11
REQUIRED. Identifier of the owner of the resource.
string target = 12
OPTIONAL. if ResourceType is either RESOURCE_TYPE_SYMLINK or RESOURCE_TYPE_REFERENCE it MUST be specified.
optional canonical_metadata = 13
OPTIONAL. Additional metadata attached to the resource. If ResourceType is RESOURCE_TYPE_REFERENCE it MUST be specified.
optional arbitrary_metadata = 14
OPTIONAL. Arbitrary metadata attached to a resource.
optional lock = 15
OPTIONAL. Exclusive or write lock on this resource that will limit modification of the resource to holders of the lock. Can be used by WOPI or other apps requiring write or exclusive locks.
repeated advisory_locks = 16
OPTIONAL. Advisory locks on this resource. Can be used for shared locks or other forms of collaborative locks.
optional parent_id = 17
OPTIONAL. Reference to the container of this resource. If path is relative it MUST be specified, regardless the access restrictions to the resource: a subsequent Stat() on it MAY return access denied if appropriate.
string name = 18
OPTIONAL The name of the resource.
optional space = 19
OPTIONAL. StorageSpace where this resource is located.
bool immutable = 20
OPTIONAL. Indicates whether the resource is immutable. Its effect depends on the resource type: On a file (freeze): the file is final. It cannot be modified (content is fixed), deleted, moved or renamed. Once set on a file, the immutable attribute MUST NOT be removed. On a container (protect): no entries can be added, removed or modified. The container itself cannot be deleted, moved or renamed. This does NOT propagate to the entries: a protected container can contain unprotected children in which entries can still be added, removed or modified. The immutable attribute on a container can be removed by space managers or administrators. An object is considered immutable if its own attribute is set (self) OR its parent container's attribute is set (parent). Deletion, modification or renaming of an object is governed by the parent; adding or removing entries inside a container by the container itself. This is a persistent attribute (stored as xattr), not a transient status. Use SetImmutable/UnsetImmutable RPCs to change it.
message
resources.proto:319The representation of permissions attached to a resource.
Used in: , , , , , , , , ,
bool add_grant = 1
bool create_container = 2
bool delete = 3
delete applies to files. For containers, see delete_container. When delete_container is not explicitly set, implementations SHOULD fall back to the value of delete for backward compatibility.
bool get_path = 5
bool get_quota = 6
bool initiate_file_download = 7
bool initiate_file_upload = 8
bool list_grants = 9
bool list_container = 10
bool list_file_versions = 11
bool list_recycle = 12
bool move = 13
move applies to files. For containers, see move_container. When move_container is not explicitly set, implementations SHOULD fall back to the value of move for backward compatibility.
bool remove_grant = 14
bool purge_recycle = 15
bool restore_file_version = 16
bool restore_recycle_item = 17
bool stat = 18
bool update_grant = 19
bool deny_grant = 20
bool delete_container = 21
OPTIONAL. When set, controls whether containers (directories) can be deleted, independent of the delete permission which then only applies to files. This allows protecting directory structures while still permitting file deletion. Typical use case: file plan (Aktenplan) protection.
bool move_container = 22
OPTIONAL. When set, controls whether containers (directories) can be moved or renamed, independent of the move permission which then only applies to files. This allows protecting directory structures while still permitting file operations.
bool set_immutable_file = 23
OPTIONAL. Controls whether the user may freeze files (set immutable on files). Freezing a file is irreversible — once set, the file cannot be modified, deleted, moved or renamed, and the attribute cannot be removed. This permission should be granted carefully.
bool set_immutable_container = 24
OPTIONAL. Controls whether the user may protect or unprotect containers (set/unset immutable on containers). Protecting a container prevents adding, removing or modifying its direct entries. Unlike files, container protection is reversible.
The available types of resources.
Used in: , , , ,
RESOURCE_TYPE_INVALID = 0
RESOURCE_TYPE_FILE = 1
The file type represents a type that holds arbitrary data. Service implementors usually map this type to files (local filesystem) or objects (Amazon S3).
RESOURCE_TYPE_CONTAINER = 2
The container type represents a type that can contain another types. Service implementors usually map this type to folders (local filesystem) or buckets (Amazon S3).
RESOURCE_TYPE_REFERENCE = 3
This represents a reference type which points to another resource where client MAY be redirected. Client SHOULD use the ResourceInfo.target reference for a subsequent call.
RESOURCE_TYPE_SYMLINK = 4
This represents a symbolic link type if the underlying storage system supports it. Symlink target SHOULD NOT be interpreted by the clients.
RESOURCE_TYPE_INTERNAL = 5
Internal resource type for some specific resources inside a storage implementation. For example, this type could be used to represent a device file on a Linux filesystem. Another example could be to represent an ongoing upload, where an hypothetically user interface could show a loading icon on this type of resources until the upload operation is completed. Internal resources SHOULD NOT be moved to a different storage provider.
message
provider_api.proto:742Used as request type in: gateway.v1beta1.GatewayAPI.RestoreFileVersion, ProviderAPI.RestoreFileVersion
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
string key = 3
REQUIRED. The key to restore a specific file version.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id MUST be equal to the given value.
message
provider_api.proto:758Used as response type in: gateway.v1beta1.GatewayAPI.RestoreFileVersion, ProviderAPI.RestoreFileVersion
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:768TODO: restore to original location if not specified as OPTIONAL?
Used as request type in: gateway.v1beta1.GatewayAPI.RestoreRecycleItem, ProviderAPI.RestoreRecycleItem
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to the user's home directory.
string key = 3
REQUIRED. The key for the recycle item to be restored.
optional restore_ref = 4
OPTIONAL. An optional restore path for the deleted resource. It can be useful to restore to another location rather than the original. If empty, service implementors MUST restore to original location if possible.
string lock_id = 5
OPTIONAL. A lock_id: should a lock exist for the reference where the file is to be restored, the stored lock_id MUST be equal to the given value.
message
provider_api.proto:791Used as response type in: gateway.v1beta1.GatewayAPI.RestoreRecycleItem, ProviderAPI.RestoreRecycleItem
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:926Used as request type in: gateway.v1beta1.GatewayAPI.SetArbitraryMetadata, ProviderAPI.SetArbitraryMetadata
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
optional arbitrary_metadata = 3
REQUIRED. The arbitrary metadata to add to the resource.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for setting attributes even if the lock does not match.
message
provider_api.proto:944Used as response type in: gateway.v1beta1.GatewayAPI.SetArbitraryMetadata, ProviderAPI.SetArbitraryMetadata
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:1070Used as request type in: gateway.v1beta1.GatewayAPI.SetImmutable, ProviderAPI.SetImmutable
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to the resource to freeze.
message
provider_api.proto:1079Used as response type in: gateway.v1beta1.GatewayAPI.SetImmutable, ProviderAPI.SetImmutable
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:980Used as request type in: gateway.v1beta1.GatewayAPI.SetLock, ProviderAPI.SetLock
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference on which the lock should be set, if no lock is present.
optional lock = 3
REQUIRED. The lock metadata.
message
provider_api.proto:993Used as response type in: gateway.v1beta1.GatewayAPI.SetLock, ProviderAPI.SetLock
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
spaces_api.proto:205Used in:
SpaceMetadata.Type type = 1
string id = 2
ID of the entry, usually the inode of the file that contains the actual metadata.
Type of metadata entry
Used in:
TYPE_README = 0
TYPE_THUMBNAIL = 1
message
provider_api.proto:827Used as request type in: gateway.v1beta1.GatewayAPI.Stat, ProviderAPI.Stat
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
repeated string arbitrary_metadata_keys = 3
OPTIONAL. Arbitrary metadata be included with the resource. A key with the name '*' means to return all available arbitrary metadata.
optional field_mask = 4
OPTIONAL. The field mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
message
provider_api.proto:844Used as response type in: gateway.v1beta1.GatewayAPI.Stat, ProviderAPI.Stat
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
optional info = 3
REQUIRED. The resource information.
message
resources.proto:508Represents a storage space which could be a 'home', 'share' etc...
Used in: , , , ,
optional opaque = 1
OPTIONAL. Opaque information.
optional id = 2
REQUIRED.
optional owner = 3
OPTIONAL.
optional root = 4
OPTIONAL. The root resource id of the storage space.
string name = 5
OPTIONAL.
optional quota = 6
OPTIONAL.
string space_type = 7
OPTIONAL. Could be 'home', 'share', 'project', 'space'...
optional mtime = 8
OPTIONAL. Last modification time (mtime) of the root resource of this storage space.
optional root_info = 9
OPTIONAL. Resource info for the storage space root.
bool has_trashed_items = 10
OPTIONAL. HasTrashedItems indicates if the storage space has trashed items.
string description = 11
OPTIONAL. Description of the space.
string thumbnail_id = 13
OPTIONAL. An opaque ID of an optional thumbnail file of the space (usually the inode)
string readme_id = 14
OPTIONAL. An opaque ID of an optional readme file of the space (usually the inode)
optional permission_set = 15
OPTIONAL. The set of permissions for the storage space effective for the authenticated user.
message
resources.proto:550The id of a storage space.
Used in: , ,
string opaque_id = 1
REQUIRED. The internal storage space id.
message
provider_api.proto:282Used as request type in: gateway.v1beta1.GatewayAPI.TouchFile, ProviderAPI.TouchFile
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
string lock_id = 3
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id MUST be equal to the given value. However, implementations MAY allow touching an existing file even with a mismatching lock.
message
provider_api.proto:296Used as response type in: gateway.v1beta1.GatewayAPI.TouchFile, ProviderAPI.TouchFile
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:1049Used as request type in: gateway.v1beta1.GatewayAPI.Unlock, ProviderAPI.Unlock
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference the lock is associated to.
optional lock = 3
REQUIRED. The lock metadata.
message
provider_api.proto:1061Used as response type in: gateway.v1beta1.GatewayAPI.Unlock, ProviderAPI.Unlock
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:953Used as request type in: gateway.v1beta1.GatewayAPI.UnsetArbitraryMetadata, ProviderAPI.UnsetArbitraryMetadata
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to which the action should be performed.
repeated string arbitrary_metadata_keys = 3
REQUIRED. The arbitrary metadata to delete.
string lock_id = 4
OPTIONAL. A lock_id: should the reference be locked, the stored lock_id SHOULD be equal to the given value. However, storage implementations MAY allow for unsetting attributes even if the lock does not match.
message
provider_api.proto:971Used as response type in: gateway.v1beta1.GatewayAPI.UnsetArbitraryMetadata, ProviderAPI.UnsetArbitraryMetadata
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
provider_api.proto:1088Used as request type in: gateway.v1beta1.GatewayAPI.UnsetImmutable, ProviderAPI.UnsetImmutable
optional opaque = 1
OPTIONAL. Opaque information.
optional ref = 2
REQUIRED. The reference to the resource to unfreeze.
message
provider_api.proto:1097Used as response type in: gateway.v1beta1.GatewayAPI.UnsetImmutable, ProviderAPI.UnsetImmutable
optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
message
spaces_api.proto:150Used as request type in: gateway.v1beta1.GatewayAPI.UpdateStorageSpace, SpacesAPI.UpdateStorageSpace
optional opaque = 1
OPTIONAL. Opaque information.
optional storage_space = 2
REQUIRED.
optional field = 3
REQUIRED.
message
spaces_api.proto:157REQUIRED.
Used in:
oneof field
One of the update fields MUST be specified.
string description = 1
Update the space description.
string alias = 2
Update the space alias.
metadata = 3
Update IDs of "special" files, such as readme or thumbnail, directly stored in the space.
quota = 4
Update the space quota.
string name = 5
Update the space name.
message
spaces_api.proto:176Used as response type in: gateway.v1beta1.GatewayAPI.UpdateStorageSpace, SpacesAPI.UpdateStorageSpace
optional opaque = 1
OPTIONAL. Opaque information.
optional status = 2
REQUIRED. The response status.
optional storage_space = 3
REQUIRED. The updated storage space.