preferencesv1beta1

package
v0.0.0-...-2d9caef Latest Latest
Warning

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

Go to latest
Published: Jul 25, 2025 License: Apache-2.0 Imports: 9 Imported by: 13

Documentation

Index

Constants

View Source
const (
	PreferencesAPI_SetKey_FullMethodName = "/cs3.preferences.v1beta1.PreferencesAPI/SetKey"
	PreferencesAPI_GetKey_FullMethodName = "/cs3.preferences.v1beta1.PreferencesAPI/GetKey"
)

Variables

View Source
var File_cs3_preferences_v1beta1_preferences_api_proto protoreflect.FileDescriptor
View Source
var File_cs3_preferences_v1beta1_resources_proto protoreflect.FileDescriptor
View Source
var PreferencesAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.preferences.v1beta1.PreferencesAPI",
	HandlerType: (*PreferencesAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetKey",
			Handler:    _PreferencesAPI_SetKey_Handler,
		},
		{
			MethodName: "GetKey",
			Handler:    _PreferencesAPI_GetKey_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/preferences/v1beta1/preferences_api.proto",
}

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

Functions

func RegisterPreferencesAPIServer

func RegisterPreferencesAPIServer(s grpc.ServiceRegistrar, srv PreferencesAPIServer)

Types

type GetKeyRequest

type GetKeyRequest struct {

	// REQUIRED.
	Key *PreferenceKey `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*GetKeyRequest) Descriptor deprecated

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

Deprecated: Use GetKeyRequest.ProtoReflect.Descriptor instead.

func (*GetKeyRequest) GetKey

func (x *GetKeyRequest) GetKey() *PreferenceKey

func (*GetKeyRequest) ProtoMessage

func (*GetKeyRequest) ProtoMessage()

func (*GetKeyRequest) ProtoReflect

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

func (*GetKeyRequest) Reset

func (x *GetKeyRequest) Reset()

func (*GetKeyRequest) String

func (x *GetKeyRequest) String() string

type GetKeyResponse

type GetKeyResponse struct {

	// REQUIRED.
	// The response status.
	Status *v1beta1.Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// REQUIRED.
	// The value associated with the key.
	Val string `protobuf:"bytes,2,opt,name=val,proto3" json:"val,omitempty"`
	// contains filtered or unexported fields
}

func (*GetKeyResponse) Descriptor deprecated

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

Deprecated: Use GetKeyResponse.ProtoReflect.Descriptor instead.

func (*GetKeyResponse) GetStatus

func (x *GetKeyResponse) GetStatus() *v1beta1.Status

func (*GetKeyResponse) GetVal

func (x *GetKeyResponse) GetVal() string

func (*GetKeyResponse) ProtoMessage

func (*GetKeyResponse) ProtoMessage()

func (*GetKeyResponse) ProtoReflect

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

func (*GetKeyResponse) Reset

func (x *GetKeyResponse) Reset()

func (*GetKeyResponse) String

func (x *GetKeyResponse) String() string

type PreferenceKey

type PreferenceKey struct {

	// REQUIRED.
	// The namespace to which the key belongs.
	Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// REQUIRED.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Represents a key object consisting of a namespace and a string key.

func (*PreferenceKey) Descriptor deprecated

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

Deprecated: Use PreferenceKey.ProtoReflect.Descriptor instead.

func (*PreferenceKey) GetKey

func (x *PreferenceKey) GetKey() string

func (*PreferenceKey) GetNamespace

func (x *PreferenceKey) GetNamespace() string

func (*PreferenceKey) ProtoMessage

func (*PreferenceKey) ProtoMessage()

func (*PreferenceKey) ProtoReflect

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

func (*PreferenceKey) Reset

func (x *PreferenceKey) Reset()

func (*PreferenceKey) String

func (x *PreferenceKey) String() string

type PreferencesAPIClient

type PreferencesAPIClient interface {
	// Maps the key-value pair.
	SetKey(ctx context.Context, in *SetKeyRequest, opts ...grpc.CallOption) (*SetKeyResponse, error)
	// Returns the value associated with the
	// requested key.
	GetKey(ctx context.Context, in *GetKeyRequest, opts ...grpc.CallOption) (*GetKeyResponse, error)
}

PreferencesAPIClient is the client API for PreferencesAPI 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.

type PreferencesAPIServer

type PreferencesAPIServer interface {
	// Maps the key-value pair.
	SetKey(context.Context, *SetKeyRequest) (*SetKeyResponse, error)
	// Returns the value associated with the
	// requested key.
	GetKey(context.Context, *GetKeyRequest) (*GetKeyResponse, error)
}

PreferencesAPIServer is the server API for PreferencesAPI service. All implementations should embed UnimplementedPreferencesAPIServer for forward compatibility

type SetKeyRequest

type SetKeyRequest struct {

	// REQUIRED.
	Key *PreferenceKey `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// REQUIRED.
	// The value associated with the key.
	Val string `protobuf:"bytes,2,opt,name=val,proto3" json:"val,omitempty"`
	// contains filtered or unexported fields
}

func (*SetKeyRequest) Descriptor deprecated

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

Deprecated: Use SetKeyRequest.ProtoReflect.Descriptor instead.

func (*SetKeyRequest) GetKey

func (x *SetKeyRequest) GetKey() *PreferenceKey

func (*SetKeyRequest) GetVal

func (x *SetKeyRequest) GetVal() string

func (*SetKeyRequest) ProtoMessage

func (*SetKeyRequest) ProtoMessage()

func (*SetKeyRequest) ProtoReflect

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

func (*SetKeyRequest) Reset

func (x *SetKeyRequest) Reset()

func (*SetKeyRequest) String

func (x *SetKeyRequest) String() string

type SetKeyResponse

type SetKeyResponse struct {

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

func (*SetKeyResponse) Descriptor deprecated

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

Deprecated: Use SetKeyResponse.ProtoReflect.Descriptor instead.

func (*SetKeyResponse) GetStatus

func (x *SetKeyResponse) GetStatus() *v1beta1.Status

func (*SetKeyResponse) ProtoMessage

func (*SetKeyResponse) ProtoMessage()

func (*SetKeyResponse) ProtoReflect

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

func (*SetKeyResponse) Reset

func (x *SetKeyResponse) Reset()

func (*SetKeyResponse) String

func (x *SetKeyResponse) String() string

type UnimplementedPreferencesAPIServer

type UnimplementedPreferencesAPIServer struct {
}

UnimplementedPreferencesAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedPreferencesAPIServer) GetKey

func (UnimplementedPreferencesAPIServer) SetKey

type UnsafePreferencesAPIServer

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL