Documentation
¶
Index ¶
- Variables
- func FileDescriptorSet() *descriptorpb.FileDescriptorSet
- func RegisterAlertsServer(s prpc.Registrar, srv AlertsServer)
- type Alert
- type AlertsClient
- type AlertsServer
- type DecoratedAlerts
- type ListAlertsRequest
- func (*ListAlertsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListAlertsRequest) GetPageSize() int32
- func (x *ListAlertsRequest) GetPageToken() string
- func (x *ListAlertsRequest) GetParent() string
- func (*ListAlertsRequest) ProtoMessage()
- func (x *ListAlertsRequest) ProtoReflect() protoreflect.Message
- func (x *ListAlertsRequest) Reset()
- func (x *ListAlertsRequest) String() string
- type ListAlertsResponse
- func (*ListAlertsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListAlertsResponse) GetAlerts() []*Alert
- func (x *ListAlertsResponse) GetNextPageToken() string
- func (*ListAlertsResponse) ProtoMessage()
- func (x *ListAlertsResponse) ProtoReflect() protoreflect.Message
- func (x *ListAlertsResponse) Reset()
- func (x *ListAlertsResponse) String() string
- type UnimplementedAlertsServer
Constants ¶
This section is empty.
Variables ¶
var File_go_chromium_org_infra_appengine_sheriff_o_matic_proto_v1_alerts_proto protoreflect.FileDescriptor
Functions ¶
func FileDescriptorSet ¶
func FileDescriptorSet() *descriptorpb.FileDescriptorSet
FileDescriptorSet returns a descriptor set for this proto package, which includes all defined services, and all transitive dependencies.
Will not return nil.
Do NOT modify the returned descriptor.
func RegisterAlertsServer ¶
func RegisterAlertsServer(s prpc.Registrar, srv AlertsServer)
Types ¶
type Alert ¶
type Alert struct { // The opaque, unique key of this alert. This is also present in the alert_json field. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // A string containing the JSON for the alert that would be returned by the REST API. // // This is left as JSON rather than proto fields because we intend to reduce usage of // this over time, so it is better to preserve backwards compatibility of the existing // UI codethan to break out invdividual fields which would require rewriting the code // which will soon be replaced anyway. AlertJson string `protobuf:"bytes,2,opt,name=alert_json,json=alertJson,proto3" json:"alert_json,omitempty"` // contains filtered or unexported fields }
An alert corresponding to a failure of a step in a build.
func (*Alert) Descriptor
deprecated
func (*Alert) GetAlertJson ¶
func (*Alert) ProtoMessage ¶
func (*Alert) ProtoMessage()
func (*Alert) ProtoReflect ¶
func (x *Alert) ProtoReflect() protoreflect.Message
type AlertsClient ¶
type AlertsClient interface { // Get the list of unresolved alerts for a given tree. ListAlerts(ctx context.Context, in *ListAlertsRequest, opts ...grpc.CallOption) (*ListAlertsResponse, error) }
AlertsClient is the client API for Alerts service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewAlertsClient ¶
func NewAlertsClient(cc grpc.ClientConnInterface) AlertsClient
func NewAlertsPRPCClient ¶
func NewAlertsPRPCClient(client *prpc.Client) AlertsClient
type AlertsServer ¶
type AlertsServer interface { // Get the list of unresolved alerts for a given tree. ListAlerts(context.Context, *ListAlertsRequest) (*ListAlertsResponse, error) }
AlertsServer is the server API for Alerts service.
type DecoratedAlerts ¶
type DecoratedAlerts struct { // Service is the service to decorate. Service AlertsServer // Prelude is called for each method before forwarding the call to Service. // If Prelude returns an error, then the call is skipped and the error is // processed via the Postlude (if one is defined), or it is returned directly. Prelude func(ctx context.Context, methodName string, req proto.Message) (context.Context, error) // Postlude is called for each method after Service has processed the call, or // after the Prelude has returned an error. This takes the Service's // response proto (which may be nil) and/or any error. The decorated // service will return the response (possibly mutated) and error that Postlude // returns. Postlude func(ctx context.Context, methodName string, rsp proto.Message, err error) error }
func (*DecoratedAlerts) ListAlerts ¶
func (s *DecoratedAlerts) ListAlerts(ctx context.Context, req *ListAlertsRequest) (rsp *ListAlertsResponse, err error)
type ListAlertsRequest ¶
type ListAlertsRequest struct { // The name of the tree to retrieve alerts for // Format: trees/{tree} Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"` // The maximum number of alerts to return. The service may return fewer than // this value. // If unspecified, at most 1000 alerts will be returned. // The maximum value is 1000; values above 1000 will be coerced to 1000. PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` // A page token, received from a previous `ListAlerts` call. // Provide this to retrieve the subsequent page. // // When paginating, all other parameters provided to `ListAlerts` must match // the call that provided the page token. PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"` // contains filtered or unexported fields }
func (*ListAlertsRequest) Descriptor
deprecated
func (*ListAlertsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAlertsRequest.ProtoReflect.Descriptor instead.
func (*ListAlertsRequest) GetPageSize ¶
func (x *ListAlertsRequest) GetPageSize() int32
func (*ListAlertsRequest) GetPageToken ¶
func (x *ListAlertsRequest) GetPageToken() string
func (*ListAlertsRequest) GetParent ¶
func (x *ListAlertsRequest) GetParent() string
func (*ListAlertsRequest) ProtoMessage ¶
func (*ListAlertsRequest) ProtoMessage()
func (*ListAlertsRequest) ProtoReflect ¶
func (x *ListAlertsRequest) ProtoReflect() protoreflect.Message
func (*ListAlertsRequest) Reset ¶
func (x *ListAlertsRequest) Reset()
func (*ListAlertsRequest) String ¶
func (x *ListAlertsRequest) String() string
type ListAlertsResponse ¶
type ListAlertsResponse struct { // The requested alerts. Alerts []*Alert `protobuf:"bytes,1,rep,name=alerts,proto3" json:"alerts,omitempty"` // A token, which can be sent as `page_token` to retrieve the next page. // If this field is omitted, there are no subsequent pages. NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"` // contains filtered or unexported fields }
func (*ListAlertsResponse) Descriptor
deprecated
func (*ListAlertsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAlertsResponse.ProtoReflect.Descriptor instead.
func (*ListAlertsResponse) GetAlerts ¶
func (x *ListAlertsResponse) GetAlerts() []*Alert
func (*ListAlertsResponse) GetNextPageToken ¶
func (x *ListAlertsResponse) GetNextPageToken() string
func (*ListAlertsResponse) ProtoMessage ¶
func (*ListAlertsResponse) ProtoMessage()
func (*ListAlertsResponse) ProtoReflect ¶
func (x *ListAlertsResponse) ProtoReflect() protoreflect.Message
func (*ListAlertsResponse) Reset ¶
func (x *ListAlertsResponse) Reset()
func (*ListAlertsResponse) String ¶
func (x *ListAlertsResponse) String() string
type UnimplementedAlertsServer ¶
type UnimplementedAlertsServer struct { }
UnimplementedAlertsServer can be embedded to have forward compatible implementations.
func (*UnimplementedAlertsServer) ListAlerts ¶
func (*UnimplementedAlertsServer) ListAlerts(context.Context, *ListAlertsRequest) (*ListAlertsResponse, error)