groupv1beta1

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: 41

Documentation

Index

Constants

View Source
const (
	GroupAPI_GetGroup_FullMethodName        = "/cs3.identity.group.v1beta1.GroupAPI/GetGroup"
	GroupAPI_GetGroupByClaim_FullMethodName = "/cs3.identity.group.v1beta1.GroupAPI/GetGroupByClaim"
	GroupAPI_GetMembers_FullMethodName      = "/cs3.identity.group.v1beta1.GroupAPI/GetMembers"
	GroupAPI_HasMember_FullMethodName       = "/cs3.identity.group.v1beta1.GroupAPI/HasMember"
	GroupAPI_FindGroups_FullMethodName      = "/cs3.identity.group.v1beta1.GroupAPI/FindGroups"
)

Variables

View Source
var File_cs3_identity_group_v1beta1_group_api_proto protoreflect.FileDescriptor
View Source
var File_cs3_identity_group_v1beta1_resources_proto protoreflect.FileDescriptor
View Source
var GroupAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cs3.identity.group.v1beta1.GroupAPI",
	HandlerType: (*GroupAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetGroup",
			Handler:    _GroupAPI_GetGroup_Handler,
		},
		{
			MethodName: "GetGroupByClaim",
			Handler:    _GroupAPI_GetGroupByClaim_Handler,
		},
		{
			MethodName: "GetMembers",
			Handler:    _GroupAPI_GetMembers_Handler,
		},
		{
			MethodName: "HasMember",
			Handler:    _GroupAPI_HasMember_Handler,
		},
		{
			MethodName: "FindGroups",
			Handler:    _GroupAPI_FindGroups_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "cs3/identity/group/v1beta1/group_api.proto",
}

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

Functions

func RegisterGroupAPIServer

func RegisterGroupAPIServer(s grpc.ServiceRegistrar, srv GroupAPIServer)

Types

type FindGroupsRequest

type FindGroupsRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The filter to apply.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// OPTIONAL.
	// Whether to skip fetching members along with the group object.
	SkipFetchingMembers bool `protobuf:"varint,3,opt,name=skip_fetching_members,json=skipFetchingMembers,proto3" json:"skip_fetching_members,omitempty"`
	// contains filtered or unexported fields
}

func (*FindGroupsRequest) Descriptor deprecated

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

Deprecated: Use FindGroupsRequest.ProtoReflect.Descriptor instead.

func (*FindGroupsRequest) GetFilter

func (x *FindGroupsRequest) GetFilter() string

func (*FindGroupsRequest) GetOpaque

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

func (*FindGroupsRequest) GetSkipFetchingMembers

func (x *FindGroupsRequest) GetSkipFetchingMembers() bool

func (*FindGroupsRequest) ProtoMessage

func (*FindGroupsRequest) ProtoMessage()

func (*FindGroupsRequest) ProtoReflect

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

func (*FindGroupsRequest) Reset

func (x *FindGroupsRequest) Reset()

func (*FindGroupsRequest) String

func (x *FindGroupsRequest) String() string

type FindGroupsResponse

type FindGroupsResponse 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 groups matching the specified filter.
	Groups []*Group `protobuf:"bytes,3,rep,name=groups,proto3" json:"groups,omitempty"`
	// contains filtered or unexported fields
}

func (*FindGroupsResponse) Descriptor deprecated

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

Deprecated: Use FindGroupsResponse.ProtoReflect.Descriptor instead.

func (*FindGroupsResponse) GetGroups

func (x *FindGroupsResponse) GetGroups() []*Group

func (*FindGroupsResponse) GetOpaque

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

func (*FindGroupsResponse) GetStatus

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

func (*FindGroupsResponse) ProtoMessage

func (*FindGroupsResponse) ProtoMessage()

func (*FindGroupsResponse) ProtoReflect

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

func (*FindGroupsResponse) Reset

func (x *FindGroupsResponse) Reset()

func (*FindGroupsResponse) String

func (x *FindGroupsResponse) String() string

type GetGroupByClaimRequest

type GetGroupByClaimRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The claim on the basis of which groups will be filtered.
	Claim string `protobuf:"bytes,2,opt,name=claim,proto3" json:"claim,omitempty"`
	// REQUIRED.
	// The value of the claim to find the specific group.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// OPTIONAL.
	// Whether to skip fetching members along with the group object.
	SkipFetchingMembers bool `protobuf:"varint,4,opt,name=skip_fetching_members,json=skipFetchingMembers,proto3" json:"skip_fetching_members,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGroupByClaimRequest) Descriptor deprecated

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

Deprecated: Use GetGroupByClaimRequest.ProtoReflect.Descriptor instead.

func (*GetGroupByClaimRequest) GetClaim

func (x *GetGroupByClaimRequest) GetClaim() string

func (*GetGroupByClaimRequest) GetOpaque

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

func (*GetGroupByClaimRequest) GetSkipFetchingMembers

func (x *GetGroupByClaimRequest) GetSkipFetchingMembers() bool

func (*GetGroupByClaimRequest) GetValue

func (x *GetGroupByClaimRequest) GetValue() string

func (*GetGroupByClaimRequest) ProtoMessage

func (*GetGroupByClaimRequest) ProtoMessage()

func (*GetGroupByClaimRequest) ProtoReflect

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

func (*GetGroupByClaimRequest) Reset

func (x *GetGroupByClaimRequest) Reset()

func (*GetGroupByClaimRequest) String

func (x *GetGroupByClaimRequest) String() string

type GetGroupByClaimResponse

type GetGroupByClaimResponse 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 group information.
	Group *Group `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGroupByClaimResponse) Descriptor deprecated

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

Deprecated: Use GetGroupByClaimResponse.ProtoReflect.Descriptor instead.

func (*GetGroupByClaimResponse) GetGroup

func (x *GetGroupByClaimResponse) GetGroup() *Group

func (*GetGroupByClaimResponse) GetOpaque

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

func (*GetGroupByClaimResponse) GetStatus

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

func (*GetGroupByClaimResponse) ProtoMessage

func (*GetGroupByClaimResponse) ProtoMessage()

func (*GetGroupByClaimResponse) ProtoReflect

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

func (*GetGroupByClaimResponse) Reset

func (x *GetGroupByClaimResponse) Reset()

func (*GetGroupByClaimResponse) String

func (x *GetGroupByClaimResponse) String() string

type GetGroupRequest

type GetGroupRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the group.
	GroupId *GroupId `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// OPTIONAL.
	// Whether to skip fetching members along with the group object.
	SkipFetchingMembers bool `protobuf:"varint,3,opt,name=skip_fetching_members,json=skipFetchingMembers,proto3" json:"skip_fetching_members,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGroupRequest) Descriptor deprecated

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

Deprecated: Use GetGroupRequest.ProtoReflect.Descriptor instead.

func (*GetGroupRequest) GetGroupId

func (x *GetGroupRequest) GetGroupId() *GroupId

func (*GetGroupRequest) GetOpaque

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

func (*GetGroupRequest) GetSkipFetchingMembers

func (x *GetGroupRequest) GetSkipFetchingMembers() bool

func (*GetGroupRequest) ProtoMessage

func (*GetGroupRequest) ProtoMessage()

func (*GetGroupRequest) ProtoReflect

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

func (*GetGroupRequest) Reset

func (x *GetGroupRequest) Reset()

func (*GetGroupRequest) String

func (x *GetGroupRequest) String() string

type GetGroupResponse

type GetGroupResponse 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 group information.
	Group *Group `protobuf:"bytes,3,opt,name=group,proto3" json:"group,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGroupResponse) Descriptor deprecated

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

Deprecated: Use GetGroupResponse.ProtoReflect.Descriptor instead.

func (*GetGroupResponse) GetGroup

func (x *GetGroupResponse) GetGroup() *Group

func (*GetGroupResponse) GetOpaque

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

func (*GetGroupResponse) GetStatus

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

func (*GetGroupResponse) ProtoMessage

func (*GetGroupResponse) ProtoMessage()

func (*GetGroupResponse) ProtoReflect

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

func (*GetGroupResponse) Reset

func (x *GetGroupResponse) Reset()

func (*GetGroupResponse) String

func (x *GetGroupResponse) String() string

type GetMembersRequest

type GetMembersRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the group.
	GroupId *GroupId `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMembersRequest) Descriptor deprecated

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

Deprecated: Use GetMembersRequest.ProtoReflect.Descriptor instead.

func (*GetMembersRequest) GetGroupId

func (x *GetMembersRequest) GetGroupId() *GroupId

func (*GetMembersRequest) GetOpaque

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

func (*GetMembersRequest) ProtoMessage

