rolesv2

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Jun 13, 2025 License: MIT Imports: 20 Imported by: 0

Documentation

Overview

Package rolesv2 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_sift_roles_v2_roles_proto protoreflect.FileDescriptor
View Source
var RoleService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sift.roles.v2.RoleService",
	HandlerType: (*RoleServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListRoles",
			Handler:    _RoleService_ListRoles_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "sift/roles/v2/roles.proto",
}

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

Functions

func RegisterRoleServiceHandler

func RegisterRoleServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterRoleServiceHandler registers the http handlers for service RoleService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterRoleServiceHandlerClient

func RegisterRoleServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client RoleServiceClient) error

RegisterRoleServiceHandlerClient registers the http handlers for service RoleService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "RoleServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "RoleServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "RoleServiceClient" to call the correct interceptors.

func RegisterRoleServiceHandlerFromEndpoint

func RegisterRoleServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterRoleServiceHandlerFromEndpoint is same as RegisterRoleServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterRoleServiceHandlerServer

func RegisterRoleServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server RoleServiceServer) error

RegisterRoleServiceHandlerServer registers the http handlers for service RoleService to "mux". UnaryRPC :call RoleServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterRoleServiceHandlerFromEndpoint instead.

func RegisterRoleServiceServer

func RegisterRoleServiceServer(s grpc.ServiceRegistrar, srv RoleServiceServer)

Types

type ListRolesRequest

type ListRolesRequest struct {

	// The maximum number of roles to return.
	// The service may return fewer than this value.
	// If unspecified, at most 50 roles will be returned.
	// The maximum value is 1000; values above 1000 will be coerced to 1000.
	PageSize uint32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListRoles` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRoles` must match
	// the call that provided the page token.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
	// Available fields to filter by are `role_id`, `name`, and `description`.
	// For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
	// For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/channels#channel). Optional.
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// How to order the retrieved channels. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...".
	// Available fields to order_by are `name` and `description`.
	// If left empty, items are ordered by `name` in ascending order (oldest-first).
	// For more information about the format of this field, read [this](https://google.aip.dev/132#ordering)
	// Example: "name desc,description"
	OrderBy string `protobuf:"bytes,4,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRolesRequest) CloneMessageVT

func (m *ListRolesRequest) CloneMessageVT() proto.Message

func (*ListRolesRequest) CloneVT

func (m *ListRolesRequest) CloneVT() *ListRolesRequest

func (*ListRolesRequest) Descriptor deprecated

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

Deprecated: Use ListRolesRequest.ProtoReflect.Descriptor instead.

func (*ListRolesRequest) EqualMessageVT

func (this *ListRolesRequest) EqualMessageVT(thatMsg proto.Message) bool

func (*ListRolesRequest) EqualVT

func (this *ListRolesRequest) EqualVT(that *ListRolesRequest) bool

func (*ListRolesRequest) GetFilter

func (x *ListRolesRequest) GetFilter() string

func (*ListRolesRequest) GetOrderBy

func (x *ListRolesRequest) GetOrderBy() string

func (*ListRolesRequest) GetPageSize

func (x *ListRolesRequest) GetPageSize() uint32

func (*ListRolesRequest) GetPageToken

func (x *ListRolesRequest) GetPageToken() string

func (*ListRolesRequest) MarshalToSizedBufferVT

func (m *ListRolesRequest) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ListRolesRequest) MarshalToSizedBufferVTStrict

func (m *ListRolesRequest) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)

func (*ListRolesRequest) MarshalToVT

func (m *ListRolesRequest) MarshalToVT(dAtA []byte) (int, error)

func (*ListRolesRequest) MarshalToVTStrict

func (m *ListRolesRequest) MarshalToVTStrict(dAtA []byte) (int, error)

func (*ListRolesRequest) MarshalVT

func (m *ListRolesRequest) MarshalVT() (dAtA []byte, err error)

func (*ListRolesRequest) MarshalVTStrict

func (m *ListRolesRequest) MarshalVTStrict() (dAtA []byte, err error)

func (*ListRolesRequest) ProtoMessage

func (*ListRolesRequest) ProtoMessage()

func (*ListRolesRequest) ProtoReflect

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

func (*ListRolesRequest) Reset

func (x *ListRolesRequest) Reset()

func (*ListRolesRequest) SizeVT

func (m *ListRolesRequest) SizeVT() (n int)

func (*ListRolesRequest) String

func (x *ListRolesRequest) String() string

func (*ListRolesRequest) UnmarshalVT

func (m *ListRolesRequest) UnmarshalVT(dAtA []byte) error

func (*ListRolesRequest) UnmarshalVTUnsafe

func (m *ListRolesRequest) UnmarshalVTUnsafe(dAtA []byte) error

type ListRolesResponse

type ListRolesResponse struct {
	Roles         []*Role `protobuf:"bytes,1,rep,name=roles,proto3" json:"roles,omitempty"`
	NextPageToken string  `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRolesResponse) CloneMessageVT

func (m *ListRolesResponse) CloneMessageVT() proto.Message

