v1

package
v0.1.19 Latest Latest
Warning

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

 Go to latest Published: Feb 15, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package events contains the GRPC client and server definitions for implementing eventing interactions for the Console.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Identities_Create_FullMethodName         = "/chainguard.platform.events.Identities/Create"
	Identities_UpdateMetadata_FullMethodName = "/chainguard.platform.events.Identities/UpdateMetadata"
)
View Source 
const (
	Subscriptions_Create_FullMethodName = "/chainguard.platform.events.Subscriptions/Create"
	Subscriptions_List_FullMethodName   = "/chainguard.platform.events.Subscriptions/List"
	Subscriptions_Delete_FullMethodName = "/chainguard.platform.events.Subscriptions/Delete"
)

Variables

View Source 
var File_identities_platform_proto protoreflect.FileDescriptor
View Source 
var File_subscriptions_platform_proto protoreflect.FileDescriptor
View Source 
var Identities_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "chainguard.platform.events.Identities",
	HandlerType: (*IdentitiesServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _Identities_Create_Handler,
		},
		{
			MethodName: "UpdateMetadata",
			Handler:    _Identities_UpdateMetadata_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "identities.platform.proto",
}

Identities_ServiceDesc is the grpc.ServiceDesc for Identities 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 Subscriptions_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "chainguard.platform.events.Subscriptions",
	HandlerType: (*SubscriptionsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _Subscriptions_Create_Handler,
		},
		{
			MethodName: "List",
			Handler:    _Subscriptions_List_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Subscriptions_Delete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "subscriptions.platform.proto",
}

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

Functions

func RegisterIdentitiesHandler 

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

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

func RegisterIdentitiesHandlerClient 

func RegisterIdentitiesHandlerClient(ctx context.Context, mux *runtime.ServeMux, client IdentitiesClient) error

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

func RegisterIdentitiesHandlerFromEndpoint 

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

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

func RegisterIdentitiesHandlerServer 

func RegisterIdentitiesHandlerServer(ctx context.Context, mux *runtime.ServeMux, server IdentitiesServer) error

RegisterIdentitiesHandlerServer registers the http handlers for service Identities to "mux". UnaryRPC :call IdentitiesServer 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 RegisterIdentitiesHandlerFromEndpoint instead.

func RegisterIdentitiesServer 

func RegisterIdentitiesServer(s grpc.ServiceRegistrar, srv IdentitiesServer)

func RegisterSubscriptionsHandler 

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

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

func RegisterSubscriptionsHandlerClient 

func RegisterSubscriptionsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SubscriptionsClient) error

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

func RegisterSubscriptionsHandlerFromEndpoint 

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

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

func RegisterSubscriptionsHandlerServer 

func RegisterSubscriptionsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SubscriptionsServer) error

RegisterSubscriptionsHandlerServer registers the http handlers for service Subscriptions to "mux". UnaryRPC :call SubscriptionsServer 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 RegisterSubscriptionsHandlerFromEndpoint instead.

func RegisterSubscriptionsServer 

func RegisterSubscriptionsServer(s grpc.ServiceRegistrar, srv SubscriptionsServer)

Types

type CreateSubscriptionRequest 

type CreateSubscriptionRequest struct {

	// parent_id, The Group UIDP path under which the new subscription is associated.
	ParentId string `protobuf:"bytes,1,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	// Subscription is the subscription to create;
	Subscription *Subscription `protobuf:"bytes,2,opt,name=subscription,proto3" json:"subscription,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSubscriptionRequest) Descriptor deprecated 

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

Deprecated: Use CreateSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*CreateSubscriptionRequest) GetParentId 

func (x *CreateSubscriptionRequest) GetParentId() string

func (*CreateSubscriptionRequest) GetSubscription 

func (x *CreateSubscriptionRequest) GetSubscription() *Subscription

func (*CreateSubscriptionRequest) ProtoMessage 

func (*CreateSubscriptionRequest) ProtoMessage()

func (*CreateSubscriptionRequest) ProtoReflect 

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

func (*CreateSubscriptionRequest) Reset 

func (x *CreateSubscriptionRequest) Reset()

func (*CreateSubscriptionRequest) String 

func (x *CreateSubscriptionRequest) String() string

type DeleteSubscriptionRequest 

