entityresolution

package
v0.2.24 Latest Latest
Warning

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

 Go to latest Published: Jan 24, 2025 License: BSD-3-Clause-Clear Imports: 19 Imported by: 5

Documentation

Overview

Package entityresolution is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	EntityResolutionService_ResolveEntities_FullMethodName          = "/entityresolution.EntityResolutionService/ResolveEntities"
	EntityResolutionService_CreateEntityChainFromJwt_FullMethodName = "/entityresolution.EntityResolutionService/CreateEntityChainFromJwt"
)

Variables

View Source 
var EntityResolutionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "entityresolution.EntityResolutionService",
	HandlerType: (*EntityResolutionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ResolveEntities",
			Handler:    _EntityResolutionService_ResolveEntities_Handler,
		},
		{
			MethodName: "CreateEntityChainFromJwt",
			Handler:    _EntityResolutionService_CreateEntityChainFromJwt_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "entityresolution/entity_resolution.proto",
}

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

View Source 
var File_entityresolution_entity_resolution_proto protoreflect.FileDescriptor

Functions

func RegisterEntityResolutionServiceHandler 

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

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

func RegisterEntityResolutionServiceHandlerClient 

func RegisterEntityResolutionServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EntityResolutionServiceClient) error

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

func RegisterEntityResolutionServiceHandlerFromEndpoint 

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

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

func RegisterEntityResolutionServiceHandlerServer 

func RegisterEntityResolutionServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EntityResolutionServiceServer) error

RegisterEntityResolutionServiceHandlerServer registers the http handlers for service EntityResolutionService to "mux". UnaryRPC :call EntityResolutionServiceServer 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 RegisterEntityResolutionServiceHandlerFromEndpoint instead.

func RegisterEntityResolutionServiceServer 

func RegisterEntityResolutionServiceServer(s grpc.ServiceRegistrar, srv EntityResolutionServiceServer)

Types

type CreateEntityChainFromJwtRequest added in v0.2.3 

type CreateEntityChainFromJwtRequest struct {
	Tokens []*authorization.Token `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"`
	// contains filtered or unexported fields
}

Example: Get Entity chains for tokens aaaaaa and bbbbbb { "tokens": [ "aaaaaaa", "bbbbbbbb" ] }

func (*CreateEntityChainFromJwtRequest) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use CreateEntityChainFromJwtRequest.ProtoReflect.Descriptor instead.

func (*CreateEntityChainFromJwtRequest) GetTokens added in v0.2.3 

func (x *CreateEntityChainFromJwtRequest) GetTokens() []*authorization.Token

func (*CreateEntityChainFromJwtRequest) ProtoMessage added in v0.2.3 

func (*CreateEntityChainFromJwtRequest) ProtoMessage()

func (*CreateEntityChainFromJwtRequest) ProtoReflect added in v0.2.3 

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

func (*CreateEntityChainFromJwtRequest) Reset added in v0.2.3 

func (x *CreateEntityChainFromJwtRequest) Reset()

func (*CreateEntityChainFromJwtRequest) String added in v0.2.3 

func (x *CreateEntityChainFromJwtRequest) String() string

type CreateEntityChainFromJwtResponse added in v0.2.3 

type CreateEntityChainFromJwtResponse struct {
	EntityChains []*authorization.EntityChain `protobuf:"bytes,1,rep,name=entity_chains,json=entityChains,proto3" json:"entity_chains,omitempty"`
	// contains filtered or unexported fields
}

Example: Return the entity chains from the provided tokens { "entity_chains": [ { "id": "tok1", "entities": [ { "clientId": "client1" } ] }, { "id": "tok2", "entities": [ { "userName": "alice", "clientId": "client2" } ] } ] }

func (*CreateEntityChainFromJwtResponse) Descriptor deprecated added in v0.2.3 

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

Deprecated: Use CreateEntityChainFromJwtResponse.ProtoReflect.Descriptor instead.

func (*CreateEntityChainFromJwtResponse) GetEntityChains added in v0.2.3 

func (x *CreateEntityChainFromJwtResponse) GetEntityChains() []*authorization.EntityChain

func (*CreateEntityChainFromJwtResponse) ProtoMessage added in v0.2.3 

func (*CreateEntityChainFromJwtResponse) ProtoMessage()

func (*CreateEntityChainFromJwtResponse) ProtoReflect added in v0.2.3 

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

func (*CreateEntityChainFromJwtResponse) Reset added in v0.2.3 

func (x *CreateEntityChainFromJwtResponse) Reset()

func (*CreateEntityChainFromJwtResponse) String added in v0.2.3 

func (x *CreateEntityChainFromJwtResponse) String() string

type EntityNotFoundError 

