Documentation ¶
Index ¶
- Constants
- Variables
- func RegisterCollaborationAPIServer(s grpc.ServiceRegistrar, srv CollaborationAPIServer)
- type CollaborationAPIClient
- type CollaborationAPIServer
- type CreateShareRequest
- func (*CreateShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateShareRequest) GetGrant() *ShareGrant
- func (x *CreateShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *CreateShareRequest) GetResourceInfo() *v1beta11.ResourceInfo
- func (*CreateShareRequest) ProtoMessage()
- func (x *CreateShareRequest) ProtoReflect() protoreflect.Message
- func (x *CreateShareRequest) Reset()
- func (x *CreateShareRequest) String() string
- type CreateShareResponse
- func (*CreateShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *CreateShareResponse) GetShare() *Share
- func (x *CreateShareResponse) GetStatus() *v1beta12.Status
- func (*CreateShareResponse) ProtoMessage()
- func (x *CreateShareResponse) ProtoReflect() protoreflect.Message
- func (x *CreateShareResponse) Reset()
- func (x *CreateShareResponse) String() string
- type Filter
- func (*Filter) Descriptor() ([]byte, []int)deprecated
- func (x *Filter) GetCreator() *v1beta11.UserId
- func (x *Filter) GetGranteeType() v1beta1.GranteeType
- func (x *Filter) GetOwner() *v1beta11.UserId
- func (x *Filter) GetResourceId() *v1beta1.ResourceId
- func (x *Filter) GetSpaceId() string
- func (x *Filter) GetState() ShareState
- func (m *Filter) GetTerm() isFilter_Term
- func (x *Filter) GetType() Filter_Type
- func (*Filter) ProtoMessage()
- func (x *Filter) ProtoReflect() protoreflect.Message
- func (x *Filter) Reset()
- func (x *Filter) String() string
- type Filter_Creator
- type Filter_GranteeType
- type Filter_Owner
- type Filter_ResourceId
- type Filter_SpaceId
- type Filter_State
- type Filter_Type
- func (Filter_Type) Descriptor() protoreflect.EnumDescriptor
- func (x Filter_Type) Enum() *Filter_Type
- func (Filter_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x Filter_Type) Number() protoreflect.EnumNumber
- func (x Filter_Type) String() string
- func (Filter_Type) Type() protoreflect.EnumType
- type GetReceivedShareRequest
- func (*GetReceivedShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetReceivedShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *GetReceivedShareRequest) GetRef() *ShareReference
- func (*GetReceivedShareRequest) ProtoMessage()
- func (x *GetReceivedShareRequest) ProtoReflect() protoreflect.Message
- func (x *GetReceivedShareRequest) Reset()
- func (x *GetReceivedShareRequest) String() string
- type GetReceivedShareResponse
- func (*GetReceivedShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetReceivedShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *GetReceivedShareResponse) GetShare() *ReceivedShare
- func (x *GetReceivedShareResponse) GetStatus() *v1beta12.Status
- func (*GetReceivedShareResponse) ProtoMessage()
- func (x *GetReceivedShareResponse) ProtoReflect() protoreflect.Message
- func (x *GetReceivedShareResponse) Reset()
- func (x *GetReceivedShareResponse) String() string
- type GetShareRequest
- func (*GetShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *GetShareRequest) GetRef() *ShareReference
- func (*GetShareRequest) ProtoMessage()
- func (x *GetShareRequest) ProtoReflect() protoreflect.Message
- func (x *GetShareRequest) Reset()
- func (x *GetShareRequest) String() string
- type GetShareResponse
- func (*GetShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *GetShareResponse) GetShare() *Share
- func (x *GetShareResponse) GetStatus() *v1beta12.Status
- func (*GetShareResponse) ProtoMessage()
- func (x *GetShareResponse) ProtoReflect() protoreflect.Message
- func (x *GetShareResponse) Reset()
- func (x *GetShareResponse) String() string
- type ListReceivedSharesRequest
- func (*ListReceivedSharesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListReceivedSharesRequest) GetFilters() []*Filter
- func (x *ListReceivedSharesRequest) GetOpaque() *v1beta1.Opaque
- func (x *ListReceivedSharesRequest) GetPageSize() int32
- func (x *ListReceivedSharesRequest) GetPageToken() string
- func (*ListReceivedSharesRequest) ProtoMessage()
- func (x *ListReceivedSharesRequest) ProtoReflect() protoreflect.Message
- func (x *ListReceivedSharesRequest) Reset()
- func (x *ListReceivedSharesRequest) String() string
- type ListReceivedSharesResponse
- func (*ListReceivedSharesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListReceivedSharesResponse) GetNextPageToken() string
- func (x *ListReceivedSharesResponse) GetOpaque() *v1beta1.Opaque
- func (x *ListReceivedSharesResponse) GetShares() []*ReceivedShare
- func (x *ListReceivedSharesResponse) GetStatus() *v1beta12.Status
- func (*ListReceivedSharesResponse) ProtoMessage()
- func (x *ListReceivedSharesResponse) ProtoReflect() protoreflect.Message
- func (x *ListReceivedSharesResponse) Reset()
- func (x *ListReceivedSharesResponse) String() string
- type ListSharesRequest
- func (*ListSharesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListSharesRequest) GetFilters() []*Filter
- func (x *ListSharesRequest) GetOpaque() *v1beta1.Opaque
- func (x *ListSharesRequest) GetPageSize() int32
- func (x *ListSharesRequest) GetPageToken() string
- func (*ListSharesRequest) ProtoMessage()
- func (x *ListSharesRequest) ProtoReflect() protoreflect.Message
- func (x *ListSharesRequest) Reset()
- func (x *ListSharesRequest) String() string
- type ListSharesResponse
- func (*ListSharesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListSharesResponse) GetNextPageToken() string
- func (x *ListSharesResponse) GetOpaque() *v1beta1.Opaque
- func (x *ListSharesResponse) GetShares() []*Share
- func (x *ListSharesResponse) GetStatus() *v1beta12.Status
- func (*ListSharesResponse) ProtoMessage()
- func (x *ListSharesResponse) ProtoReflect() protoreflect.Message
- func (x *ListSharesResponse) Reset()
- func (x *ListSharesResponse) String() string
- type ReceivedShare
- func (*ReceivedShare) Descriptor() ([]byte, []int)deprecated
- func (x *ReceivedShare) GetHidden() bool
- func (x *ReceivedShare) GetMountPoint() *v1beta1.Reference
- func (x *ReceivedShare) GetShare() *Share
- func (x *ReceivedShare) GetState() ShareState
- func (*ReceivedShare) ProtoMessage()
- func (x *ReceivedShare) ProtoReflect() protoreflect.Message
- func (x *ReceivedShare) Reset()
- func (x *ReceivedShare) String() string
- type RemoveShareRequest
- func (*RemoveShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RemoveShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *RemoveShareRequest) GetRef() *ShareReference
- func (*RemoveShareRequest) ProtoMessage()
- func (x *RemoveShareRequest) ProtoReflect() protoreflect.Message
- func (x *RemoveShareRequest) Reset()
- func (x *RemoveShareRequest) String() string
- type RemoveShareResponse
- func (*RemoveShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RemoveShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *RemoveShareResponse) GetStatus() *v1beta12.Status
- func (*RemoveShareResponse) ProtoMessage()
- func (x *RemoveShareResponse) ProtoReflect() protoreflect.Message
- func (x *RemoveShareResponse) Reset()
- func (x *RemoveShareResponse) String() string
- type Share
- func (*Share) Descriptor() ([]byte, []int)deprecated
- func (x *Share) GetCreator() *v1beta11.UserId
- func (x *Share) GetCtime() *v1beta12.Timestamp
- func (x *Share) GetExpiration() *v1beta12.Timestamp
- func (x *Share) GetGrantee() *v1beta1.Grantee
- func (x *Share) GetId() *ShareId
- func (x *Share) GetMtime() *v1beta12.Timestamp
- func (x *Share) GetOwner() *v1beta11.UserId
- func (x *Share) GetPermissions() *SharePermissions
- func (x *Share) GetResourceId() *v1beta1.ResourceId
- func (*Share) ProtoMessage()
- func (x *Share) ProtoReflect() protoreflect.Message
- func (x *Share) Reset()
- func (x *Share) String() string
- type ShareGrant
- func (*ShareGrant) Descriptor() ([]byte, []int)deprecated
- func (x *ShareGrant) GetExpiration() *v1beta12.Timestamp
- func (x *ShareGrant) GetGrantee() *v1beta1.Grantee
- func (x *ShareGrant) GetPermissions() *SharePermissions
- func (*ShareGrant) ProtoMessage()
- func (x *ShareGrant) ProtoReflect() protoreflect.Message
- func (x *ShareGrant) Reset()
- func (x *ShareGrant) String() string
- type ShareId
- type ShareKey
- func (*ShareKey) Descriptor() ([]byte, []int)deprecated
- func (x *ShareKey) GetGrantee() *v1beta1.Grantee
- func (x *ShareKey) GetOwner() *v1beta11.UserId
- func (x *ShareKey) GetResourceId() *v1beta1.ResourceId
- func (*ShareKey) ProtoMessage()
- func (x *ShareKey) ProtoReflect() protoreflect.Message
- func (x *ShareKey) Reset()
- func (x *ShareKey) String() string
- type SharePermissions
- func (*SharePermissions) Descriptor() ([]byte, []int)deprecated
- func (x *SharePermissions) GetPermissions() *v1beta1.ResourcePermissions
- func (*SharePermissions) ProtoMessage()
- func (x *SharePermissions) ProtoReflect() protoreflect.Message
- func (x *SharePermissions) Reset()
- func (x *SharePermissions) String() string
- type ShareReference
- func (*ShareReference) Descriptor() ([]byte, []int)deprecated
- func (x *ShareReference) GetId() *ShareId
- func (x *ShareReference) GetKey() *ShareKey
- func (m *ShareReference) GetSpec() isShareReference_Spec
- func (*ShareReference) ProtoMessage()
- func (x *ShareReference) ProtoReflect() protoreflect.Message
- func (x *ShareReference) Reset()
- func (x *ShareReference) String() string
- type ShareReference_Id
- type ShareReference_Key
- type ShareState
- type UnimplementedCollaborationAPIServer
- func (UnimplementedCollaborationAPIServer) CreateShare(context.Context, *CreateShareRequest) (*CreateShareResponse, error)
- func (UnimplementedCollaborationAPIServer) GetReceivedShare(context.Context, *GetReceivedShareRequest) (*GetReceivedShareResponse, error)
- func (UnimplementedCollaborationAPIServer) GetShare(context.Context, *GetShareRequest) (*GetShareResponse, error)
- func (UnimplementedCollaborationAPIServer) ListReceivedShares(context.Context, *ListReceivedSharesRequest) (*ListReceivedSharesResponse, error)
- func (UnimplementedCollaborationAPIServer) ListShares(context.Context, *ListSharesRequest) (*ListSharesResponse, error)
- func (UnimplementedCollaborationAPIServer) RemoveShare(context.Context, *RemoveShareRequest) (*RemoveShareResponse, error)
- func (UnimplementedCollaborationAPIServer) UpdateReceivedShare(context.Context, *UpdateReceivedShareRequest) (*UpdateReceivedShareResponse, error)
- func (UnimplementedCollaborationAPIServer) UpdateShare(context.Context, *UpdateShareRequest) (*UpdateShareResponse, error)
- type UnsafeCollaborationAPIServer
- type UpdateReceivedShareRequest
- func (*UpdateReceivedShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateReceivedShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *UpdateReceivedShareRequest) GetShare() *ReceivedShare
- func (x *UpdateReceivedShareRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (*UpdateReceivedShareRequest) ProtoMessage()
- func (x *UpdateReceivedShareRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateReceivedShareRequest) Reset()
- func (x *UpdateReceivedShareRequest) String() string
- type UpdateReceivedShareResponse
- func (*UpdateReceivedShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateReceivedShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *UpdateReceivedShareResponse) GetShare() *ReceivedShare
- func (x *UpdateReceivedShareResponse) GetStatus() *v1beta12.Status
- func (*UpdateReceivedShareResponse) ProtoMessage()
- func (x *UpdateReceivedShareResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateReceivedShareResponse) Reset()
- func (x *UpdateReceivedShareResponse) String() string
- type UpdateShareRequest
- func (*UpdateShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateShareRequest) GetField() *UpdateShareRequest_UpdateField
- func (x *UpdateShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *UpdateShareRequest) GetRef() *ShareReference
- func (x *UpdateShareRequest) GetShare() *Share
- func (x *UpdateShareRequest) GetUpdateMask() *fieldmaskpb.FieldMask
- func (*UpdateShareRequest) ProtoMessage()
- func (x *UpdateShareRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateShareRequest) Reset()
- func (x *UpdateShareRequest) String() string
- type UpdateShareRequest_UpdateField
- func (*UpdateShareRequest_UpdateField) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateShareRequest_UpdateField) GetDisplayName() string
- func (m *UpdateShareRequest_UpdateField) GetField() isUpdateShareRequest_UpdateField_Field
- func (x *UpdateShareRequest_UpdateField) GetPermissions() *SharePermissions
- func (*UpdateShareRequest_UpdateField) ProtoMessage()
- func (x *UpdateShareRequest_UpdateField) ProtoReflect() protoreflect.Message
- func (x *UpdateShareRequest_UpdateField) Reset()
- func (x *UpdateShareRequest_UpdateField) String() string
- type UpdateShareRequest_UpdateField_DisplayName
- type UpdateShareRequest_UpdateField_Permissions
- type UpdateShareResponse
- func (*UpdateShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *UpdateShareResponse) GetShare() *Share
- func (x *UpdateShareResponse) GetStatus() *v1beta12.Status
- func (*UpdateShareResponse) ProtoMessage()
- func (x *UpdateShareResponse) ProtoReflect() protoreflect.Message
- func (x *UpdateShareResponse) Reset()
- func (x *UpdateShareResponse) String() string
Constants ¶
const ()
Variables ¶
var (0: "SHARE_STATE_INVALID", 1: "SHARE_STATE_PENDING", 2: "SHARE_STATE_ACCEPTED", 3: "SHARE_STATE_REJECTED", } "SHARE_STATE_INVALID": 0, "SHARE_STATE_PENDING": 1, "SHARE_STATE_ACCEPTED": 2, "SHARE_STATE_REJECTED": 3, } )
Enum value maps for ShareState.
var ( Filter_Type_name = map[int32]string{ 0: "TYPE_INVALID", 1: "TYPE_NO", 2: "TYPE_RESOURCE_ID", 3: "TYPE_OWNER", 4: "TYPE_CREATOR", 5: "TYPE_GRANTEE_TYPE", 6: "TYPE_EXCLUDE_DENIALS", 7: "TYPE_SPACE_ID", 8: "TYPE_STATE", } Filter_Type_value = map[string]int32{ "TYPE_INVALID": 0, "TYPE_NO": 1, "TYPE_RESOURCE_ID": 2, "TYPE_OWNER": 3, "TYPE_CREATOR": 4, "TYPE_GRANTEE_TYPE": 5, "TYPE_EXCLUDE_DENIALS": 6, "TYPE_SPACE_ID": 7, "TYPE_STATE": 8, } )
Enum value maps for Filter_Type.
var CollaborationAPI_ServiceDesc = grpc.ServiceDesc{ ServiceName: "cs3.sharing.collaboration.v1beta1.CollaborationAPI", HandlerType: (*CollaborationAPIServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateShare", Handler: _CollaborationAPI_CreateShare_Handler, }, { MethodName: "RemoveShare", Handler: _CollaborationAPI_RemoveShare_Handler, }, { MethodName: "GetShare", Handler: _CollaborationAPI_GetShare_Handler, }, { MethodName: "ListShares", Handler: _CollaborationAPI_ListShares_Handler, }, { MethodName: "UpdateShare", Handler: _CollaborationAPI_UpdateShare_Handler, }, { MethodName: "ListReceivedShares", Handler: _CollaborationAPI_ListReceivedShares_Handler, }, { MethodName: "UpdateReceivedShare", Handler: _CollaborationAPI_UpdateReceivedShare_Handler, }, { MethodName: "GetReceivedShare", Handler: _CollaborationAPI_GetReceivedShare_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "cs3/sharing/collaboration/v1beta1/collaboration_api.proto", }
CollaborationAPI_ServiceDesc is the grpc.ServiceDesc for CollaborationAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_cs3_sharing_collaboration_v1beta1_collaboration_api_proto protoreflect.FileDescriptor
var File_cs3_sharing_collaboration_v1beta1_resources_proto protoreflect.FileDescriptor
Functions ¶
func RegisterCollaborationAPIServer ¶
func RegisterCollaborationAPIServer(s grpc.ServiceRegistrar, srv CollaborationAPIServer)
Types ¶
type CollaborationAPIClient ¶
type CollaborationAPIClient interface { // MUST return CODE_NOT_FOUND if the resource reference does not exist. // MUST return CODE_LOCKED if the resource reference already locked. // MUST return CODE_ALREADY_EXISTS if the share already exists for the 4-tuple consisting of // (owner, shared_resource, grantee). // New shares MUST be created in the state SHARE_STATE_PENDING. CreateShare(ctx context.Context, in *CreateShareRequest, opts ...grpc.CallOption) (*CreateShareResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. RemoveShare(ctx context.Context, in *RemoveShareRequest, opts ...grpc.CallOption) (*RemoveShareResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. GetShare(ctx context.Context, in *GetShareRequest, opts ...grpc.CallOption) (*GetShareResponse, error) // both as owner and creator. If a filter is specified, only // shares satisfying the filter MUST be returned. ListShares(ctx context.Context, in *ListSharesRequest, opts ...grpc.CallOption) (*ListSharesResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. UpdateShare(ctx context.Context, in *UpdateShareRequest, opts ...grpc.CallOption) (*UpdateShareResponse, error) ListReceivedShares(ctx context.Context, in *ListReceivedSharesRequest, opts ...grpc.CallOption) (*ListReceivedSharesResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. UpdateReceivedShare(ctx context.Context, in *UpdateReceivedShareRequest, opts ...grpc.CallOption) (*UpdateReceivedShareResponse, error) // MUST return CODE_NOT_FOUND if the received share reference does not exist. GetReceivedShare(ctx context.Context, in *GetReceivedShareRequest, opts ...grpc.CallOption) (*GetReceivedShareResponse, error) }
CollaborationAPIClient is the client API for CollaborationAPI service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewCollaborationAPIClient ¶
func NewCollaborationAPIClient(cc grpc.ClientConnInterface) CollaborationAPIClient
type CollaborationAPIServer ¶
type CollaborationAPIServer interface { // MUST return CODE_NOT_FOUND if the resource reference does not exist. // MUST return CODE_LOCKED if the resource reference already locked. // MUST return CODE_ALREADY_EXISTS if the share already exists for the 4-tuple consisting of // (owner, shared_resource, grantee). // New shares MUST be created in the state SHARE_STATE_PENDING. CreateShare(context.Context, *CreateShareRequest) (*CreateShareResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. RemoveShare(context.Context, *RemoveShareRequest) (*RemoveShareResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. GetShare(context.Context, *GetShareRequest) (*GetShareResponse, error) // both as owner and creator. If a filter is specified, only // shares satisfying the filter MUST be returned. ListShares(context.Context, *ListSharesRequest) (*ListSharesResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. UpdateShare(context.Context, *UpdateShareRequest) (*UpdateShareResponse, error) ListReceivedShares(context.Context, *ListReceivedSharesRequest) (*ListReceivedSharesResponse, error) // MUST return CODE_NOT_FOUND if the share reference does not exist. UpdateReceivedShare(context.Context, *UpdateReceivedShareRequest) (*UpdateReceivedShareResponse, error) // MUST return CODE_NOT_FOUND if the received share reference does not exist. GetReceivedShare(context.Context, *GetReceivedShareRequest) (*GetReceivedShareResponse, error) }
CollaborationAPIServer is the server API for CollaborationAPI service. All implementations should embed UnimplementedCollaborationAPIServer for forward compatibility
type CreateShareRequest ¶
type CreateShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The information of the resource to be shared. ResourceInfo *v1beta11.ResourceInfo `protobuf:"bytes,2,opt,name=resource_info,json=resourceInfo,proto3" json:"resource_info,omitempty"` // The share grant for the share. Grant *ShareGrant `protobuf:"bytes,3,opt,name=grant,proto3" json:"grant,omitempty"` // contains filtered or unexported fields }
func (*CreateShareRequest) Descriptor
deprecated
func (*CreateShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateShareRequest.ProtoReflect.Descriptor instead.
func (*CreateShareRequest) GetGrant ¶
func (x *CreateShareRequest) GetGrant() *ShareGrant
func (*CreateShareRequest) GetOpaque ¶
func (x *CreateShareRequest) GetOpaque() *v1beta1.Opaque
func (*CreateShareRequest) GetResourceInfo ¶
func (x *CreateShareRequest) GetResourceInfo() *v1beta11.ResourceInfo
func (*CreateShareRequest) ProtoMessage ¶
func (*CreateShareRequest) ProtoMessage()
func (*CreateShareRequest) ProtoReflect ¶
func (x *CreateShareRequest) ProtoReflect() protoreflect.Message
func (*CreateShareRequest) Reset ¶
func (x *CreateShareRequest) Reset()
func (*CreateShareRequest) String ¶
func (x *CreateShareRequest) String() string
type CreateShareResponse ¶
type CreateShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The created share. Share *Share `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*CreateShareResponse) Descriptor
deprecated
func (*CreateShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateShareResponse.ProtoReflect.Descriptor instead.
func (*CreateShareResponse) GetOpaque ¶
func (x *CreateShareResponse) GetOpaque() *v1beta1.Opaque
func (*CreateShareResponse) GetShare ¶
func (x *CreateShareResponse) GetShare() *Share
func (*CreateShareResponse) GetStatus ¶
func (x *CreateShareResponse) GetStatus() *v1beta12.Status
func (*CreateShareResponse) ProtoMessage ¶
func (*CreateShareResponse) ProtoMessage()
func (*CreateShareResponse) ProtoReflect ¶
func (x *CreateShareResponse) ProtoReflect() protoreflect.Message
func (*CreateShareResponse) Reset ¶
func (x *CreateShareResponse) Reset()
func (*CreateShareResponse) String ¶
func (x *CreateShareResponse) String() string
type Filter ¶
type Filter struct { // REQUIRED. Type Filter_Type `protobuf:"varint,2,opt,name=type,proto3,enum=cs3.sharing.collaboration.v1beta1.Filter_Type" json:"type,omitempty"` // Types that are assignable to Term: // // *Filter_ResourceId // *Filter_Owner // *Filter_Creator // *Filter_GranteeType // *Filter_SpaceId // *Filter_State Term isFilter_Term `protobuf_oneof:"term"` // contains filtered or unexported fields }
Represents a filter to apply to the request.
func (*Filter) Descriptor
deprecated
func (*Filter) GetCreator ¶
func (*Filter) GetGranteeType ¶
func (x *Filter) GetGranteeType() v1beta1.GranteeType
func (*Filter) GetResourceId ¶
func (x *Filter) GetResourceId() *v1beta1.ResourceId
func (*Filter) GetSpaceId ¶
func (*Filter) GetState ¶
func (x *Filter) GetState() ShareState
func (*Filter) GetType ¶
func (x *Filter) GetType() Filter_Type
func (*Filter) ProtoMessage ¶
func (*Filter) ProtoMessage()
func (*Filter) ProtoReflect ¶
func (x *Filter) ProtoReflect() protoreflect.Message
type Filter_Creator ¶
type Filter_GranteeType ¶
type Filter_GranteeType struct {
GranteeType v1beta1.GranteeType `protobuf:"varint,6,opt,name=grantee_type,json=granteeType,proto3,enum=cs3.storage.provider.v1beta1.GranteeType,oneof"`
}
type Filter_Owner ¶
type Filter_ResourceId ¶
type Filter_ResourceId struct {
ResourceId *v1beta1.ResourceId `protobuf:"bytes,3,opt,name=resource_id,json=resourceId,proto3,oneof"`
}
type Filter_SpaceId ¶
type Filter_SpaceId struct {
SpaceId string `protobuf:"bytes,7,opt,name=space_id,json=spaceId,proto3,oneof"`
}
type Filter_State ¶
type Filter_State struct {
State ShareState `protobuf:"varint,8,opt,name=state,proto3,enum=cs3.sharing.collaboration.v1beta1.ShareState,oneof"`
}
type Filter_Type ¶
type Filter_Type int32
The filter to apply.
const ( Filter_TYPE_INVALID Filter_Type = 0 Filter_TYPE_NO Filter_Type = 1 Filter_TYPE_RESOURCE_ID Filter_Type = 2 Filter_TYPE_OWNER Filter_Type = 3 Filter_TYPE_CREATOR Filter_Type = 4 Filter_TYPE_GRANTEE_TYPE Filter_Type = 5 Filter_TYPE_EXCLUDE_DENIALS Filter_Type = 6 Filter_TYPE_SPACE_ID Filter_Type = 7 Filter_TYPE_STATE Filter_Type = 8 )
func (Filter_Type) Descriptor ¶
func (Filter_Type) Descriptor() protoreflect.EnumDescriptor
func (Filter_Type) Enum ¶
func (x Filter_Type) Enum() *Filter_Type
func (Filter_Type) EnumDescriptor
deprecated
func (Filter_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Filter_Type.Descriptor instead.
func (Filter_Type) Number ¶
func (x Filter_Type) Number() protoreflect.EnumNumber
func (Filter_Type) String ¶
func (x Filter_Type) String() string
func (Filter_Type) Type ¶
func (Filter_Type) Type() protoreflect.EnumType
type GetReceivedShareRequest ¶
type GetReceivedShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The reference of the received share. Ref *ShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"` // contains filtered or unexported fields }
func (*GetReceivedShareRequest) Descriptor
deprecated
func (*GetReceivedShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetReceivedShareRequest.ProtoReflect.Descriptor instead.
func (*GetReceivedShareRequest) GetOpaque ¶
func (x *GetReceivedShareRequest) GetOpaque() *v1beta1.Opaque
func (*GetReceivedShareRequest) GetRef ¶
func (x *GetReceivedShareRequest) GetRef() *ShareReference
func (*GetReceivedShareRequest) ProtoMessage ¶
func (*GetReceivedShareRequest) ProtoMessage()
func (*GetReceivedShareRequest) ProtoReflect ¶
func (x *GetReceivedShareRequest) ProtoReflect() protoreflect.Message
func (*GetReceivedShareRequest) Reset ¶
func (x *GetReceivedShareRequest) Reset()
func (*GetReceivedShareRequest) String ¶
func (x *GetReceivedShareRequest) String() string
type GetReceivedShareResponse ¶
type GetReceivedShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The share. Share *ReceivedShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*GetReceivedShareResponse) Descriptor
deprecated
func (*GetReceivedShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetReceivedShareResponse.ProtoReflect.Descriptor instead.
func (*GetReceivedShareResponse) GetOpaque ¶
func (x *GetReceivedShareResponse) GetOpaque() *v1beta1.Opaque
func (*GetReceivedShareResponse) GetShare ¶
func (x *GetReceivedShareResponse) GetShare() *ReceivedShare
func (*GetReceivedShareResponse) GetStatus ¶
func (x *GetReceivedShareResponse) GetStatus() *v1beta12.Status
func (*GetReceivedShareResponse) ProtoMessage ¶
func (*GetReceivedShareResponse) ProtoMessage()
func (*GetReceivedShareResponse) ProtoReflect ¶
func (x *GetReceivedShareResponse) ProtoReflect() protoreflect.Message
func (*GetReceivedShareResponse) Reset ¶
func (x *GetReceivedShareResponse) Reset()
func (*GetReceivedShareResponse) String ¶
func (x *GetReceivedShareResponse) String() string
type GetShareRequest ¶
type GetShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The reference to which the action should be performed. Ref *ShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"` // contains filtered or unexported fields }
func (*GetShareRequest) Descriptor
deprecated
func (*GetShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetShareRequest.ProtoReflect.Descriptor instead.
func (*GetShareRequest) GetOpaque ¶
func (x *GetShareRequest) GetOpaque() *v1beta1.Opaque
func (*GetShareRequest) GetRef ¶
func (x *GetShareRequest) GetRef() *ShareReference
func (*GetShareRequest) ProtoMessage ¶
func (*GetShareRequest) ProtoMessage()
func (*GetShareRequest) ProtoReflect ¶
func (x *GetShareRequest) ProtoReflect() protoreflect.Message
func (*GetShareRequest) Reset ¶
func (x *GetShareRequest) Reset()
func (*GetShareRequest) String ¶
func (x *GetShareRequest) String() string
type GetShareResponse ¶
type GetShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The share. Share *Share `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*GetShareResponse) Descriptor
deprecated
func (*GetShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetShareResponse.ProtoReflect.Descriptor instead.
func (*GetShareResponse) GetOpaque ¶
func (x *GetShareResponse) GetOpaque() *v1beta1.Opaque
func (*GetShareResponse) GetShare ¶
func (x *GetShareResponse) GetShare() *Share
func (*GetShareResponse) GetStatus ¶
func (x *GetShareResponse) GetStatus() *v1beta12.Status
func (*GetShareResponse) ProtoMessage ¶
func (*GetShareResponse) ProtoMessage()
func (*GetShareResponse) ProtoReflect ¶
func (x *GetShareResponse) ProtoReflect() protoreflect.Message
func (*GetShareResponse) Reset ¶
func (x *GetShareResponse) Reset()
func (*GetShareResponse) String ¶
func (x *GetShareResponse) String() string
type ListReceivedSharesRequest ¶
type ListReceivedSharesRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The list of filters to apply if any. Filters []*Filter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"` // 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 PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // The client uses this field to request a specific page of the list results. PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
func (*ListReceivedSharesRequest) Descriptor
deprecated
func (*ListReceivedSharesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListReceivedSharesRequest.ProtoReflect.Descriptor instead.
func (*ListReceivedSharesRequest) GetFilters ¶
func (x *ListReceivedSharesRequest) GetFilters() []*Filter
func (*ListReceivedSharesRequest) GetOpaque ¶
func (x *ListReceivedSharesRequest) GetOpaque() *v1beta1.Opaque
func (*ListReceivedSharesRequest) GetPageSize ¶
func (x *ListReceivedSharesRequest) GetPageSize() int32
func (*ListReceivedSharesRequest) GetPageToken ¶
func (x *ListReceivedSharesRequest) GetPageToken() string
func (*ListReceivedSharesRequest) ProtoMessage ¶
func (*ListReceivedSharesRequest) ProtoMessage()
func (*ListReceivedSharesRequest) ProtoReflect ¶
func (x *ListReceivedSharesRequest) ProtoReflect() protoreflect.Message
func (*ListReceivedSharesRequest) Reset ¶
func (x *ListReceivedSharesRequest) Reset()
func (*ListReceivedSharesRequest) String ¶
func (x *ListReceivedSharesRequest) String() string
type ListReceivedSharesResponse ¶
type ListReceivedSharesResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The list of received shares. Shares []*ReceivedShare `protobuf:"bytes,3,rep,name=shares,proto3" json:"shares,omitempty"` // 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 NextPageToken string `protobuf:"bytes,4,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListReceivedSharesResponse) Descriptor
deprecated
func (*ListReceivedSharesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListReceivedSharesResponse.ProtoReflect.Descriptor instead.
func (*ListReceivedSharesResponse) GetNextPageToken ¶
func (x *ListReceivedSharesResponse) GetNextPageToken() string
func (*ListReceivedSharesResponse) GetOpaque ¶
func (x *ListReceivedSharesResponse) GetOpaque() *v1beta1.Opaque
func (*ListReceivedSharesResponse) GetShares ¶
func (x *ListReceivedSharesResponse) GetShares() []*ReceivedShare
func (*ListReceivedSharesResponse) GetStatus ¶
func (x *ListReceivedSharesResponse) GetStatus() *v1beta12.Status
func (*ListReceivedSharesResponse) ProtoMessage ¶
func (*ListReceivedSharesResponse) ProtoMessage()
func (*ListReceivedSharesResponse) ProtoReflect ¶
func (x *ListReceivedSharesResponse) ProtoReflect() protoreflect.Message
func (*ListReceivedSharesResponse) Reset ¶
func (x *ListReceivedSharesResponse) Reset()
func (*ListReceivedSharesResponse) String ¶
func (x *ListReceivedSharesResponse) String() string
type ListSharesRequest ¶
type ListSharesRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The list of filters to apply if any. Filters []*Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"` // 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 PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // The client uses this field to request a specific page of the list results. PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
func (*ListSharesRequest) Descriptor
deprecated
func (*ListSharesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSharesRequest.ProtoReflect.Descriptor instead.
func (*ListSharesRequest) GetFilters ¶
func (x *ListSharesRequest) GetFilters() []*Filter
func (*ListSharesRequest) GetOpaque ¶
func (x *ListSharesRequest) GetOpaque() *v1beta1.Opaque
func (*ListSharesRequest) GetPageSize ¶
func (x *ListSharesRequest) GetPageSize() int32
func (*ListSharesRequest) GetPageToken ¶
func (x *ListSharesRequest) GetPageToken() string
func (*ListSharesRequest) ProtoMessage ¶
func (*ListSharesRequest) ProtoMessage()
func (*ListSharesRequest) ProtoReflect ¶
func (x *ListSharesRequest) ProtoReflect() protoreflect.Message
func (*ListSharesRequest) Reset ¶
func (x *ListSharesRequest) Reset()
func (*ListSharesRequest) String ¶
func (x *ListSharesRequest) String() string
type ListSharesResponse ¶
type ListSharesResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The list of shares. Shares []*Share `protobuf:"bytes,3,rep,name=shares,proto3" json:"shares,omitempty"` // 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 NextPageToken string `protobuf:"bytes,4,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListSharesResponse) Descriptor
deprecated
func (*ListSharesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSharesResponse.ProtoReflect.Descriptor instead.
func (*ListSharesResponse) GetNextPageToken ¶
func (x *ListSharesResponse) GetNextPageToken() string
func (*ListSharesResponse) GetOpaque ¶
func (x *ListSharesResponse) GetOpaque() *v1beta1.Opaque
func (*ListSharesResponse) GetShares ¶
func (x *ListSharesResponse) GetShares() []*Share
func (*ListSharesResponse) GetStatus ¶
func (x *ListSharesResponse) GetStatus() *v1beta12.Status
func (*ListSharesResponse) ProtoMessage ¶
func (*ListSharesResponse) ProtoMessage()
func (*ListSharesResponse) ProtoReflect ¶
func (x *ListSharesResponse) ProtoReflect() protoreflect.Message
func (*ListSharesResponse) Reset ¶
func (x *ListSharesResponse) Reset()
func (*ListSharesResponse) String ¶
func (x *ListSharesResponse) String() string
type ReceivedShare ¶
type ReceivedShare struct { Share `protobuf:"bytes,1,opt,name=share,proto3" json:"share,omitempty"` // The state of the share. State ShareState `protobuf:"varint,2,opt,name=state,proto3,enum=cs3.sharing.collaboration.v1beta1.ShareState" json:"state,omitempty"` // The mount point of the share. MountPoint *v1beta1.Reference `protobuf:"bytes,3,opt,name=mount_point,json=mountPoint,proto3" json:"mount_point,omitempty"` // Hide share, default false Hidden bool `protobuf:"varint,4,opt,name=hidden,proto3" json:"hidden,omitempty"` // contains filtered or unexported fields }Share *
A received share is the share that a grantee will receive. It expands the original share by adding state to the share, a display name from the perspective of the grantee and a resource mount point in case the share will be mounted in a storage provider.
func (*ReceivedShare) Descriptor
deprecated
func (*ReceivedShare) Descriptor() ([]byte, []int)
Deprecated: Use ReceivedShare.ProtoReflect.Descriptor instead.
func (*ReceivedShare) GetHidden ¶
func (x *ReceivedShare) GetHidden() bool
func (*ReceivedShare) GetMountPoint ¶
func (x *ReceivedShare) GetMountPoint() *v1beta1.Reference
func (*ReceivedShare) GetShare ¶
func (x *ReceivedShare) GetShare() *Share
func (*ReceivedShare) GetState ¶
func (x *ReceivedShare) GetState() ShareState
func (*ReceivedShare) ProtoMessage ¶
func (*ReceivedShare) ProtoMessage()
func (*ReceivedShare) ProtoReflect ¶
func (x *ReceivedShare) ProtoReflect() protoreflect.Message
func (*ReceivedShare) Reset ¶
func (x *ReceivedShare) Reset()
func (*ReceivedShare) String ¶
func (x *ReceivedShare) String() string
type RemoveShareRequest ¶
type RemoveShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The reference to which the action should be performed. Ref *ShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"` // contains filtered or unexported fields }
func (*RemoveShareRequest) Descriptor
deprecated
func (*RemoveShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use RemoveShareRequest.ProtoReflect.Descriptor instead.
func (*RemoveShareRequest) GetOpaque ¶
func (x *RemoveShareRequest) GetOpaque() *v1beta1.Opaque
func (*RemoveShareRequest) GetRef ¶
func (x *RemoveShareRequest) GetRef() *ShareReference
func (*RemoveShareRequest) ProtoMessage ¶
func (*RemoveShareRequest) ProtoMessage()
func (*RemoveShareRequest) ProtoReflect ¶
func (x *RemoveShareRequest) ProtoReflect() protoreflect.Message
func (*RemoveShareRequest) Reset ¶
func (x *RemoveShareRequest) Reset()
func (*RemoveShareRequest) String ¶
func (x *RemoveShareRequest) String() string
type RemoveShareResponse ¶
type RemoveShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // contains filtered or unexported fields }
func (*RemoveShareResponse) Descriptor
deprecated
func (*RemoveShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use RemoveShareResponse.ProtoReflect.Descriptor instead.
func (*RemoveShareResponse) GetOpaque ¶
func (x *RemoveShareResponse) GetOpaque() *v1beta1.Opaque
func (*RemoveShareResponse) GetStatus ¶
func (x *RemoveShareResponse) GetStatus() *v1beta12.Status
func (*RemoveShareResponse) ProtoMessage ¶
func (*RemoveShareResponse) ProtoMessage()
func (*RemoveShareResponse) ProtoReflect ¶
func (x *RemoveShareResponse) ProtoReflect() protoreflect.Message
func (*RemoveShareResponse) Reset ¶
func (x *RemoveShareResponse) Reset()
func (*RemoveShareResponse) String ¶
func (x *RemoveShareResponse) String() string
type Share ¶
type Share struct { // Opaque unique identifier of the share. Id *ShareId `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Unique identifier of the shared resource. ResourceId *v1beta1.ResourceId `protobuf:"bytes,2,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"` // Permissions for the grantee to use // the resource. Permissions *SharePermissions `protobuf:"bytes,3,opt,name=permissions,proto3" json:"permissions,omitempty"` // The receiver of the share, like a user, group ... Grantee *v1beta1.Grantee `protobuf:"bytes,4,opt,name=grantee,proto3" json:"grantee,omitempty"` // Uniquely identifies the owner of the share // (the resource owner at the time of creating the share). // In case the ownership of the underlying resource changes // the share owner field MAY change to reflect the change of ownsership. Owner *v1beta11.UserId `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"` // Uniquely identifies a principal who initiates the share creation. // A creator can create shares on behalf of the owner (because of re-sharing, // because belonging to special groups, ...). // Creator and owner often result in being the same principal. Creator *v1beta11.UserId `protobuf:"bytes,6,opt,name=creator,proto3" json:"creator,omitempty"` // Creation time of the share. Ctime *v1beta12.Timestamp `protobuf:"bytes,7,opt,name=ctime,proto3" json:"ctime,omitempty"` // Last modification time of the share. Mtime *v1beta12.Timestamp `protobuf:"bytes,8,opt,name=mtime,proto3" json:"mtime,omitempty"` // The expiration time of the share. Expiration *v1beta12.Timestamp `protobuf:"bytes,9,opt,name=expiration,proto3" json:"expiration,omitempty"` // contains filtered or unexported fields }
Shares are relationships between a resource owner (usually the authenticated user) who grants permissions to a recipient (grantee) on a specified resource (resource_id). UserShares represents both user and groups.
func (*Share) Descriptor
deprecated
func (*Share) GetCreator ¶
func (*Share) GetExpiration ¶
func (*Share) GetGrantee ¶
func (*Share) GetPermissions ¶
func (x *Share) GetPermissions() *SharePermissions
func (*Share) GetResourceId ¶
func (x *Share) GetResourceId() *v1beta1.ResourceId
func (*Share) ProtoMessage ¶
func (*Share) ProtoMessage()
func (*Share) ProtoReflect ¶
func (x *Share) ProtoReflect() protoreflect.Message
type ShareGrant ¶
type ShareGrant struct { // The grantee of the grant. Grantee *v1beta1.Grantee `protobuf:"bytes,1,opt,name=grantee,proto3" json:"grantee,omitempty"` // The share permissions for the grant. Permissions *SharePermissions `protobuf:"bytes,2,opt,name=permissions,proto3" json:"permissions,omitempty"` // Expiration of the grant. Expiration *v1beta12.Timestamp `protobuf:"bytes,3,opt,name=expiration,proto3" json:"expiration,omitempty"` // contains filtered or unexported fields }
A share grant specifies the share permissions for a grantee.
func (*ShareGrant) Descriptor
deprecated
func (*ShareGrant) Descriptor() ([]byte, []int)
Deprecated: Use ShareGrant.ProtoReflect.Descriptor instead.
func (*ShareGrant) GetExpiration ¶
func (x *ShareGrant) GetExpiration() *v1beta12.Timestamp
func (*ShareGrant) GetGrantee ¶
func (x *ShareGrant) GetGrantee() *v1beta1.Grantee
func (*ShareGrant) GetPermissions ¶
func (x *ShareGrant) GetPermissions() *SharePermissions
func (*ShareGrant) ProtoMessage ¶
func (*ShareGrant) ProtoMessage()
func (*ShareGrant) ProtoReflect ¶
func (x *ShareGrant) ProtoReflect() protoreflect.Message
func (*ShareGrant) Reset ¶
func (x *ShareGrant) Reset()
func (*ShareGrant) String ¶
func (x *ShareGrant) String() string
type ShareId ¶
type ShareId struct { // The internal id used by service implementor to // uniquely Collaboration the share in the internal // implementation of the service. OpaqueId string `protobuf:"bytes,2,opt,name=opaque_id,json=opaqueId,proto3" json:"opaque_id,omitempty"` // contains filtered or unexported fields }
A share id identifies uniquely a // share in the share provider namespace. A ShareId MUST be unique inside the share provider.
func (*ShareId) Descriptor
deprecated
func (*ShareId) GetOpaqueId ¶
func (*ShareId) ProtoMessage ¶
func (*ShareId) ProtoMessage()
func (*ShareId) ProtoReflect ¶
func (x *ShareId) ProtoReflect() protoreflect.Message
type ShareKey ¶
type ShareKey struct { v1beta11.UserId `protobuf:"bytes,2,opt,name=owner,proto3" json:"owner,omitempty"` ResourceId *v1beta1.ResourceId `protobuf:"bytes,3,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"` Grantee *v1beta1.Grantee `protobuf:"bytes,4,opt,name=grantee,proto3" json:"grantee,omitempty"` // contains filtered or unexported fields }Owner *
Uniquely identifies a share in the share provider. A share MUST be uniquely identify by four (4) elements: 1) The share provider id 2) The owner of the share 3) The resource id 4) The grantee for the share This 4-tuple MUST be unique. For example, owner Alice shares the resource /home/docs with id home:1234 to an user named Bob. The 4-tuple will consist of 1) The share provider id = "user" 2) The owner of the share = "Alice" 3) The resource id = "home:1234" 4) The grantee for the share = Grantee("type" = "user", "" => "Bob")
func (*ShareKey) Descriptor
deprecated
func (*ShareKey) GetGrantee ¶
func (*ShareKey) GetResourceId ¶
func (x *ShareKey) GetResourceId() *v1beta1.ResourceId
func (*ShareKey) ProtoMessage ¶
func (*ShareKey) ProtoMessage()
func (*ShareKey) ProtoReflect ¶
func (x *ShareKey) ProtoReflect() protoreflect.Message
type SharePermissions ¶
type SharePermissions struct { // contains filtered or unexported fields }
The permissions for a share.
func (*SharePermissions) Descriptor
deprecated
func (*SharePermissions) Descriptor() ([]byte, []int)
Deprecated: Use SharePermissions.ProtoReflect.Descriptor instead.
func (*SharePermissions) GetPermissions ¶
func (x *SharePermissions) GetPermissions() *v1beta1.ResourcePermissions
func (*SharePermissions) ProtoMessage ¶
func (*SharePermissions) ProtoMessage()
func (*SharePermissions) ProtoReflect ¶
func (x *SharePermissions) ProtoReflect() protoreflect.Message
func (*SharePermissions) Reset ¶
func (x *SharePermissions) Reset()
func (*SharePermissions) String ¶
func (x *SharePermissions) String() string
type ShareReference ¶
type ShareReference struct { // One of the specifications MUST be specified. // // Types that are assignable to Spec: // // *ShareReference_Id // *ShareReference_Key Spec isShareReference_Spec `protobuf_oneof:"spec"` // contains filtered or unexported fields }
The mechanism to identify a share in the share provider namespace.
func (*ShareReference) Descriptor
deprecated
func (*ShareReference) Descriptor() ([]byte, []int)
Deprecated: Use ShareReference.ProtoReflect.Descriptor instead.
func (*ShareReference) GetId ¶
func (x *ShareReference) GetId() *ShareId
func (*ShareReference) GetKey ¶
func (x *ShareReference) GetKey() *ShareKey
func (*ShareReference) GetSpec ¶
func (m *ShareReference) GetSpec() isShareReference_Spec
func (*ShareReference) ProtoMessage ¶
func (*ShareReference) ProtoMessage()
func (*ShareReference) ProtoReflect ¶
func (x *ShareReference) ProtoReflect() protoreflect.Message
func (*ShareReference) Reset ¶
func (x *ShareReference) Reset()
func (*ShareReference) String ¶
func (x *ShareReference) String() string
type ShareReference_Id ¶
type ShareReference_Id struct { ShareId `protobuf:"bytes,1,opt,name=id,proto3,oneof"` }Id *
type ShareReference_Key ¶
type ShareReference_Key struct { // make the share unique. Key *ShareKey `protobuf:"bytes,2,opt,name=key,proto3,oneof"` }
type ShareState ¶
type ShareState int32
The state of the share.
const ( ShareState = 0 // This state means the share is pending to be accepted or rejected // by the recipient of the share. ShareState_SHARE_STATE_PENDING ShareState = 1 ShareState_SHARE_STATE_ACCEPTED ShareState = 2 // Do not means the share is removed, the recipient MAY // change the state to accepted or pending. ShareState_SHARE_STATE_REJECTED ShareState = 3 )ShareState_SHARE_STATE_INVALID
func (ShareState) Descriptor ¶
func (ShareState) Descriptor() protoreflect.EnumDescriptor
func (ShareState) Enum ¶
func (x ShareState) Enum() *ShareState
func (ShareState) EnumDescriptor
deprecated
func (ShareState) EnumDescriptor() ([]byte, []int)
Deprecated: Use ShareState.Descriptor instead.
func (ShareState) Number ¶
func (x ShareState) Number() protoreflect.EnumNumber
func (ShareState) String ¶
func (x ShareState) String() string
func (ShareState) Type ¶
func (ShareState) Type() protoreflect.EnumType
type UnimplementedCollaborationAPIServer ¶
type UnimplementedCollaborationAPIServer struct { }
UnimplementedCollaborationAPIServer should be embedded to have forward compatible implementations.
func (UnimplementedCollaborationAPIServer) CreateShare ¶
func (UnimplementedCollaborationAPIServer) CreateShare(context.Context, *CreateShareRequest) (*CreateShareResponse, error)
func (UnimplementedCollaborationAPIServer) GetReceivedShare ¶
func (UnimplementedCollaborationAPIServer) GetReceivedShare(context.Context, *GetReceivedShareRequest) (*GetReceivedShareResponse, error)
func (UnimplementedCollaborationAPIServer) GetShare ¶
func (UnimplementedCollaborationAPIServer) GetShare(context.Context, *GetShareRequest) (*GetShareResponse, error)
func (UnimplementedCollaborationAPIServer) ListReceivedShares ¶
func (UnimplementedCollaborationAPIServer) ListReceivedShares(context.Context, *ListReceivedSharesRequest) (*ListReceivedSharesResponse, error)
func (UnimplementedCollaborationAPIServer) ListShares ¶
func (UnimplementedCollaborationAPIServer) ListShares(context.Context, *ListSharesRequest) (*ListSharesResponse, error)
func (UnimplementedCollaborationAPIServer) RemoveShare ¶
func (UnimplementedCollaborationAPIServer) RemoveShare(context.Context, *RemoveShareRequest) (*RemoveShareResponse, error)
func (UnimplementedCollaborationAPIServer) UpdateReceivedShare ¶
func (UnimplementedCollaborationAPIServer) UpdateReceivedShare(context.Context, *UpdateReceivedShareRequest) (*UpdateReceivedShareResponse, error)
func (UnimplementedCollaborationAPIServer) UpdateShare ¶
func (UnimplementedCollaborationAPIServer) UpdateShare(context.Context, *UpdateShareRequest) (*UpdateShareResponse, error)
type UnsafeCollaborationAPIServer ¶
type UnsafeCollaborationAPIServer interface {
// contains filtered or unexported methods
}
UnsafeCollaborationAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CollaborationAPIServer will result in compilation errors.
type UpdateReceivedShareRequest ¶
type UpdateReceivedShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // The received share to update. Share *ReceivedShare `protobuf:"bytes,2,opt,name=share,proto3" json:"share,omitempty"` // see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // contains filtered or unexported fields }
TODO(labkode): clean up display_name ? we'll use storage links for that.
func (*UpdateReceivedShareRequest) Descriptor
deprecated
func (*UpdateReceivedShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateReceivedShareRequest.ProtoReflect.Descriptor instead.
func (*UpdateReceivedShareRequest) GetOpaque ¶
func (x *UpdateReceivedShareRequest) GetOpaque() *v1beta1.Opaque
func (*UpdateReceivedShareRequest) GetShare ¶
func (x *UpdateReceivedShareRequest) GetShare() *ReceivedShare
func (*UpdateReceivedShareRequest) GetUpdateMask ¶
func (x *UpdateReceivedShareRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateReceivedShareRequest) ProtoMessage ¶
func (*UpdateReceivedShareRequest) ProtoMessage()
func (*UpdateReceivedShareRequest) ProtoReflect ¶
func (x *UpdateReceivedShareRequest) ProtoReflect() protoreflect.Message
func (*UpdateReceivedShareRequest) Reset ¶
func (x *UpdateReceivedShareRequest) Reset()
func (*UpdateReceivedShareRequest) String ¶
func (x *UpdateReceivedShareRequest) String() string
type UpdateReceivedShareResponse ¶
type UpdateReceivedShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The updated share. Share *ReceivedShare `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*UpdateReceivedShareResponse) Descriptor
deprecated
func (*UpdateReceivedShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateReceivedShareResponse.ProtoReflect.Descriptor instead.
func (*UpdateReceivedShareResponse) GetOpaque ¶
func (x *UpdateReceivedShareResponse) GetOpaque() *v1beta1.Opaque
func (*UpdateReceivedShareResponse) GetShare ¶
func (x *UpdateReceivedShareResponse) GetShare() *ReceivedShare
func (*UpdateReceivedShareResponse) GetStatus ¶
func (x *UpdateReceivedShareResponse) GetStatus() *v1beta12.Status
func (*UpdateReceivedShareResponse) ProtoMessage ¶
func (*UpdateReceivedShareResponse) ProtoMessage()
func (*UpdateReceivedShareResponse) ProtoReflect ¶
func (x *UpdateReceivedShareResponse) ProtoReflect() protoreflect.Message
func (*UpdateReceivedShareResponse) Reset ¶
func (x *UpdateReceivedShareResponse) Reset()
func (*UpdateReceivedShareResponse) String ¶
func (x *UpdateReceivedShareResponse) String() string
type UpdateShareRequest ¶
type UpdateShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // Deprecated use the share and update_mask attribute. Ref *ShareReference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"` // Deprecated use the share and update_mask attribute. Field *UpdateShareRequest_UpdateField `protobuf:"bytes,3,opt,name=field,proto3" json:"field,omitempty"` // see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"` // The share containing the new data Share *Share `protobuf:"bytes,5,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*UpdateShareRequest) Descriptor
deprecated
func (*UpdateShareRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShareRequest.ProtoReflect.Descriptor instead.
func (*UpdateShareRequest) GetField ¶
func (x *UpdateShareRequest) GetField() *UpdateShareRequest_UpdateField
func (*UpdateShareRequest) GetOpaque ¶
func (x *UpdateShareRequest) GetOpaque() *v1beta1.Opaque
func (*UpdateShareRequest) GetRef ¶
func (x *UpdateShareRequest) GetRef() *ShareReference
func (*UpdateShareRequest) GetShare ¶
func (x *UpdateShareRequest) GetShare() *Share
func (*UpdateShareRequest) GetUpdateMask ¶
func (x *UpdateShareRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateShareRequest) ProtoMessage ¶
func (*UpdateShareRequest) ProtoMessage()
func (*UpdateShareRequest) ProtoReflect ¶
func (x *UpdateShareRequest) ProtoReflect() protoreflect.Message
func (*UpdateShareRequest) Reset ¶
func (x *UpdateShareRequest) Reset()
func (*UpdateShareRequest) String ¶
func (x *UpdateShareRequest) String() string
type UpdateShareRequest_UpdateField ¶
type UpdateShareRequest_UpdateField struct { // // Types that are assignable to Field: // // *UpdateShareRequest_UpdateField_Permissions // *UpdateShareRequest_UpdateField_DisplayName Field isUpdateShareRequest_UpdateField_Field `protobuf_oneof:"field"` // contains filtered or unexported fields }
REQUIRED.
func (*UpdateShareRequest_UpdateField) Descriptor
deprecated
func (*UpdateShareRequest_UpdateField) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShareRequest_UpdateField.ProtoReflect.Descriptor instead.
func (*UpdateShareRequest_UpdateField) GetDisplayName ¶
func (x *UpdateShareRequest_UpdateField) GetDisplayName() string
func (*UpdateShareRequest_UpdateField) GetField ¶
func (m *UpdateShareRequest_UpdateField) GetField() isUpdateShareRequest_UpdateField_Field
func (*UpdateShareRequest_UpdateField) GetPermissions ¶
func (x *UpdateShareRequest_UpdateField) GetPermissions() *SharePermissions
func (*UpdateShareRequest_UpdateField) ProtoMessage ¶
func (*UpdateShareRequest_UpdateField) ProtoMessage()
func (*UpdateShareRequest_UpdateField) ProtoReflect ¶
func (x *UpdateShareRequest_UpdateField) ProtoReflect() protoreflect.Message
func (*UpdateShareRequest_UpdateField) Reset ¶
func (x *UpdateShareRequest_UpdateField) Reset()
func (*UpdateShareRequest_UpdateField) String ¶
func (x *UpdateShareRequest_UpdateField) String() string
type UpdateShareRequest_UpdateField_DisplayName ¶
type UpdateShareRequest_UpdateField_DisplayName struct { string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3,oneof"` }DisplayName
type UpdateShareRequest_UpdateField_Permissions ¶
type UpdateShareRequest_UpdateField_Permissions struct { SharePermissions `protobuf:"bytes,2,opt,name=permissions,proto3,oneof"` }Permissions *
type UpdateShareResponse ¶
type UpdateShareResponse struct { // The response status. Status *v1beta12.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"` // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // The updated share. Share *Share `protobuf:"bytes,3,opt,name=share,proto3" json:"share,omitempty"` // contains filtered or unexported fields }
func (*UpdateShareResponse) Descriptor
deprecated
func (*UpdateShareResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateShareResponse.ProtoReflect.Descriptor instead.
func (*UpdateShareResponse) GetOpaque ¶
func (x *UpdateShareResponse) GetOpaque() *v1beta1.Opaque
func (*UpdateShareResponse) GetShare ¶
func (x *UpdateShareResponse) GetShare() *Share
func (*UpdateShareResponse) GetStatus ¶
func (x *UpdateShareResponse) GetStatus() *v1beta12.Status
func (*UpdateShareResponse) ProtoMessage ¶
func (*UpdateShareResponse) ProtoMessage()
func (*UpdateShareResponse) ProtoReflect ¶
func (x *UpdateShareResponse) ProtoReflect() protoreflect.Message
func (*UpdateShareResponse) Reset ¶
func (x *UpdateShareResponse) Reset()
func (*UpdateShareResponse) String ¶
func (x *UpdateShareResponse) String() string