package nitric.proto.storage.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Services for storage and retrieval of blobs in the form of byte arrays, such as text and binary blobs.

• rpc Read (StorageReadRequest, StorageReadResponse)

  storage.proto:18

  Retrieve an item from a bucket

  message StorageReadRequest

  storage.proto:119

  Request to retrieve a storage item

  • string bucket_name = 1

    Nitric name of the bucket to retrieve from this will be automatically resolved to the provider specific bucket identifier.

  • string key = 2

    Key of item to retrieve

  message StorageReadResponse

  storage.proto:128

  Returned storage item

  • bytes body = 1

    The body bytes of the retrieved storage item

• rpc Write (StorageWriteRequest, StorageWriteResponse)

  storage.proto:20

  Store an item to a bucket

  message StorageWriteRequest

  storage.proto:104

  Request to put (create/update) a storage item

  • string bucket_name = 1

    Nitric name of the bucket to store in this will be automatically resolved to the provider specific bucket identifier.

  • string key = 2

    Key to store the item under

  • bytes body = 3

    bytes array to store

  message StorageWriteResponse

  storage.proto:115

  Result of putting a storage item

  (message has no fields)

• rpc Delete (StorageDeleteRequest, StorageDeleteResponse)

  storage.proto:22

  Delete an item from a bucket

  message StorageDeleteRequest

  storage.proto:134

  Request to delete a storage item

  • string bucket_name = 1

    Name of the bucket to delete from

  • string key = 2

    Key of item to delete

  message StorageDeleteResponse

  storage.proto:142

  Result of deleting a storage item

  (message has no fields)

• rpc PreSignUrl (StoragePreSignUrlRequest, StoragePreSignUrlResponse)

  storage.proto:24

  Generate a pre-signed URL for direct operations on an item

  message StoragePreSignUrlRequest

  storage.proto:146

  Request to generate a pre-signed URL for a blob to perform a specific operation, such as read or write.

  • string bucket_name = 1

    Nitric name of the bucket to retrieve from this will be automatically resolved to the provider specific bucket identifier.

  • string key = 2

    Key of item to generate the signed URL for. The URL and the token it contains will only be valid for operations on this resource specifically.

  • StoragePreSignUrlRequest.Operation operation = 3

  • optional google.protobuf.Duration expiry = 4

    Expiry defined as as protobuf duration

  message StoragePreSignUrlResponse

  storage.proto:163

  • string url = 1

    The pre-signed url, restricted to the operation, resource and expiry time specified in the request.

• rpc ListBlobs (StorageListBlobsRequest, StorageListBlobsResponse)

  storage.proto:26

  List blobs currently in the bucket

  message StorageListBlobsRequest

  storage.proto:168

  • string bucket_name = 1

  • string prefix = 2

  message StorageListBlobsResponse

  storage.proto:178

  • repeated Blob blobs = 1

    keys of the blobs in the bucket

• rpc Exists (StorageExistsRequest, StorageExistsResponse)

  storage.proto:28

  Determine is an object exists in a bucket

  message StorageExistsRequest

  storage.proto:183

  • string bucket_name = 1

  • string key = 2

    Key of item to retrieve

  message StorageExistsResponse

  storage.proto:189

  • bool exists = 1

• rpc Listen (stream ClientMessage, stream ServerMessage)

  storage.proto:33

  Listen for changes on a bucket

  message ClientMessage

  storage.proto:37

  ClientMessages are sent from the service to the nitric server

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationRequest registration_request = 2

      Watch for changes on a bucket

    • BlobEventResponse blob_event_response = 3

      Response to a blob event (change to a blob)

  message ServerMessage

  storage.proto:50

  ServerMessages are sent from the nitric server to the service

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationResponse registration_response = 2

      Watch for changes on a bucket

    • BlobEventRequest blob_event_request = 3

      Event for a blob in a bucket

Used in: StorageListBlobsResponse

• string key = 1

Used in: BlobEventRequest

• string key = 1

  The key of the blob the event is for

• BlobEventType type = 2

  The type of event that occurred

Used in: ServerMessage

• string bucket_name = 1

• oneof event

  • BlobEvent blob_event = 10

Used in: ClientMessage

• bool success = 1

Used in: BlobEvent, RegistrationRequest

• Created = 0

• Deleted = 1

Used in: deployments.v1.BucketListener, ClientMessage

• string bucket_name = 1

  Name of the bucket to watch

• BlobEventType blob_event_type = 2

  Event type to listen for

• string key_prefix_filter = 3

  A blob key prefix to filter events by

Used in: ServerMessage

• string id = 1

  The ID of the registration

Operation

Used in: StoragePreSignUrlRequest

• READ = 0

• WRITE = 1