adminpb

Documentation

Overview

Package adminpb contains API with Redis-related administrative endpoints.

Index

• Constants
• Variables
• func FileDescriptorSet() *descriptorpb.FileDescriptorSet
• func RegisterAdminServer(s grpc.ServiceRegistrar, srv AdminServer)
• type AdminClient
  • func NewAdminClient(cc grpc.ClientConnInterface) AdminClient
• type AdminServer
• type FlushAllRequest
  • func (*FlushAllRequest) Descriptor() ([]byte, []int)
  • func (x *FlushAllRequest) GetAsync() bool
  • func (*FlushAllRequest) ProtoMessage()
  • func (x *FlushAllRequest) ProtoReflect() protoreflect.Message
  • func (x *FlushAllRequest) Reset()
  • func (x *FlushAllRequest) String() string
• type UnimplementedAdminServer
  • func (UnimplementedAdminServer) FlushAll(context.Context, *FlushAllRequest) (*emptypb.Empty, error)
• type UnsafeAdminServer

Constants

const (
	Admin_FlushAll_FullMethodName = "/server.redisconn.Admin/FlushAll"
)

Variables

var Admin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "server.redisconn.Admin",
	HandlerType: (*AdminServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FlushAll",
			Handler:    _Admin_FlushAll_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "go.chromium.org/luci/server/redisconn/adminpb/admin.proto",
}

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

var File_go_chromium_org_luci_server_redisconn_adminpb_admin_proto protoreflect.FileDescriptor

Functions

func FileDescriptorSet

func FileDescriptorSet() *descriptorpb.FileDescriptorSet

FileDescriptorSet returns a descriptor set for this proto package, which includes all defined services, and all transitive dependencies.

Will not return nil.

Do NOT modify the returned descriptor.

func RegisterAdminServer

func RegisterAdminServer(s grpc.ServiceRegistrar, srv AdminServer)

Types

type AdminClient

type AdminClient interface {
	// Deletes all the keys of all the existing databases.
	//
	// Issues "FLUSHALL" command, optionally with "ASYNC" argument.
	FlushAll(ctx context.Context, in *FlushAllRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

AdminClient is the client API for Admin 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.

Admin exposes some administrative-level Redis operations.

func NewAdminClient

func NewAdminClient(cc grpc.ClientConnInterface) AdminClient

type AdminServer

type AdminServer interface {
	// Deletes all the keys of all the existing databases.
	//
	// Issues "FLUSHALL" command, optionally with "ASYNC" argument.
	FlushAll(context.Context, *FlushAllRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

AdminServer is the server API for Admin service. All implementations must embed UnimplementedAdminServer for forward compatibility.

Admin exposes some administrative-level Redis operations.

type FlushAllRequest

type FlushAllRequest struct {
	Async bool `protobuf:"varint,1,opt,name=async,proto3" json:"async,omitempty"` // flush asynchronously using "FLUSHALL ASYNC"
	// contains filtered or unexported fields
}

func (*FlushAllRequest) Descriptor

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

Deprecated: Use FlushAllRequest.ProtoReflect.Descriptor instead.

func (*FlushAllRequest) GetAsync

func (x *FlushAllRequest) GetAsync() bool

func (*FlushAllRequest) ProtoMessage

func (*FlushAllRequest) ProtoMessage()

func (*FlushAllRequest) ProtoReflect

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

func (*FlushAllRequest) Reset

func (x *FlushAllRequest) Reset()

func (*FlushAllRequest) String

func (x *FlushAllRequest) String() string

type UnimplementedAdminServer

type UnimplementedAdminServer struct{}

UnimplementedAdminServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedAdminServer) FlushAll

func (UnimplementedAdminServer) FlushAll(context.Context, *FlushAllRequest) (*emptypb.Empty, error)

type UnsafeAdminServer

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

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