registryv1beta1

package
v0.0.0-...-d2cb316 Latest Latest
Warning

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

 Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 11 Imported by: 11

Documentation

Index

Constants

View Source 
const (
	RegistryAPI_GetStorageProviders_FullMethodName  = "/cs3.storage.registry.v1beta1.RegistryAPI/GetStorageProviders"
	RegistryAPI_ListStorageProviders_FullMethodName = "/cs3.storage.registry.v1beta1.RegistryAPI/ListStorageProviders"
	RegistryAPI_GetHome_FullMethodName              = "/cs3.storage.registry.v1beta1.RegistryAPI/GetHome"
)

Variables

View Source 
var File_cs3_storage_registry_v1beta1_registry_api_proto protoreflect.FileDescriptor
View Source 
var File_cs3_storage_registry_v1beta1_resources_proto protoreflect.FileDescriptor
View Source 
var RegistryAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.storage.registry.v1beta1.RegistryAPI",
	HandlerType: (*RegistryAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetStorageProviders",
			Handler:    _RegistryAPI_GetStorageProviders_Handler,
		},
		{
			MethodName: "ListStorageProviders",
			Handler:    _RegistryAPI_ListStorageProviders_Handler,
		},
		{
			MethodName: "GetHome",
			Handler:    _RegistryAPI_GetHome_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/storage/registry/v1beta1/registry_api.proto",
}

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

Functions

func RegisterRegistryAPIServer 

func RegisterRegistryAPIServer(s grpc.ServiceRegistrar, srv RegistryAPIServer)

Types

type GetHomeRequest 

type GetHomeRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

func (*GetHomeRequest) Descriptor deprecated 

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

Deprecated: Use GetHomeRequest.ProtoReflect.Descriptor instead.

func (*GetHomeRequest) GetOpaque 

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

func (*GetHomeRequest) ProtoMessage 

func (*GetHomeRequest) ProtoMessage()

func (*GetHomeRequest) ProtoReflect 

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

func (*GetHomeRequest) Reset 

func (x *GetHomeRequest) Reset()

func (*GetHomeRequest) String 

func (x *GetHomeRequest) String() string

type GetHomeResponse 

type GetHomeResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.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.
	// The storage provider for the user home.
	Provider *ProviderInfo `protobuf:"bytes,3,opt,name=provider,proto3" json:"provider,omitempty"`
	// contains filtered or unexported fields
}

func (*GetHomeResponse) Descriptor deprecated 

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

Deprecated: Use GetHomeResponse.ProtoReflect.Descriptor instead.

func (*GetHomeResponse) GetOpaque 

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

func (*GetHomeResponse) GetProvider 

func (x *GetHomeResponse) GetProvider() *ProviderInfo

func (*GetHomeResponse) GetStatus 

func (x *GetHomeResponse) GetStatus() *v1beta11.Status

func (*GetHomeResponse) ProtoMessage 

func (*GetHomeResponse) ProtoMessage()

func (*GetHomeResponse) ProtoReflect 

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

func (*GetHomeResponse) Reset 

func (x *GetHomeResponse) Reset()

func (*GetHomeResponse) String 

func (x *GetHomeResponse) String() string

type GetStorageProvidersRequest 

type GetStorageProvidersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The reference for the resource.
	Ref *v1beta12.Reference `protobuf:"bytes,2,opt,name=ref,proto3" json:"ref,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStorageProvidersRequest) Descriptor deprecated 

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

Deprecated: Use GetStorageProvidersRequest.ProtoReflect.Descriptor instead.

func (*GetStorageProvidersRequest) GetOpaque 

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

func (*GetStorageProvidersRequest) GetRef 

func (x *GetStorageProvidersRequest) GetRef() *v1beta12.Reference

func (*GetStorageProvidersRequest) ProtoMessage 

func (*GetStorageProvidersRequest) ProtoMessage()

func (*GetStorageProvidersRequest) ProtoReflect 

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

func (*GetStorageProvidersRequest) Reset 

func (x *GetStorageProvidersRequest) Reset()

func (*GetStorageProvidersRequest) String 

func (x *GetStorageProvidersRequest) String() string

type GetStorageProvidersResponse 

type GetStorageProvidersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.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.
	// The storage providers handling the requested storage resource.
	Providers []*ProviderInfo `protobuf:"bytes,3,rep,name=providers,proto3" json:"providers,omitempty"`
	// contains filtered or unexported fields
}

func (*GetStorageProvidersResponse) Descriptor deprecated 

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

Deprecated: Use GetStorageProvidersResponse.ProtoReflect.Descriptor instead.

func (*GetStorageProvidersResponse) GetOpaque 

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

func (*GetStorageProvidersResponse) GetProviders 

func (x *GetStorageProvidersResponse) GetProviders() []*ProviderInfo

func (*GetStorageProvidersResponse) GetStatus 

func (x *GetStorageProvidersResponse) GetStatus() *v1beta11.Status

func (*GetStorageProvidersResponse) ProtoMessage 

func (*GetStorageProvidersResponse) ProtoMessage()

func (*GetStorageProvidersResponse) ProtoReflect 

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

func (*GetStorageProvidersResponse) Reset 

func (x *GetStorageProvidersResponse) Reset()

func (*GetStorageProvidersResponse) String 

func (x *GetStorageProvidersResponse) String() string

type ListStorageProvidersRequest 

type ListStorageProvidersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"` // TODO(labkode): maybe add some filter?
	// contains filtered or unexported fields
}