type DeleteSubscriptionRequest struct {

	// id is the exact UIDP of the record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteSubscriptionRequest) CloudEventsExtension 

func (x *DeleteSubscriptionRequest) CloudEventsExtension(key string) (string, bool)

CloudEventsExtension implements chainguard.dev/sdk/events/Extendable.CloudEventsExtension

func (*DeleteSubscriptionRequest) CloudEventsRedact 

func (x *DeleteSubscriptionRequest) CloudEventsRedact() interface{}

CloudEventsRedact implements chainguard.dev/sdk/events/Redactable.Redact.

func (*DeleteSubscriptionRequest) CloudEventsSubject 

func (x *DeleteSubscriptionRequest) CloudEventsSubject() string

CloudEventsSubject implements chainguard.dev/sdk/events/Eventable.CloudEventsSubject.

func (*DeleteSubscriptionRequest) Descriptor deprecated 

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

Deprecated: Use DeleteSubscriptionRequest.ProtoReflect.Descriptor instead.

func (*DeleteSubscriptionRequest) GetId 

func (x *DeleteSubscriptionRequest) GetId() string

func (*DeleteSubscriptionRequest) ProtoMessage 

func (*DeleteSubscriptionRequest) ProtoMessage()

func (*DeleteSubscriptionRequest) ProtoReflect 

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

func (*DeleteSubscriptionRequest) Reset 

func (x *DeleteSubscriptionRequest) Reset()

func (*DeleteSubscriptionRequest) String 

func (x *DeleteSubscriptionRequest) String() string

type IdentitiesClient 

type IdentitiesClient interface {
	Create(ctx context.Context, in *Identity, opts ...grpc.CallOption) (*Identity, error)
	UpdateMetadata(ctx context.Context, in *IdentityMetadata, opts ...grpc.CallOption) (*IdentityMetadata, error)
}

IdentitiesClient is the client API for Identities 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 NewIdentitiesClient 

func NewIdentitiesClient(cc grpc.ClientConnInterface) IdentitiesClient

type IdentitiesServer 

type IdentitiesServer interface {
	Create(context.Context, *Identity) (*Identity, error)
	UpdateMetadata(context.Context, *IdentityMetadata) (*IdentityMetadata, error)
	// contains filtered or unexported methods
}

IdentitiesServer is the server API for Identities service. All implementations must embed UnimplementedIdentitiesServer for forward compatibility

type Identity 

type Identity struct {

	// id is unique identifier of this specific identity.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// subject of OIDC ID tokens issued for this identity. Matchs the `sub`
	// claim.
	Subject string `protobuf:"bytes,2,opt,name=subject,proto3" json:"subject,omitempty"`
	// issuer of the OIDC ID tokens issued for this identity. Matches the `iss`
	// claim.
	Issuer string `protobuf:"bytes,3,opt,name=issuer,proto3" json:"issuer,omitempty"`
	// Optional JWKS formatted public keys for the issuer. If supplied
	// verification of ID tokens is attempted using these keys instead of the
	// normal OIDC discovery path. This enables e.g clusters behing NAT to
	// authenticate.
	IssuerKeys string `protobuf:"bytes,4,opt,name=issuer_keys,json=issuerKeys,proto3" json:"issuer_keys,omitempty"`
	// Expiration of identity / issuer keys. After this date /time the issuer
	// keys will not be trusted. Defaults / maximum of 30 days after creation
	// time.
	Expiration *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

func (*Identity) Descriptor deprecated 

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

Deprecated: Use Identity.ProtoReflect.Descriptor instead.

func (*Identity) GetExpiration 

func (x *Identity) GetExpiration() *timestamppb.Timestamp

func (*Identity) GetId 

func (x *Identity) GetId() string

func (*Identity) GetIssuer 

func (x *Identity) GetIssuer() string

func (*Identity) GetIssuerKeys 

func (x *Identity) GetIssuerKeys() string

func (*Identity) GetSubject 

func (x *Identity) GetSubject() string

func (*Identity) ProtoMessage 

func (*Identity) ProtoMessage()

func (*Identity) ProtoReflect 

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

func (*Identity) Reset 

func (x *Identity) Reset()

func (*Identity) String 

func (x *Identity) String() string

type IdentityMetadata 

type IdentityMetadata struct {
	OnboardingQuestions *IdentityMetadata_OnboardingQuestions `protobuf:"bytes,1,opt,name=onboarding_questions,json=onboardingQuestions,proto3" json:"onboarding_questions,omitempty"`
	// Output only. This is the name of the user.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Whether the user has opted to receive updates from Chainguard.
	UpdatesOptIn bool `protobuf:"varint,3,opt,name=updatesOptIn,proto3" json:"updatesOptIn,omitempty"`
	// contains filtered or unexported fields
}

func (*IdentityMetadata) CloudEventsExtension 

func (x *IdentityMetadata) CloudEventsExtension(key string) (string, bool)

CloudEventsExtension implements chainguard.dev/sdk/events/Extendable.CloudEventsExtension

func (*IdentityMetadata) CloudEventsSubject 

func (x *IdentityMetadata) CloudEventsSubject() string

CloudEventsSubject implements chainguard.dev/sdk/events/Eventable.CloudEventsSubject.

func (*IdentityMetadata) Descriptor deprecated 

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

Deprecated: Use IdentityMetadata.ProtoReflect.Descriptor instead.

func (*IdentityMetadata) GetName 

func (x *IdentityMetadata) GetName() string

func (*IdentityMetadata) GetOnboardingQuestions 

func (x *IdentityMetadata) GetOnboardingQuestions() *IdentityMetadata_OnboardingQuestions

func (*IdentityMetadata) GetUpdatesOptIn 

func (x *IdentityMetadata) GetUpdatesOptIn() bool

func (*IdentityMetadata) ProtoMessage 

func (*IdentityMetadata) ProtoMessage()

func (*IdentityMetadata) ProtoReflect 

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

func (*IdentityMetadata) Reset 

func (x *IdentityMetadata) Reset()

func (*IdentityMetadata) String 

func (x *IdentityMetadata) String() string

type IdentityMetadata_OnboardingQuestions 

type IdentityMetadata_OnboardingQuestions struct {
	CompanyName string   `protobuf:"bytes,1,opt,name=company_name,json=companyName,proto3" json:"company_name,omitempty"`
	Providers   []string `protobuf:"bytes,2,rep,name=providers,proto3" json:"providers,omitempty"`
	Product     string   `protobuf:"bytes,3,opt,name=product,proto3" json:"product,omitempty"`
	// contains filtered or unexported fields
}

func (*IdentityMetadata_OnboardingQuestions) Descriptor deprecated 

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

Deprecated: Use IdentityMetadata_OnboardingQuestions.ProtoReflect.Descriptor instead.

func (*IdentityMetadata_OnboardingQuestions) GetCompanyName 

func (x *IdentityMetadata_OnboardingQuestions) GetCompanyName() string

func (*IdentityMetadata_OnboardingQuestions) GetProduct 

func (x *IdentityMetadata_OnboardingQuestions) GetProduct() string

func (*IdentityMetadata_OnboardingQuestions) GetProviders 

func (x *IdentityMetadata_OnboardingQuestions) GetProviders() []string

func (*IdentityMetadata_OnboardingQuestions) ProtoMessage 

func (*IdentityMetadata_OnboardingQuestions) ProtoMessage()

func (*IdentityMetadata_OnboardingQuestions) ProtoReflect 

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

func (*IdentityMetadata_OnboardingQuestions) Reset 

func (x *IdentityMetadata_OnboardingQuestions) Reset()

func (*IdentityMetadata_OnboardingQuestions) String 

func (x *IdentityMetadata_OnboardingQuestions) String() string

type Subscription 

type Subscription struct {

	// id is identifier of this specific subscription.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// sink is the address to which events shall be delivered using the selected protocol.
	Sink string `protobuf:"bytes,2,opt,name=sink,proto3" json:"sink,omitempty"`
	// contains filtered or unexported fields
}

func (*Subscription) CloudEventsExtension 

func (x *Subscription) CloudEventsExtension(key string) (string, bool)

CloudEventsExtension implements chainguard.dev/sdk/events/Extendable.CloudEventsExtension

func (*Subscription) CloudEventsSubject 

func (x *Subscription) CloudEventsSubject() string

CloudEventsSubject implements chainguard.dev/sdk/events/Eventable.CloudEventsSubject.

func (*Subscription) Descriptor deprecated 

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

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetId 

func (x *Subscription) GetId() string

func (*Subscription) GetSink 

func (x *Subscription) GetSink() string

func (*Subscription) ProtoMessage 

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect 

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

func (*Subscription) Reset 

func (x *Subscription) Reset()

func (*Subscription) String 

func (x *Subscription) String() string

type SubscriptionFilter 

type SubscriptionFilter struct {

	// id is the exact UIDP of the record.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// uidp filers records based on their position in the group hierarchy.
	Uidp *v1.UIDPFilter `protobuf:"bytes,2,opt,name=uidp,proto3" json:"uidp,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscriptionFilter) Descriptor deprecated 

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

Deprecated: Use SubscriptionFilter.ProtoReflect.Descriptor instead.

func (*SubscriptionFilter) GetId 

func (x *SubscriptionFilter) GetId() string

func (*SubscriptionFilter) GetUidp 

func (x *SubscriptionFilter) GetUidp() *v1.UIDPFilter

func (*SubscriptionFilter) ProtoMessage 

func (*SubscriptionFilter) ProtoMessage()

func (*SubscriptionFilter) ProtoReflect 

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

func (*SubscriptionFilter) Reset 

func (x *SubscriptionFilter) Reset()

func (*SubscriptionFilter) String 

func (x *SubscriptionFilter) String() string

type SubscriptionList 

type SubscriptionList struct {
	Items []*Subscription `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscriptionList) Descriptor deprecated 

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

Deprecated: Use SubscriptionList.ProtoReflect.Descriptor instead.

func (*SubscriptionList) GetItems 

func (x *SubscriptionList) GetItems() []*Subscription

func (*SubscriptionList) ProtoMessage 

func (*SubscriptionList) ProtoMessage()

func (*SubscriptionList) ProtoReflect 

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

func (*SubscriptionList) Reset 

func (x *SubscriptionList) Reset()

func (*SubscriptionList) String 

func (x *SubscriptionList) String() string

type SubscriptionsClient 

type SubscriptionsClient interface {
	Create(ctx context.Context, in *CreateSubscriptionRequest, opts ...grpc.CallOption) (*Subscription, error)
	List(ctx context.Context, in *SubscriptionFilter, opts ...grpc.CallOption) (*SubscriptionList, error)
	Delete(ctx context.Context, in *DeleteSubscriptionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

SubscriptionsClient is the client API for Subscriptions 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 NewSubscriptionsClient 

func NewSubscriptionsClient(cc grpc.ClientConnInterface) SubscriptionsClient

type SubscriptionsServer 

type SubscriptionsServer interface {
	Create(context.Context, *CreateSubscriptionRequest) (*Subscription, error)
	List(context.Context, *SubscriptionFilter) (*SubscriptionList, error)
	Delete(context.Context, *DeleteSubscriptionRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

SubscriptionsServer is the server API for Subscriptions service. All implementations must embed UnimplementedSubscriptionsServer for forward compatibility

type UnimplementedIdentitiesServer 

type UnimplementedIdentitiesServer struct {
}

UnimplementedIdentitiesServer must be embedded to have forward compatible implementations.

func (UnimplementedIdentitiesServer) Create 

func (UnimplementedIdentitiesServer) Create(context.Context, *Identity) (*Identity, error)

func (UnimplementedIdentitiesServer) UpdateMetadata 

func (UnimplementedIdentitiesServer) UpdateMetadata(context.Context, *IdentityMetadata) (*IdentityMetadata, error)

type UnimplementedSubscriptionsServer 

type UnimplementedSubscriptionsServer struct {
}

UnimplementedSubscriptionsServer must be embedded to have forward compatible implementations.

func (UnimplementedSubscriptionsServer) Create 

func (UnimplementedSubscriptionsServer) Create(context.Context, *CreateSubscriptionRequest) (*Subscription, error)

func (UnimplementedSubscriptionsServer) Delete 

func (UnimplementedSubscriptionsServer) Delete(context.Context, *DeleteSubscriptionRequest) (*emptypb.Empty, error)

func (UnimplementedSubscriptionsServer) List 

func (UnimplementedSubscriptionsServer) List(context.Context, *SubscriptionFilter) (*SubscriptionList, error)

type UnsafeIdentitiesServer 

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

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

type UnsafeSubscriptionsServer 

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

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

Source Files

View all Source files

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.