type EntityNotFoundError struct {
	Code    int32        `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Message string       `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	Details []*anypb.Any `protobuf:"bytes,3,rep,name=details,proto3" json:"details,omitempty"`
	Entity  string       `protobuf:"bytes,4,opt,name=entity,proto3" json:"entity,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityNotFoundError) Descriptor deprecated 

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

Deprecated: Use EntityNotFoundError.ProtoReflect.Descriptor instead.

func (*EntityNotFoundError) GetCode 

func (x *EntityNotFoundError) GetCode() int32

func (*EntityNotFoundError) GetDetails 

func (x *EntityNotFoundError) GetDetails() []*anypb.Any

func (*EntityNotFoundError) GetEntity 

func (x *EntityNotFoundError) GetEntity() string

func (*EntityNotFoundError) GetMessage 

func (x *EntityNotFoundError) GetMessage() string

func (*EntityNotFoundError) ProtoMessage 

func (*EntityNotFoundError) ProtoMessage()

func (*EntityNotFoundError) ProtoReflect 

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

func (*EntityNotFoundError) Reset 

func (x *EntityNotFoundError) Reset()

func (*EntityNotFoundError) String 

func (x *EntityNotFoundError) String() string

type EntityRepresentation 

type EntityRepresentation struct {
	AdditionalProps []*structpb.Struct `protobuf:"bytes,1,rep,name=additional_props,json=additionalProps,proto3" json:"additional_props,omitempty"`
	OriginalId      string             `protobuf:"bytes,2,opt,name=original_id,json=originalId,proto3" json:"original_id,omitempty"` // ephemeral entity id from the request
	// contains filtered or unexported fields
}

func (*EntityRepresentation) Descriptor deprecated 

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

Deprecated: Use EntityRepresentation.ProtoReflect.Descriptor instead.

func (*EntityRepresentation) GetAdditionalProps 

func (x *EntityRepresentation) GetAdditionalProps() []*structpb.Struct

func (*EntityRepresentation) GetOriginalId 

func (x *EntityRepresentation) GetOriginalId() string

func (*EntityRepresentation) ProtoMessage 

func (*EntityRepresentation) ProtoMessage()

func (*EntityRepresentation) ProtoReflect 

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

func (*EntityRepresentation) Reset 

func (x *EntityRepresentation) Reset()

func (*EntityRepresentation) String 

func (x *EntityRepresentation) String() string

type EntityResolutionServiceClient 

type EntityResolutionServiceClient interface {
	ResolveEntities(ctx context.Context, in *ResolveEntitiesRequest, opts ...grpc.CallOption) (*ResolveEntitiesResponse, error)
	CreateEntityChainFromJwt(ctx context.Context, in *CreateEntityChainFromJwtRequest, opts ...grpc.CallOption) (*CreateEntityChainFromJwtResponse, error)
}

EntityResolutionServiceClient is the client API for EntityResolutionService 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 NewEntityResolutionServiceClient 

func NewEntityResolutionServiceClient(cc grpc.ClientConnInterface) EntityResolutionServiceClient

type EntityResolutionServiceServer 

type EntityResolutionServiceServer interface {
	ResolveEntities(context.Context, *ResolveEntitiesRequest) (*ResolveEntitiesResponse, error)
	CreateEntityChainFromJwt(context.Context, *CreateEntityChainFromJwtRequest) (*CreateEntityChainFromJwtResponse, error)
	// contains filtered or unexported methods
}

EntityResolutionServiceServer is the server API for EntityResolutionService service. All implementations must embed UnimplementedEntityResolutionServiceServer for forward compatibility

type ResolveEntitiesRequest 

type ResolveEntitiesRequest struct {
	Entities []*authorization.Entity `protobuf:"bytes,1,rep,name=entities,proto3" json:"entities,omitempty"`
	// contains filtered or unexported fields
}

Example: Get idp attributes for bob and alice (both represented using an email address { "entities": [ { "id": "e1", "emailAddress": "bob@example.org" }, { "id": "e2", "emailAddress": "alice@example.org" } ] }

func (*ResolveEntitiesRequest) Descriptor deprecated 

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

Deprecated: Use ResolveEntitiesRequest.ProtoReflect.Descriptor instead.

func (*ResolveEntitiesRequest) GetEntities 

func (x *ResolveEntitiesRequest) GetEntities() []*authorization.Entity

func (*ResolveEntitiesRequest) ProtoMessage 

func (*ResolveEntitiesRequest) ProtoMessage()

func (*ResolveEntitiesRequest) ProtoReflect 

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

func (*ResolveEntitiesRequest) Reset 

func (x *ResolveEntitiesRequest) Reset()

func (*ResolveEntitiesRequest) String 

func (x *ResolveEntitiesRequest) String() string

type ResolveEntitiesResponse 

type ResolveEntitiesResponse struct {
	EntityRepresentations []*EntityRepresentation `protobuf:"bytes,1,rep,name=entity_representations,json=entityRepresentations,proto3" json:"entity_representations,omitempty"`
	// contains filtered or unexported fields
}

Example: Get idp attributes for bob and alice { "entity_representations": [ { "idp_entity_id": "e1", "additional_props": {"someAttr1":"someValue1"} }, { "idp_entity_id": "e2", "additional_props": {"someAttr2":"someValue2"} } ] }

func (*ResolveEntitiesResponse) Descriptor deprecated 

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

Deprecated: Use ResolveEntitiesResponse.ProtoReflect.Descriptor instead.

func (*ResolveEntitiesResponse) GetEntityRepresentations 

func (x *ResolveEntitiesResponse) GetEntityRepresentations() []*EntityRepresentation

func (*ResolveEntitiesResponse) ProtoMessage 

func (*ResolveEntitiesResponse) ProtoMessage()

func (*ResolveEntitiesResponse) ProtoReflect 

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

func (*ResolveEntitiesResponse) Reset 

func (x *ResolveEntitiesResponse) Reset()

func (*ResolveEntitiesResponse) String 

func (x *ResolveEntitiesResponse) String() string

type UnimplementedEntityResolutionServiceServer 

type UnimplementedEntityResolutionServiceServer struct {
}

UnimplementedEntityResolutionServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedEntityResolutionServiceServer) CreateEntityChainFromJwt added in v0.2.3 

func (UnimplementedEntityResolutionServiceServer) CreateEntityChainFromJwt(context.Context, *CreateEntityChainFromJwtRequest) (*CreateEntityChainFromJwtResponse, error)

func (UnimplementedEntityResolutionServiceServer) ResolveEntities 

func (UnimplementedEntityResolutionServiceServer) ResolveEntities(context.Context, *ResolveEntitiesRequest) (*ResolveEntitiesResponse, error)

type UnsafeEntityResolutionServiceServer 

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

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

Source Files

View all Source files

Directories

Path Synopsis

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.