func (*ListStorageProvidersRequest) Descriptor deprecated 

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

Deprecated: Use ListStorageProvidersRequest.ProtoReflect.Descriptor instead.

func (*ListStorageProvidersRequest) GetOpaque 

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

func (*ListStorageProvidersRequest) ProtoMessage 

func (*ListStorageProvidersRequest) ProtoMessage()

func (*ListStorageProvidersRequest) ProtoReflect 

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

func (*ListStorageProvidersRequest) Reset 

func (x *ListStorageProvidersRequest) Reset()

func (*ListStorageProvidersRequest) String 

func (x *ListStorageProvidersRequest) String() string

type ListStorageProvidersResponse 

type ListStorageProvidersResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta11.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.
	// The list of storage providers this registry knows about.
	Providers []*ProviderInfo `protobuf:"bytes,3,rep,name=providers,proto3" json:"providers,omitempty"`
	// contains filtered or unexported fields
}

func (*ListStorageProvidersResponse) Descriptor deprecated 

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

Deprecated: Use ListStorageProvidersResponse.ProtoReflect.Descriptor instead.

func (*ListStorageProvidersResponse) GetOpaque 

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

func (*ListStorageProvidersResponse) GetProviders 

func (x *ListStorageProvidersResponse) GetProviders() []*ProviderInfo

func (*ListStorageProvidersResponse) GetStatus 

func (x *ListStorageProvidersResponse) GetStatus() *v1beta11.Status

func (*ListStorageProvidersResponse) ProtoMessage 

func (*ListStorageProvidersResponse) ProtoMessage()

func (*ListStorageProvidersResponse) ProtoReflect 

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

func (*ListStorageProvidersResponse) Reset 

func (x *ListStorageProvidersResponse) Reset()

func (*ListStorageProvidersResponse) String 

func (x *ListStorageProvidersResponse) String() string

type ProviderInfo 

type ProviderInfo struct {

	// OPTIONAL.
	// Opaque information (containing storage-specific information).
	// For example, additional metadata attached to the resource.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The storage provider id that will become part of the
	// resource id.
	// For example, if the provider_id is "home", resources obtained
	// from this storage provider will have a resource id like "home:1234".
	ProviderId string `protobuf:"bytes,2,opt,name=provider_id,json=providerId,proto3" json:"provider_id,omitempty"`
	// REQUIRED.
	// The public path prefix this storage provider handles.
	// In Unix literature, the mount path.
	// For example, if the provider_path is "/home", resources obtained
	// from this storage provier will have a resource path lik "/home/docs".
	ProviderPath string `protobuf:"bytes,3,opt,name=provider_path,json=providerPath,proto3" json:"provider_path,omitempty"`
	// REQUIRED.
	// The address where the storage provider can be reached.
	// For example, tcp://localhost:1099.
	Address string `protobuf:"bytes,4,opt,name=address,proto3" json:"address,omitempty"`
	// OPTIONAL.
	// Information to describe the functionalities
	// offered by the storage provider. Meant to be read
	// by humans.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED.
	// List of available methods.
	Features *ProviderInfo_Features `protobuf:"bytes,6,opt,name=features,proto3" json:"features,omitempty"`
	// contains filtered or unexported fields
}

The information for the storage provider.

func (*ProviderInfo) Descriptor deprecated 

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

Deprecated: Use ProviderInfo.ProtoReflect.Descriptor instead.

func (*ProviderInfo) GetAddress 

func (x *ProviderInfo) GetAddress() string

func (*ProviderInfo) GetDescription 

func (x *ProviderInfo) GetDescription() string

