corev1beta1

package
v0.0.0-...-3ad35d1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 5, 2024 License: Apache-2.0 Imports: 13 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	OcmCoreAPI_CreateOCMCoreShare_FullMethodName = "/cs3.ocm.core.v1beta1.OcmCoreAPI/CreateOCMCoreShare"
	OcmCoreAPI_UpdateOCMCoreShare_FullMethodName = "/cs3.ocm.core.v1beta1.OcmCoreAPI/UpdateOCMCoreShare"
	OcmCoreAPI_DeleteOCMCoreShare_FullMethodName = "/cs3.ocm.core.v1beta1.OcmCoreAPI/DeleteOCMCoreShare"
)

Variables

View Source 
var File_cs3_ocm_core_v1beta1_ocm_core_api_proto protoreflect.FileDescriptor
View Source 
var OcmCoreAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.ocm.core.v1beta1.OcmCoreAPI",
	HandlerType: (*OcmCoreAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateOCMCoreShare",
			Handler:    _OcmCoreAPI_CreateOCMCoreShare_Handler,
		},
		{
			MethodName: "UpdateOCMCoreShare",
			Handler:    _OcmCoreAPI_UpdateOCMCoreShare_Handler,
		},
		{
			MethodName: "DeleteOCMCoreShare",
			Handler:    _OcmCoreAPI_DeleteOCMCoreShare_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/ocm/core/v1beta1/ocm_core_api.proto",
}

OcmCoreAPI_ServiceDesc is the grpc.ServiceDesc for OcmCoreAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterOcmCoreAPIServer 

func RegisterOcmCoreAPIServer(s grpc.ServiceRegistrar, srv OcmCoreAPIServer)

Types

type CreateOCMCoreShareRequest 

type CreateOCMCoreShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// OPTIONAL.
	// Description for the share.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED.
	// Name of the resource (file or folder).
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED.
	// Identifier to identify the resource at the provider side. This is unique per provider.
	ResourceId string `protobuf:"bytes,4,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// REQUIRED.
	// Provider specific identifier of the owner of the resource.
	Owner *v1beta11.UserId `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"`
	// REQUIRED.
	// Provider specific identifier of the user that wants to share the resource.
	Sender *v1beta11.UserId `protobuf:"bytes,6,opt,name=sender,proto3" json:"sender,omitempty"`
	// REQUIRED.
	// Consumer specific identifier of the user or group the provider wants to share the resource with.
	// This is known in advance, for example using the OCM invitation flow.
	// Please note that the consumer service endpoint is known in advance as well, so this is no part of the request body.
	// TODO: this field needs to represent either a user or group in the future, not only a user.
	ShareWith *v1beta11.UserId `protobuf:"bytes,7,opt,name=share_with,json=shareWith,proto3" json:"share_with,omitempty"`
	// REQUIRED.
	// Resource type.
	ResourceType v1beta12.ResourceType `` /* 145-byte string literal not displayed */
	// REQUIRED.
	// Recipient share type.
	ShareType v1beta13.ShareType `` /* 128-byte string literal not displayed */
	// OPTIONAL.
	// The expiration time for the OCM share.
	Expiration *v1beta1.Timestamp `protobuf:"bytes,10,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// REQUIRED.
	// The protocols which are used to establish synchronisation,
	// with their access rights.
	// See also cs3/sharing/ocm/v1beta1/resources.proto for how to map
	// this to the OCM share payload.
	Protocols []*v1beta13.Protocol `protobuf:"bytes,11,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOCMCoreShareRequest) Descriptor deprecated 