func (*GetMembersRequest) ProtoMessage()

func (*GetMembersRequest) ProtoReflect

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

func (*GetMembersRequest) Reset

func (x *GetMembersRequest) Reset()

func (*GetMembersRequest) String

func (x *GetMembersRequest) String() string

type GetMembersResponse

type GetMembersResponse 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 members of the group.
	Members []*v1beta12.UserId `protobuf:"bytes,3,rep,name=members,proto3" json:"members,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMembersResponse) Descriptor deprecated

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

Deprecated: Use GetMembersResponse.ProtoReflect.Descriptor instead.

func (*GetMembersResponse) GetMembers

func (x *GetMembersResponse) GetMembers() []*v1beta12.UserId

func (*GetMembersResponse) GetOpaque

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

func (*GetMembersResponse) GetStatus

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

func (*GetMembersResponse) ProtoMessage

func (*GetMembersResponse) ProtoMessage()

func (*GetMembersResponse) ProtoReflect

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

func (*GetMembersResponse) Reset

func (x *GetMembersResponse) Reset()

func (*GetMembersResponse) String

func (x *GetMembersResponse) String() string

type Group

type Group struct {
	Id           *GroupId          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	GroupName    string            `protobuf:"bytes,2,opt,name=group_name,json=groupName,proto3" json:"group_name,omitempty"`
	GidNumber    int64             `protobuf:"varint,3,opt,name=gid_number,json=gidNumber,proto3" json:"gid_number,omitempty"`
	Mail         string            `protobuf:"bytes,4,opt,name=mail,proto3" json:"mail,omitempty"`
	MailVerified bool              `protobuf:"varint,5,opt,name=mail_verified,json=mailVerified,proto3" json:"mail_verified,omitempty"`
	DisplayName  string            `protobuf:"bytes,6,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	Members      []*v1beta1.UserId `protobuf:"bytes,7,rep,name=members,proto3" json:"members,omitempty"`
	Opaque       *v1beta11.Opaque  `protobuf:"bytes,8,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// contains filtered or unexported fields
}

Represents a group of the system.

func (*Group) Descriptor deprecated

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

Deprecated: Use Group.ProtoReflect.Descriptor instead.

func (*Group) GetDisplayName

func (x *Group) GetDisplayName() string

func (*Group) GetGidNumber

func (x *Group) GetGidNumber() int64

func (*Group) GetGroupName

func (x *Group) GetGroupName() string

func (*Group) GetId

func (x *Group) GetId() *GroupId

func (*Group) GetMail

func (x *Group) GetMail() string

func (*Group) GetMailVerified

func (x *Group) GetMailVerified() bool

func (*Group) GetMembers

func (x *Group) GetMembers() []*v1beta1.UserId

func (*Group) GetOpaque

func (x *Group) GetOpaque() *v1beta11.Opaque

func (*Group) ProtoMessage

func (*Group) ProtoMessage()

func (*Group) ProtoReflect

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

func (*Group) Reset

func (x *Group) Reset()

func (*Group) String

func (x *Group) String() string

type GroupAPIClient

type GroupAPIClient interface {
	// Gets the information about a group by the group id.
	GetGroup(ctx context.Context, in *GetGroupRequest, opts ...grpc.CallOption) (*GetGroupResponse, error)
	// Gets the information about a group based on a specified claim.
	GetGroupByClaim(ctx context.Context, in *GetGroupByClaimRequest, opts ...grpc.CallOption) (*GetGroupByClaimResponse, error)
	// Gets the members of a group.
	GetMembers(ctx context.Context, in *GetMembersRequest, opts ...grpc.CallOption) (*GetMembersResponse, error)
	// Tells if the group has certain member.
	HasMember(ctx context.Context, in *HasMemberRequest, opts ...grpc.CallOption) (*HasMemberResponse, error)
	// Finds groups whose names match the specified filter.
	FindGroups(ctx context.Context, in *FindGroupsRequest, opts ...grpc.CallOption) (*FindGroupsResponse, error)
}

GroupAPIClient is the client API for GroupAPI 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 NewGroupAPIClient

func NewGroupAPIClient(cc grpc.ClientConnInterface) GroupAPIClient

type GroupAPIServer

type GroupAPIServer interface {
	// Gets the information about a group by the group id.
	GetGroup(context.Context, *GetGroupRequest) (*GetGroupResponse, error)
	// Gets the information about a group based on a specified claim.
	GetGroupByClaim(context.Context, *GetGroupByClaimRequest) (*GetGroupByClaimResponse, error)
	// Gets the members of a group.
	GetMembers(context.Context, *GetMembersRequest) (*GetMembersResponse, error)
	// Tells if the group has certain member.
	HasMember(context.Context, *HasMemberRequest) (*HasMemberResponse, error)
	// Finds groups whose names match the specified filter.
	FindGroups(context.Context, *FindGroupsRequest) (*FindGroupsResponse, error)
}

GroupAPIServer is the server API for GroupAPI service. All implementations should embed UnimplementedGroupAPIServer for forward compatibility

type GroupId

type GroupId struct {

	// REQUIRED.
	// The identity provider for the group.
	Idp string `protobuf:"bytes,1,opt,name=idp,proto3" json:"idp,omitempty"`
	// REQUIRED.
	// the unique identifier for the group in the scope of
	// the identity provider.
	OpaqueId string `protobuf:"bytes,2,opt,name=opaque_id,json=opaqueId,proto3" json:"opaque_id,omitempty"`
	// contains filtered or unexported fields
}

A GroupId represents a group.

func (*GroupId) Descriptor deprecated

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

Deprecated: Use GroupId.ProtoReflect.Descriptor instead.

func (*GroupId) GetIdp

func (x *GroupId) GetIdp() string

func (*GroupId) GetOpaqueId

func (x *GroupId) GetOpaqueId() string

func (*GroupId) ProtoMessage

func (*GroupId) ProtoMessage()

func (*GroupId) ProtoReflect

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

func (*GroupId) Reset

func (x *GroupId) Reset()

func (*GroupId) String

func (x *GroupId) String() string

type HasMemberRequest

type HasMemberRequest struct {

	// OPTIONAL.
	// Opaque information.
	Opaque *v1beta1.Opaque `protobuf:"bytes,1,opt,name=opaque,proto3" json:"opaque,omitempty"`
	// REQUIRED.
	// The id of the group.
	GroupId *GroupId `protobuf:"bytes,2,opt,name=group_id,json=groupId,proto3" json:"group_id,omitempty"`
	// REQUIRED.
	// The id of the user to check.
	UserId *v1beta12.UserId `protobuf:"bytes,3,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// contains filtered or unexported fields
}