func (*ProviderInfo) GetFeatures 

func (x *ProviderInfo) GetFeatures() *ProviderInfo_Features

func (*ProviderInfo) GetOpaque 

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

func (*ProviderInfo) GetProviderId 

func (x *ProviderInfo) GetProviderId() string

func (*ProviderInfo) GetProviderPath 

func (x *ProviderInfo) GetProviderPath() string

func (*ProviderInfo) ProtoMessage 

func (*ProviderInfo) ProtoMessage()

func (*ProviderInfo) ProtoReflect 

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

func (*ProviderInfo) Reset 

func (x *ProviderInfo) Reset()

func (*ProviderInfo) String 

func (x *ProviderInfo) String() string

type ProviderInfo_Features 

type ProviderInfo_Features struct {
	Recycle      bool `protobuf:"varint,1,opt,name=recycle,proto3" json:"recycle,omitempty"`
	FileVersions bool `protobuf:"varint,2,opt,name=file_versions,json=fileVersions,proto3" json:"file_versions,omitempty"`
	// contains filtered or unexported fields
}

REQUIRED. Represents the list of features available on this storage provider. If the feature is not supported, the related service methods MUST return CODE_UNIMPLEMENTED.

func (*ProviderInfo_Features) Descriptor deprecated 

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

Deprecated: Use ProviderInfo_Features.ProtoReflect.Descriptor instead.

func (*ProviderInfo_Features) GetFileVersions 

func (x *ProviderInfo_Features) GetFileVersions() bool

func (*ProviderInfo_Features) GetRecycle 

func (x *ProviderInfo_Features) GetRecycle() bool

func (*ProviderInfo_Features) ProtoMessage 

func (*ProviderInfo_Features) ProtoMessage()

func (*ProviderInfo_Features) ProtoReflect 

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

func (*ProviderInfo_Features) Reset 

func (x *ProviderInfo_Features) Reset()

func (*ProviderInfo_Features) String 

func (x *ProviderInfo_Features) String() string

type RegistryAPIClient 

type RegistryAPIClient interface {
	// Returns the storage provider that is reponsible for the given
	// resource reference.
	// MUST return CODE_NOT_FOUND if the reference does not exist.
	GetStorageProviders(ctx context.Context, in *GetStorageProvidersRequest, opts ...grpc.CallOption) (*GetStorageProvidersResponse, error)
	// Returns a list of the available storage providers known by this registry.
	ListStorageProviders(ctx context.Context, in *ListStorageProvidersRequest, opts ...grpc.CallOption) (*ListStorageProvidersResponse, error)
	// Gets the user home storage provider.
	GetHome(ctx context.Context, in *GetHomeRequest, opts ...grpc.CallOption) (*GetHomeResponse, error)
}

RegistryAPIClient is the client API for RegistryAPI 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 NewRegistryAPIClient 

func NewRegistryAPIClient(cc grpc.ClientConnInterface) RegistryAPIClient

type RegistryAPIServer 

type RegistryAPIServer interface {
	// Returns the storage provider that is reponsible for the given
	// resource reference.
	// MUST return CODE_NOT_FOUND if the reference does not exist.
	GetStorageProviders(context.Context, *GetStorageProvidersRequest) (*GetStorageProvidersResponse, error)
	// Returns a list of the available storage providers known by this registry.
	ListStorageProviders(context.Context, *ListStorageProvidersRequest) (*ListStorageProvidersResponse, error)
	// Gets the user home storage provider.
	GetHome(context.Context, *GetHomeRequest) (*GetHomeResponse, error)
}

RegistryAPIServer is the server API for RegistryAPI service. All implementations should embed UnimplementedRegistryAPIServer for forward compatibility

type UnimplementedRegistryAPIServer 

type UnimplementedRegistryAPIServer struct {
}

UnimplementedRegistryAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedRegistryAPIServer) GetHome 

func (UnimplementedRegistryAPIServer) GetHome(context.Context, *GetHomeRequest) (*GetHomeResponse, error)

func (UnimplementedRegistryAPIServer) GetStorageProviders 

func (UnimplementedRegistryAPIServer) GetStorageProviders(context.Context, *GetStorageProvidersRequest) (*GetStorageProvidersResponse, error)

func (UnimplementedRegistryAPIServer) ListStorageProviders 

func (UnimplementedRegistryAPIServer) ListStorageProviders(context.Context, *ListStorageProvidersRequest) (*ListStorageProvidersResponse, error)

type UnsafeRegistryAPIServer 

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

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

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.