Documentation ¶
Index ¶
- Variables
- func RegisterOcmCoreAPIHandler(s server.Server, hdlr OcmCoreAPIHandler, opts ...server.HandlerOption) error
- func RegisterOcmCoreAPIServer(s *grpc.Server, srv OcmCoreAPIServer)
- type CreateOCMCoreShareRequest
- func (*CreateOCMCoreShareRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateOCMCoreShareRequest) GetDescription() string
- func (x *CreateOCMCoreShareRequest) GetName() string
- func (x *CreateOCMCoreShareRequest) GetOpaque() *v1beta1.Opaque
- func (x *CreateOCMCoreShareRequest) GetOwner() *v1beta11.UserId
- func (x *CreateOCMCoreShareRequest) GetProtocol() *Protocol
- func (x *CreateOCMCoreShareRequest) GetProviderId() string
- func (x *CreateOCMCoreShareRequest) GetShareWith() *v1beta11.UserId
- func (*CreateOCMCoreShareRequest) ProtoMessage()
- func (x *CreateOCMCoreShareRequest) ProtoReflect() protoreflect.Message
- func (x *CreateOCMCoreShareRequest) Reset()
- func (x *CreateOCMCoreShareRequest) String() string
- type CreateOCMCoreShareResponse
- func (*CreateOCMCoreShareResponse) Descriptor() ([]byte, []int)deprecated
- func (x *CreateOCMCoreShareResponse) GetCreated() *v1beta1.Timestamp
- func (x *CreateOCMCoreShareResponse) GetId() string
- func (x *CreateOCMCoreShareResponse) GetOpaque() *v1beta1.Opaque
- func (x *CreateOCMCoreShareResponse) GetStatus() *v1beta12.Status
- func (*CreateOCMCoreShareResponse) ProtoMessage()
- func (x *CreateOCMCoreShareResponse) ProtoReflect() protoreflect.Message
- func (x *CreateOCMCoreShareResponse) Reset()
- func (x *CreateOCMCoreShareResponse) String() string
- type OcmCoreAPIClient
- type OcmCoreAPIHandler
- type OcmCoreAPIServer
- type OcmCoreAPIService
- type Protocol
- type UnimplementedOcmCoreAPIServer
Constants ¶
This section is empty.
Variables ¶
View Source
var File_cs3_ocm_core_v1beta1_ocm_core_api_proto protoreflect.FileDescriptor
View Source
var File_cs3_ocm_core_v1beta1_resources_proto protoreflect.FileDescriptor
Functions ¶
func RegisterOcmCoreAPIHandler ¶
func RegisterOcmCoreAPIHandler(s server.Server, hdlr OcmCoreAPIHandler, opts ...server.HandlerOption) error
func RegisterOcmCoreAPIServer ¶
func RegisterOcmCoreAPIServer(s *grpc.Server, srv OcmCoreAPIServer)
Types ¶
type CreateOCMCoreShareRequest ¶
type CreateOCMCoreShareRequest struct { // Opaque information. Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // Description for the share. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Name of the resource (file or folder). Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` // Identifier to identify the resource at the provider side. This is unique per provider. ProviderId string `protobuf:"bytes,4,opt,name=provider_id,json=providerId,proto3" json:"provider_id,omitempty"` // Provider specific identifier of the user that wants to share the resource. Owner *v1beta11.UserId `protobuf:"bytes,5,opt,name=owner,proto3" json:"owner,omitempty"` // 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,6,opt,name=share_with,json=shareWith,proto3" json:"share_with,omitempty"` // The protocol which is used to establish synchronisation. Protocol *Protocol `protobuf:"bytes,7,opt,name=protocol,proto3" json:"protocol,omitempty"` // contains filtered or unexported fields }
https://rawgit.com/GEANT/OCM-API/v1/docs.html#null%2Fpaths%2F~1shares%2Fpost
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) 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) GetProtocol ¶
func (x *CreateOCMCoreShareRequest) GetProtocol() *Protocol
func (*CreateOCMCoreShareRequest) GetProviderId ¶
func (x *CreateOCMCoreShareRequest) GetProviderId() string
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 { // 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"` // Unique ID to identify the share at the consumer side. Id string `protobuf:"bytes,3,opt,name=id,proto3" json:"id,omitempty"` 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() *v1beta12.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 OcmCoreAPIClient ¶
type OcmCoreAPIClient interface { context.Context, in *CreateOCMCoreShareRequest, opts ...grpc.CallOption) (*CreateOCMCoreShareResponse, error) }CreateOCMCoreShare(ctx
OcmCoreAPIClient is the client API for OcmCoreAPI service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewOcmCoreAPIClient ¶
func NewOcmCoreAPIClient(cc grpc.ClientConnInterface) OcmCoreAPIClient
type OcmCoreAPIHandler ¶
type OcmCoreAPIHandler interface { context.Context, *CreateOCMCoreShareRequest, *CreateOCMCoreShareResponse) error }CreateOCMCoreShare(
type OcmCoreAPIServer ¶
type OcmCoreAPIServer interface { context.Context, *CreateOCMCoreShareRequest) (*CreateOCMCoreShareResponse, error) }CreateOCMCoreShare(
OcmCoreAPIServer is the server API for OcmCoreAPI service.
type OcmCoreAPIService ¶
type OcmCoreAPIService interface { context.Context, in *CreateOCMCoreShareRequest, opts ...client.CallOption) (*CreateOCMCoreShareResponse, error) }CreateOCMCoreShare(ctx
func NewOcmCoreAPIService ¶
func NewOcmCoreAPIService(name string, c client.Client) OcmCoreAPIService
type Protocol ¶
type Protocol struct { // REQUIRED. // The name of the protocol to use. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // REQUIRED. // JSON object with protocol specific options, // e.g. uri, access_token, password, permissions etc. Opaque *v1beta1.Opaque `protobuf:"bytes,2,opt,name=opaque,proto3" json:"opaque,omitempty"` // contains filtered or unexported fields }
The protocol which is used to establish synchronisation.
func (*Protocol) Descriptor
deprecated
func (*Protocol) ProtoMessage ¶
func (*Protocol) ProtoMessage()
func (*Protocol) ProtoReflect ¶
func (x *Protocol) ProtoReflect() protoreflect.Message
type UnimplementedOcmCoreAPIServer ¶
type UnimplementedOcmCoreAPIServer struct { }
UnimplementedOcmCoreAPIServer can be embedded to have forward compatible implementations.
func (*UnimplementedOcmCoreAPIServer) CreateOCMCoreShare ¶
func (*UnimplementedOcmCoreAPIServer) CreateOCMCoreShare(context.Context, *CreateOCMCoreShareRequest) (*CreateOCMCoreShareResponse, error)
Click to show internal directories.
Click to hide internal directories.