func (*ListRolesResponse) CloneVT

func (m *ListRolesResponse) CloneVT() *ListRolesResponse

func (*ListRolesResponse) Descriptor deprecated

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

Deprecated: Use ListRolesResponse.ProtoReflect.Descriptor instead.

func (*ListRolesResponse) EqualMessageVT

func (this *ListRolesResponse) EqualMessageVT(thatMsg proto.Message) bool

func (*ListRolesResponse) EqualVT

func (this *ListRolesResponse) EqualVT(that *ListRolesResponse) bool

func (*ListRolesResponse) GetNextPageToken

func (x *ListRolesResponse) GetNextPageToken() string

func (*ListRolesResponse) GetRoles

func (x *ListRolesResponse) GetRoles() []*Role

func (*ListRolesResponse) MarshalToSizedBufferVT

func (m *ListRolesResponse) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*ListRolesResponse) MarshalToSizedBufferVTStrict

func (m *ListRolesResponse) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)

func (*ListRolesResponse) MarshalToVT

func (m *ListRolesResponse) MarshalToVT(dAtA []byte) (int, error)

func (*ListRolesResponse) MarshalToVTStrict

func (m *ListRolesResponse) MarshalToVTStrict(dAtA []byte) (int, error)

func (*ListRolesResponse) MarshalVT

func (m *ListRolesResponse) MarshalVT() (dAtA []byte, err error)

func (*ListRolesResponse) MarshalVTStrict

func (m *ListRolesResponse) MarshalVTStrict() (dAtA []byte, err error)

func (*ListRolesResponse) ProtoMessage

func (*ListRolesResponse) ProtoMessage()

func (*ListRolesResponse) ProtoReflect

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

func (*ListRolesResponse) Reset

func (x *ListRolesResponse) Reset()

func (*ListRolesResponse) SizeVT

func (m *ListRolesResponse) SizeVT() (n int)

func (*ListRolesResponse) String

func (x *ListRolesResponse) String() string

func (*ListRolesResponse) UnmarshalVT

func (m *ListRolesResponse) UnmarshalVT(dAtA []byte) error

func (*ListRolesResponse) UnmarshalVTUnsafe

func (m *ListRolesResponse) UnmarshalVTUnsafe(dAtA []byte) error

type Role

type Role struct {
	RoleId      string `protobuf:"bytes,1,opt,name=role_id,json=roleId,proto3" json:"role_id,omitempty"`
	Name        string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*Role) CloneMessageVT

func (m *Role) CloneMessageVT() proto.Message

func (*Role) CloneVT

func (m *Role) CloneVT() *Role

func (*Role) Descriptor deprecated

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

Deprecated: Use Role.ProtoReflect.Descriptor instead.

func (*Role) EqualMessageVT

func (this *Role) EqualMessageVT(thatMsg proto.Message) bool

func (*Role) EqualVT

func (this *Role) EqualVT(that *Role) bool

func (*Role) GetDescription

func (x *Role) GetDescription() string

func (*Role) GetName

func (x *Role) GetName() string

func (*Role) GetRoleId

func (x *Role) GetRoleId() string

func (*Role) MarshalToSizedBufferVT

func (m *Role) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Role) MarshalToSizedBufferVTStrict

func (m *Role) MarshalToSizedBufferVTStrict(dAtA []byte) (int, error)

func (*Role) MarshalToVT

func (m *Role) MarshalToVT(dAtA []byte) (int, error)

func (*Role) MarshalToVTStrict

func (m *Role) MarshalToVTStrict(dAtA []byte) (int, error)

func (*Role) MarshalVT

func (m *Role) MarshalVT() (dAtA []byte, err error)

func (*Role) MarshalVTStrict

func (m *Role) MarshalVTStrict() (dAtA []byte, err error)

func (*Role) ProtoMessage

func (*Role) ProtoMessage()

func (*Role) ProtoReflect

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

func (*Role) Reset

func (x *Role) Reset()

func (*Role) SizeVT

func (m *Role) SizeVT() (n int)

func (*Role) String

func (x *Role) String() string

func (*Role) UnmarshalVT

func (m *Role) UnmarshalVT(dAtA []byte) error

func (*Role) UnmarshalVTUnsafe

func (m *Role) UnmarshalVTUnsafe(dAtA []byte) error

type RoleServiceClient

type RoleServiceClient interface {
	ListRoles(ctx context.Context, in *ListRolesRequest, opts ...grpc.CallOption) (*ListRolesResponse, error)
}

RoleServiceClient is the client API for RoleService 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 RoleServiceServer

type RoleServiceServer interface {
	ListRoles(context.Context, *ListRolesRequest) (*ListRolesResponse, error)
	// contains filtered or unexported methods
}

RoleServiceServer is the server API for RoleService service. All implementations must embed UnimplementedRoleServiceServer for forward compatibility

type UnimplementedRoleServiceServer

type UnimplementedRoleServiceServer struct {
}

UnimplementedRoleServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedRoleServiceServer) ListRoles

type UnsafeRoleServiceServer

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

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

Jump to

Keyboard shortcuts

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