func (*CreateOCMCoreShareRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateOCMCoreShareRequest.ProtoReflect.Descriptor instead.

func (*CreateOCMCoreShareRequest) GetDescription 

func (x *CreateOCMCoreShareRequest) GetDescription() string

func (*CreateOCMCoreShareRequest) GetExpiration 

func (x *CreateOCMCoreShareRequest) GetExpiration() *v1beta1.Timestamp

func (*CreateOCMCoreShareRequest) GetName 

func (x *CreateOCMCoreShareRequest) GetName() string

func (*CreateOCMCoreShareRequest) GetOpaque 

func (x *CreateOCMCoreShareRequest) GetOpaque() *v1beta1.Opaque

func (*CreateOCMCoreShareRequest) GetOwner 

func (x *CreateOCMCoreShareRequest) GetOwner() *v1beta11.UserId

func (*CreateOCMCoreShareRequest) GetProtocols 

func (x *CreateOCMCoreShareRequest) GetProtocols() []*v1beta13.Protocol

func (*CreateOCMCoreShareRequest) GetResourceId 

func (x *CreateOCMCoreShareRequest) GetResourceId() string

func (*CreateOCMCoreShareRequest) GetResourceType 

func (x *CreateOCMCoreShareRequest) GetResourceType() v1beta12.ResourceType

func (*CreateOCMCoreShareRequest) GetSender 

func (x *CreateOCMCoreShareRequest) GetSender() *v1beta11.UserId

func (*CreateOCMCoreShareRequest) GetShareType 

func (x *CreateOCMCoreShareRequest) GetShareType() v1beta13.ShareType

func (*CreateOCMCoreShareRequest) GetShareWith 

func (x *CreateOCMCoreShareRequest) GetShareWith() *v1beta11.UserId

func (*CreateOCMCoreShareRequest) ProtoMessage 

func (*CreateOCMCoreShareRequest) ProtoMessage()

func (*CreateOCMCoreShareRequest) ProtoReflect 

func (x *CreateOCMCoreShareRequest) ProtoReflect() protoreflect.Message

func (*CreateOCMCoreShareRequest) Reset 

func (x *CreateOCMCoreShareRequest) Reset()

func (*CreateOCMCoreShareRequest) String 

func (x *CreateOCMCoreShareRequest) String() string

type CreateOCMCoreShareResponse 

type CreateOCMCoreShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta14.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// Unique ID to identify the share at the consumer side.
	Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"`
	// REQUIRED.
	Created *v1beta1.Timestamp `protobuf:"bytes,4,opt,name=created,proto3" json:"created,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateOCMCoreShareResponse) Descriptor deprecated 

func (*CreateOCMCoreShareResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateOCMCoreShareResponse.ProtoReflect.Descriptor instead.

func (*CreateOCMCoreShareResponse) GetCreated 

func (x *CreateOCMCoreShareResponse) GetCreated() *v1beta1.Timestamp

func (*CreateOCMCoreShareResponse) GetId 

func (x *CreateOCMCoreShareResponse) GetId() string

func (*CreateOCMCoreShareResponse) GetOpaque 

func (x *CreateOCMCoreShareResponse) GetOpaque() *v1beta1.Opaque

func (*CreateOCMCoreShareResponse) GetStatus 

func (x *CreateOCMCoreShareResponse) GetStatus() *v1beta14.Status

func (*CreateOCMCoreShareResponse) ProtoMessage 

func (*CreateOCMCoreShareResponse) ProtoMessage()

func (*CreateOCMCoreShareResponse) ProtoReflect 

func (x *CreateOCMCoreShareResponse) ProtoReflect() protoreflect.Message

func (*CreateOCMCoreShareResponse) Reset 

func (x *CreateOCMCoreShareResponse) Reset()

func (*CreateOCMCoreShareResponse) String 

func (x *CreateOCMCoreShareResponse) String() string

type DeleteOCMCoreShareRequest 

type DeleteOCMCoreShareRequest struct {

	// REQUIRED.
	// Unique ID to identify the share at the consumer side.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteOCMCoreShareRequest) Descriptor deprecated 

func (*DeleteOCMCoreShareRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteOCMCoreShareRequest.ProtoReflect.Descriptor instead.

func (*DeleteOCMCoreShareRequest) GetId 

func (x *DeleteOCMCoreShareRequest) GetId() string

func (*DeleteOCMCoreShareRequest) GetOpaque 

func (x *DeleteOCMCoreShareRequest) GetOpaque() *v1beta1.Opaque

func (*DeleteOCMCoreShareRequest) ProtoMessage 

func (*DeleteOCMCoreShareRequest) ProtoMessage()

func (*DeleteOCMCoreShareRequest) ProtoReflect 

func (x *DeleteOCMCoreShareRequest) ProtoReflect() protoreflect.Message

func (*DeleteOCMCoreShareRequest) Reset 

func (x *DeleteOCMCoreShareRequest) Reset()

func (*DeleteOCMCoreShareRequest) String 

func (x *DeleteOCMCoreShareRequest) String() string

type DeleteOCMCoreShareResponse 

type DeleteOCMCoreShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta14.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteOCMCoreShareResponse) Descriptor deprecated 

func (*DeleteOCMCoreShareResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeleteOCMCoreShareResponse.ProtoReflect.Descriptor instead.

func (*DeleteOCMCoreShareResponse) GetOpaque 

func (x *DeleteOCMCoreShareResponse) GetOpaque() *v1beta1.Opaque

func (*DeleteOCMCoreShareResponse) GetStatus 

func (x *DeleteOCMCoreShareResponse) GetStatus() *v1beta14.Status

func (*DeleteOCMCoreShareResponse) ProtoMessage 

func (*DeleteOCMCoreShareResponse) ProtoMessage()

func (*DeleteOCMCoreShareResponse) ProtoReflect 

func (x *DeleteOCMCoreShareResponse) ProtoReflect() protoreflect.Message

func (*DeleteOCMCoreShareResponse) Reset 

func (x *DeleteOCMCoreShareResponse) Reset()

func (*DeleteOCMCoreShareResponse) String 

func (x *DeleteOCMCoreShareResponse) String() string

type OcmCoreAPIClient 

type OcmCoreAPIClient interface {
	// Creates a new OCM share, in response to a call from remote to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1shares/post
	CreateOCMCoreShare(ctx context.Context, in *CreateOCMCoreShareRequest, opts ...grpc.CallOption) (*CreateOCMCoreShareResponse, error)
	// Updates an OCM share, in response to a notification from the remote system to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post
	UpdateOCMCoreShare(ctx context.Context, in *UpdateOCMCoreShareRequest, opts ...grpc.CallOption) (*UpdateOCMCoreShareResponse, error)
	// Deletes an OCM share, in response to a notification from the remote system to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post
	DeleteOCMCoreShare(ctx context.Context, in *DeleteOCMCoreShareRequest, opts ...grpc.CallOption) (*DeleteOCMCoreShareResponse, error)
}

OcmCoreAPIClient is the client API for OcmCoreAPI 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 NewOcmCoreAPIClient 

func NewOcmCoreAPIClient(cc grpc.ClientConnInterface) OcmCoreAPIClient

type OcmCoreAPIServer 

type OcmCoreAPIServer interface {
	// Creates a new OCM share, in response to a call from remote to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1shares/post
	CreateOCMCoreShare(context.Context, *CreateOCMCoreShareRequest) (*CreateOCMCoreShareResponse, error)
	// Updates an OCM share, in response to a notification from the remote system to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post
	UpdateOCMCoreShare(context.Context, *UpdateOCMCoreShareRequest) (*UpdateOCMCoreShareResponse, error)
	// Deletes an OCM share, in response to a notification from the remote system to:
	// https://cs3org.github.io/OCM-API/docs.html?branch=v1.1.0&repo=OCM-API&user=cs3org#/paths/~1notifications/post
	DeleteOCMCoreShare(context.Context, *DeleteOCMCoreShareRequest) (*DeleteOCMCoreShareResponse, error)
}

OcmCoreAPIServer is the server API for OcmCoreAPI service. All implementations should embed UnimplementedOcmCoreAPIServer for forward compatibility

type UnimplementedOcmCoreAPIServer 

type UnimplementedOcmCoreAPIServer struct {
}

UnimplementedOcmCoreAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedOcmCoreAPIServer) CreateOCMCoreShare 

func (UnimplementedOcmCoreAPIServer) CreateOCMCoreShare(context.Context, *CreateOCMCoreShareRequest) (*CreateOCMCoreShareResponse, error)

func (UnimplementedOcmCoreAPIServer) DeleteOCMCoreShare 

func (UnimplementedOcmCoreAPIServer) DeleteOCMCoreShare(context.Context, *DeleteOCMCoreShareRequest) (*DeleteOCMCoreShareResponse, error)

func (UnimplementedOcmCoreAPIServer) UpdateOCMCoreShare 

func (UnimplementedOcmCoreAPIServer) UpdateOCMCoreShare(context.Context, *UpdateOCMCoreShareRequest) (*UpdateOCMCoreShareResponse, error)

type UnsafeOcmCoreAPIServer 

type UnsafeOcmCoreAPIServer interface {
	// contains filtered or unexported methods
}

UnsafeOcmCoreAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OcmCoreAPIServer will result in compilation errors.

type UpdateOCMCoreShareRequest 

type UpdateOCMCoreShareRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// Unique ID to identify the share at the consumer side.
	OcmShareId string `protobuf:"bytes,2,opt,name=ocm_share_id,json=ocmShareId,proto3" json:"ocm_share_id,omitempty"`
	// OPTIONAL.
	// Description for the share.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// OPTIONAL.
	// Recipient share type.
	ShareType v1beta13.ShareType `` /* 128-byte string literal not displayed */
	// OPTIONAL.
	// The expiration time for the OCM share.
	Expiration *v1beta1.Timestamp `protobuf:"bytes,6,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// OPTIONAL.
	// The protocols which are used to establish synchronisation,
	// with their access rights.
	Protocols []*v1beta13.Protocol `protobuf:"bytes,7,rep,name=protocols,proto3" json:"protocols,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateOCMCoreShareRequest) Descriptor deprecated 

func (*UpdateOCMCoreShareRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateOCMCoreShareRequest.ProtoReflect.Descriptor instead.

func (*UpdateOCMCoreShareRequest) GetDescription 

func (x *UpdateOCMCoreShareRequest) GetDescription() string

func (*UpdateOCMCoreShareRequest) GetExpiration 

func (x *UpdateOCMCoreShareRequest) GetExpiration() *v1beta1.Timestamp

func (*UpdateOCMCoreShareRequest) GetOcmShareId 

func (x *UpdateOCMCoreShareRequest) GetOcmShareId() string

func (*UpdateOCMCoreShareRequest) GetOpaque 

func (x *UpdateOCMCoreShareRequest) GetOpaque() *v1beta1.Opaque

func (*UpdateOCMCoreShareRequest) GetProtocols 

func (x *UpdateOCMCoreShareRequest) GetProtocols() []*v1beta13.Protocol

func (*UpdateOCMCoreShareRequest) GetShareType 

func (x *UpdateOCMCoreShareRequest) GetShareType() v1beta13.ShareType

func (*UpdateOCMCoreShareRequest) ProtoMessage 

func (*UpdateOCMCoreShareRequest) ProtoMessage()

func (*UpdateOCMCoreShareRequest) ProtoReflect 

func (x *UpdateOCMCoreShareRequest) ProtoReflect() protoreflect.Message

func (*UpdateOCMCoreShareRequest) Reset 

func (x *UpdateOCMCoreShareRequest) Reset()

func (*UpdateOCMCoreShareRequest) String 

func (x *UpdateOCMCoreShareRequest) String() string

type UpdateOCMCoreShareResponse 

type UpdateOCMCoreShareResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta14.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateOCMCoreShareResponse) Descriptor deprecated 

func (*UpdateOCMCoreShareResponse) Descriptor() ([]byte, []int)

Deprecated: Use UpdateOCMCoreShareResponse.ProtoReflect.Descriptor instead.

func (*UpdateOCMCoreShareResponse) GetOpaque 

func (x *UpdateOCMCoreShareResponse) GetOpaque() *v1beta1.Opaque

func (*UpdateOCMCoreShareResponse) GetStatus 

func (x *UpdateOCMCoreShareResponse) GetStatus() *v1beta14.Status

func (*UpdateOCMCoreShareResponse) ProtoMessage 

func (*UpdateOCMCoreShareResponse) ProtoMessage()

func (*UpdateOCMCoreShareResponse) ProtoReflect 

func (x *UpdateOCMCoreShareResponse) ProtoReflect() protoreflect.Message

func (*UpdateOCMCoreShareResponse) Reset 

func (x *UpdateOCMCoreShareResponse) Reset()

func (*UpdateOCMCoreShareResponse) String 

func (x *UpdateOCMCoreShareResponse) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.