event_feed

package
v0.0.0-...-4b711b1 Latest Latest
Warning

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

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

Documentation

Overview

Package event_feed is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_external_event_feed_event_feed_proto protoreflect.FileDescriptor

Functions

func RegisterEventFeedServiceHandler 

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

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

func RegisterEventFeedServiceHandlerClient 

func RegisterEventFeedServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client EventFeedServiceClient) error

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

func RegisterEventFeedServiceHandlerFromEndpoint 

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

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

func RegisterEventFeedServiceHandlerServer 

func RegisterEventFeedServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server EventFeedServiceServer) error

RegisterEventFeedServiceHandlerServer registers the http handlers for service EventFeedService to "mux". UnaryRPC :call EventFeedServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterEventFeedServiceServer 

func RegisterEventFeedServiceServer(s *grpc.Server, srv EventFeedServiceServer)

Types

type EventFeedServiceClient 

type EventFeedServiceClient interface {
	// List Events
	//
	// Returns a list of recorded events in Chef Automate, such as Infra Server events (cookbook creation, policyfile updates, and node creation) and Chef Automate internal events (profile installs and scan job creation).
	// Adding a filter makes a list of all events that meet the filter criteria.
	//
	// Example:
	// “`
	// eventfeed?collapse=true&filter=organization:4thcafe&page_size=100&start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventFeed(ctx context.Context, in *request.GetEventFeedRequest, opts ...grpc.CallOption) (*response.GetEventFeedResponse, error)
	// List Counts of Event Types
	//
	// Returns totals for role, cookbook, and organization events.
	//
	// Example:
	// “`
	// event_type_counts?start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventTypeCounts(ctx context.Context, in *request.GetEventTypeCountsRequest, opts ...grpc.CallOption) (*response.GetEventTypeCountsResponse, error)
	// List Counts of Individual Event Tasks
	//
	// Returns the total counts of actions taken in an event. The counted actions are: update, create, and delete.
	//
	// Example:
	// “`
	// event_task_counts?start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventTaskCounts(ctx context.Context, in *request.GetEventTaskCountsRequest, opts ...grpc.CallOption) (*response.GetEventTaskCountsResponse, error)
	// List Summary Data of Events
	//
	// Returns data that populates the guitar strings visual on the top of the event feed.
	//
	// Example:
	// “`
	// eventstrings?timezone=America/Denver&hours_between=1&start=2020-06-19&end=2020-06-25
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventStringBuckets(ctx context.Context, in *request.GetEventStringBucketsRequest, opts ...grpc.CallOption) (*response.GetEventStringBucketsResponse, error)
	EventExport(ctx context.Context, in *request.EventExportRequest, opts ...grpc.CallOption) (EventFeedService_EventExportClient, error)
}

EventFeedServiceClient is the client API for EventFeedService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewEventFeedServiceClient 

func NewEventFeedServiceClient(cc grpc.ClientConnInterface) EventFeedServiceClient

type EventFeedServiceServer 

type EventFeedServiceServer interface {
	// List Events
	//
	// Returns a list of recorded events in Chef Automate, such as Infra Server events (cookbook creation, policyfile updates, and node creation) and Chef Automate internal events (profile installs and scan job creation).
	// Adding a filter makes a list of all events that meet the filter criteria.
	//
	// Example:
	// “`
	// eventfeed?collapse=true&filter=organization:4thcafe&page_size=100&start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventFeed(context.Context, *request.GetEventFeedRequest) (*response.GetEventFeedResponse, error)
	// List Counts of Event Types
	//
	// Returns totals for role, cookbook, and organization events.
	//
	// Example:
	// “`
	// event_type_counts?start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventTypeCounts(context.Context, *request.GetEventTypeCountsRequest) (*response.GetEventTypeCountsResponse, error)
	// List Counts of Individual Event Tasks
	//
	// Returns the total counts of actions taken in an event. The counted actions are: update, create, and delete.
	//
	// Example:
	// “`
	// event_task_counts?start=1592546400000&end=1593151199999
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventTaskCounts(context.Context, *request.GetEventTaskCountsRequest) (*response.GetEventTaskCountsResponse, error)
	// List Summary Data of Events
	//
	// Returns data that populates the guitar strings visual on the top of the event feed.
	//
	// Example:
	// “`
	// eventstrings?timezone=America/Denver&hours_between=1&start=2020-06-19&end=2020-06-25
	// “`
	//
	// Authorization Action:
	// “`
	// “`
	//
	//event:events:list
	GetEventStringBuckets(context.Context, *request.GetEventStringBucketsRequest) (*response.GetEventStringBucketsResponse, error)
	EventExport(*request.EventExportRequest, EventFeedService_EventExportServer) error
}

EventFeedServiceServer is the server API for EventFeedService service.

type EventFeedService_EventExportClient 

type EventFeedService_EventExportClient interface {
	Recv() (*response.EventExportResponse, error)
	grpc.ClientStream
}

type EventFeedService_EventExportServer 

type EventFeedService_EventExportServer interface {
	Send(*response.EventExportResponse) error
	grpc.ServerStream
}

type UnimplementedEventFeedServiceServer 

type UnimplementedEventFeedServiceServer struct {
}

UnimplementedEventFeedServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedEventFeedServiceServer) EventExport 

func (*UnimplementedEventFeedServiceServer) EventExport(*request.EventExportRequest, EventFeedService_EventExportServer) error

func (*UnimplementedEventFeedServiceServer) GetEventFeed 

func (*UnimplementedEventFeedServiceServer) GetEventFeed(context.Context, *request.GetEventFeedRequest) (*response.GetEventFeedResponse, error)

func (*UnimplementedEventFeedServiceServer) GetEventStringBuckets 

func (*UnimplementedEventFeedServiceServer) GetEventStringBuckets(context.Context, *request.GetEventStringBucketsRequest) (*response.GetEventStringBucketsResponse, error)

func (*UnimplementedEventFeedServiceServer) GetEventTaskCounts 

func (*UnimplementedEventFeedServiceServer) GetEventTaskCounts(context.Context, *request.GetEventTaskCountsRequest) (*response.GetEventTaskCountsResponse, error)

func (*UnimplementedEventFeedServiceServer) GetEventTypeCounts 

func (*UnimplementedEventFeedServiceServer) GetEventTypeCounts(context.Context, *request.GetEventTypeCountsRequest) (*response.GetEventTypeCountsResponse, error)

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.