package cs3.labels.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Labels API. The Labels API is responsible for: * Attaching and removing labels to/from resources * Listing all resources attached to a given label * Listing all unique labels for a given user 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 AddLabel (AddLabelRequest, AddLabelResponse)

  label_api.proto:56

  Attach a label to a resource for a user.

• rpc ListLabels (ListLabelsRequest, ListLabelsResponse)

  label_api.proto:60

  List the unique labels that a user has attached to resources

• rpc ListResourcesForLabel (ListResourcesForLabelRequest, ListResourcesForLabelResponse)

  label_api.proto:62

  List the resources which have a given label attached for a given user

• rpc RemoveLabel (RemoveLabelRequest, RemoveLabelResponse)

  label_api.proto:58

  Removes a label from a resource for a user.

Used as request type in: gateway.v1beta1.GatewayAPI.AddLabel, LabelsAPI.AddLabel

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional storage.provider.v1beta1.Reference ref = 2

  REQUIRED. The reference to which the action should be performed.

• optional identity.user.v1beta1.UserId user_id = 3

  REQUIRED. The user attaching the label to the resource.

• string label = 4

  REQUIRED. The label to be attached to the resource.

Used as response type in: gateway.v1beta1.GatewayAPI.AddLabel, LabelsAPI.AddLabel

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

Used as request type in: gateway.v1beta1.GatewayAPI.ListLabels, LabelsAPI.ListLabels

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId user_id = 2

  REQUIRED. The user for which the unique labels are requested

Used as response type in: gateway.v1beta1.GatewayAPI.ListLabels, LabelsAPI.ListLabels

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated string labels = 3

  REQUIRED. The user's unique labels.

Used as request type in: gateway.v1beta1.GatewayAPI.ListResourcesForLabel, LabelsAPI.ListResourcesForLabel

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional identity.user.v1beta1.UserId user_id = 2

  REQUIRED. The user for which the unique labels are requested

• string labels = 3

  REQUIRED. The queried label

Used as response type in: gateway.v1beta1.GatewayAPI.ListResourcesForLabel, LabelsAPI.ListResourcesForLabel

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated storage.provider.v1beta1.Reference ref = 3

  REQUIRED. The references which have this label attached for the user.

Used as request type in: gateway.v1beta1.GatewayAPI.RemoveLabel, LabelsAPI.RemoveLabel

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional storage.provider.v1beta1.Reference ref = 2

  REQUIRED. The reference to which the action should be performed.

• optional identity.user.v1beta1.UserId user_id = 3

  REQUIRED. The user removing the label from the resource.

• string label = 4

  REQUIRED. The label to be removed from the resource.

Used as response type in: gateway.v1beta1.GatewayAPI.RemoveLabel, LabelsAPI.RemoveLabel

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.