func (*HasMemberRequest) Descriptor deprecated

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

Deprecated: Use HasMemberRequest.ProtoReflect.Descriptor instead.

func (*HasMemberRequest) GetGroupId

func (x *HasMemberRequest) GetGroupId() *GroupId

func (*HasMemberRequest) GetOpaque

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

func (*HasMemberRequest) GetUserId

func (x *HasMemberRequest) GetUserId() *v1beta12.UserId

func (*HasMemberRequest) ProtoMessage

func (*HasMemberRequest) ProtoMessage()

func (*HasMemberRequest) ProtoReflect

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

func (*HasMemberRequest) Reset

func (x *HasMemberRequest) Reset()

func (*HasMemberRequest) String

func (x *HasMemberRequest) String() string

type HasMemberResponse

type HasMemberResponse 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.
	// Tells if the user belongs to the group.
	Ok bool `protobuf:"varint,3,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

func (*HasMemberResponse) Descriptor deprecated

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

Deprecated: Use HasMemberResponse.ProtoReflect.Descriptor instead.

func (*HasMemberResponse) GetOk

func (x *HasMemberResponse) GetOk() bool

func (*HasMemberResponse) GetOpaque

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

func (*HasMemberResponse) GetStatus

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

func (*HasMemberResponse) ProtoMessage

func (*HasMemberResponse) ProtoMessage()

func (*HasMemberResponse) ProtoReflect

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

func (*HasMemberResponse) Reset

func (x *HasMemberResponse) Reset()

func (*HasMemberResponse) String

func (x *HasMemberResponse) String() string

type UnimplementedGroupAPIServer

type UnimplementedGroupAPIServer struct {
}

UnimplementedGroupAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedGroupAPIServer) FindGroups

func (UnimplementedGroupAPIServer) GetGroup

func (UnimplementedGroupAPIServer) GetGroupByClaim

func (UnimplementedGroupAPIServer) GetMembers

func (UnimplementedGroupAPIServer) HasMember

type UnsafeGroupAPIServer

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

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

Jump to

Keyboard shortcuts

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